Spring - [의존관계 자동 주입] #7

김영한 - 스프링 핵심 원리 기본편을 듣고 정리한 내용입니다.

 

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8/dashboard

스프링 핵심 원리 - 기본편 - 인프런 | 강의

📝목차

7.의존관계 자동주입

• 다양한 의존관계 주입 방법
• 옵션 처리
• 생성자 주입을 선택하라!
• 롬복과 최신 트랜드
• 조회 빈이 2개이상 - 문제
• @Autowired 필드 명, @Qualifier, @Primary
• 애노테이션 직접 만들기
• 조회한 빈이 모두 필요할 때, List, Map
• 자동, 수동의 올바른 실무 운영 기준

---

📌다양한 의존관계 주입 방법

• 생성자 주입
• 수정자 주입
• 필드 주입
• 일반 메서드 주입

💡생성자 주입

• 생성자를 통해서 의존관계를 주입 받는 방법이다.
• 생성자 호출시점에 딱1번만 호출되는 것이 보장되고, 불변, 필수 의존관게에 사용한다.

@Component
public class OrderServiceImpl implements OrderService {

 	private final MemberRepository memberRepository;
 	private final DiscountPolicy discountPolicy;
 	
    @Autowired // 생략가능
 	public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy 
discountPolicy) {
 		this.memberRepository = memberRepository;
 		this.discountPolicy = discountPolicy;
 	}
}

• 생성자가 1개만 있으면 @Autowired를 생략해도 자동 주입된다. (스프링 빈에만 해당)

💡수정자 주입(setter 주입)

• setter라 불리는 필드의 값을 변경하는 수정자 메서드를 통해서 의존관계를 주입하는 방법
• 선택, 변경 가능성이 있는 의존관계에 사용
• 자바빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법

@Component
public class OrderServiceImpl implements OrderService {

 	private MemberRepository memberRepository;
 	private DiscountPolicy discountPolicy;
 	
    @Autowired
 	public void setMemberRepository(MemberRepository memberRepository) {
 		this.memberRepository = memberRepository;
 	}
 	
    @Autowired
 	public void setDiscountPolicy(DiscountPolicy discountPolicy) {
 		this.discountPolicy = discountPolicy;
 	}
    
}

참고: @Autowired의 기본동작은 주입할 대상이 없으면 오류발생
주입할 대상이 없어도 동작하게 하려면 @Autowired(required = false)로 지정

자바빈 프로퍼티, 자바에서는 과거부터 필드의 값을 직접 변경하지 않고, get~ set~ 메서드를
통해 값을 읽거나 수정하는 규칙이 있는데, 그것이 프로퍼티 규약이다. 

💡자바빈 프로퍼티 규약 예시

class Data {
 private int age;
 public void setAge(int age) {
   this.age = age;
 }
 
 public int getAge() {
   return age;
 }
}

💡필드 주입

• 필드에 바로 주입하는 방법
• 외부에서 변경이 불가능해 테스트하기 힘들다는 단점이 있다.
• DI 프레임워크가 없으면 아무것도 할 수 없음
• 사용하지 않는게 좋음
  • 애플리케이션의 실제 코드와 관계 없는 테스트 코드
  • 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용

@Component
public class OrderServiceImpl implements OrderService {

 	@Autowired
 	private MemberRepository memberRepository;
 	@Autowired
 	private DiscountPolicy discountPolicy;
}

참고: 자바 테스트 코드에는 @Autowired가 동작하지 않는다. @SpringBootTest 처럼 스프링 컨테이너를 테스트에 통합한 경우에만 가능하다.

참고: 다음 코드와 같이 @Bean에서 피라미터에 의존관계는 자동 주입된다. 수동 등록시 자동 등록된 빈의 의존관계가 필요할 때 문제를 해결할 수 있다.

@Bean
OrderService orderService(MemberRepository memberRepoisitory, DiscountPolicy 
discountPolicy) {
 	new OrderServiceImpl(memberRepository, discountPolicy)
}

💡일반 메서드 주입

• 일반 메서드를 통해서 주입 받을 수 있다.
• 한번에 여러 필드를 주입 받을 수 있다.
• 일반적으로 잘 사용하지 않는다.

@Component
public class OrderServiceImpl implements OrderService {

 	private MemberRepository memberRepository;
 	private DiscountPolicy discountPolicy;
 	
    @Autowired
 	public void init(MemberRepository memberRepository, DiscountPolicy 
discountPolicy) {
 	this.memberRepository = memberRepository;
 	this.discountPolicy = discountPolicy;
 	}
}

참고: 의존관계 자동 주입은 스프링 컨테이너가 관리하는 스프링 빈이어야 동작한다. 스프링 빈이 아닌 Member 같은 클래스에서 @Autowired 코드를 적용해도 아무 기능도 동작하지 않는다.

📌옵션 처리

💡자동 주입 대상을 옵션으로 처리하는 방법

• @Autowired(required=false): 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출 안됨 
• org.springframwork.lang.@Nullable: 자동 주입할 대상이 없으면 null이 입력된다.
• Optional<>: 자동 주입할 대상이 없으면 Optional.empty가 입력된다.

//호출 안됨
@Autowired(required = false)
public void setNoBean1(Member member) {
 	System.out.println("setNoBean1 = " + member);
}

//null 호출
@Autowired
public void setNoBean2(@Nullable Member member) {
 	System.out.println("setNoBean2 = " + member);
}

//Optional.empty 호출
@Autowired(required = false)
public void setNoBean3(Optional<Member> member) {
 	System.out.println("setNoBean3 = " + member);
}

• Member는 스피링 빈이 아니다.
• setNoBean1()은 @Autowired(required=false)이므로 호출 자체가 안된다.

출력결과

setNoBean2 = null
setNoBean3 = Optional.empty

참고: @Nullable, Optional은 스프링 전반에 지원되고, 생성자 자동 주입에서 특정 필드에만 사용해도 된다.

📌생성자 주입을 선택하라!

💡불변

• 수정자 주입을 사용하면, setXxx 메서드를 public으로 열어두어야 한다.
• 생성자 주입은 객체를 생성할때 1번만 호출되므로 이후 호출되는 일이 없다.따라서 불변하게 설계 가능하다.

💡누락 

• 프레임워크 없이 순수한 자바 코드를 단위 테스트 하는 경우에 다음과 같이 수정자 의존관계인 경우

public class OrderServiceImpl implements OrderService {

 	private MemberRepository memberRepository;
 	private DiscountPolicy discountPolicy;
 	
    @Autowired
 	public void setMemberRepository(MemberRepository memberRepository) {
 		this.memberRepository = memberRepository;
 	}
 	
    @Autowired
 	public void setDiscountPolicy(DiscountPolicy discountPolicy) {
 	this.discountPolicy = discountPolicy;
 	}
 	//...
}

• @Autowired가 프레임워크 안에서 동작할 때는 의존관계가 없으면 오류가 발생한다. 지금은 프레임 워크 없이 순수한 자바코드로만 단위 테스트를 수행하고 있다.

@Test
void createOrder() {
 	OrderServiceImpl orderService = new OrderServiceImpl();
 	orderService.createOrder(1L, "itemA", 10000);
}

• 실행결과: NPE(Null Point Exception)이 발생하는데, memberRepository, discountPolicy 모두 의존관계 주입이 누락되었기 때문이다.

 

• 생성자 주입을 사용하면 주입 데이터를 누락 했을 때 컴파일 오류가 발생한다.

@Test
void createOrder() {
  OrderServiceImpl orderService = new OrderServiceImpl();
  orderService.createOrder(1L, "itemA", 10000);
}

💡final 키워드

• 생성자에서 값이 설정되지 않는 오류를 컴파일 시점에서 막아준다.

@Component
public class OrderServiceImpl implements OrderService {
 	
    private final MemberRepository memberRepository;
 	private final DiscountPolicy discountPolicy;
 	
    @Autowired
 	public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy 
discountPolicy) {
 		this.memberRepository = memberRepository;
 	}
 	//...
}

• 필수 필드인 discountPolicy에 값을 설정해야 하는데, 누락이 되었다. 자바는 컴파일 시점에 다음 오류를 발생시킨다.
• java: variable discountPolicy might not have been initialized

참고: 수정자 주입을 포함한 나머지 주입 방식은 모두 생성자 이후에 호출되어서 필드에 final 키워드를 사용할 수 없다.오직 생성자 주이 방식만 final 키워드를 사용할 수 있다.

💡정리

• 생성자 주입방식은 프레임 워크에 의존하지 않고, 순수한 자바 언어의 특징을 살리는 방법이다.
• 기본으로 생성자 주입을 사용하고 ,필수 값이 아닌 경우에 수정자 주입 방식을 옵션으로 부여하면 된다. 생성자 주입과 수정자 주입을 동시에 사용할 수 있다.
• 항상 생성자 주입을 선택하고, 가끔 옵션이 필요하면 수정자 주입을 선택해라. 필드주입은 사용하지 않는게 좋다.

📌롬복과 최신 트랜드

💡기본 코드

@Component
public class OrderServiceImpl implements OrderService {
 	
    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;
 	
    @Autowired
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy 
discountPolicy) {
 	
    	this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }
}

• 생성자가 1개 더 있으면 @Autowired를 생략할 수 있다.

@Component
public class OrderServiceImpl implements OrderService {

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;
 	
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy 
discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }
}

• 롬복 라이브러리가 제공하는 @RequiredArgsConstructor 기능을 사용하면 final이 붙은 필드를 모아서 생성자를 자동으로 만들어준다.

💡최종결과 코드

@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService {
    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;
}

• 위의 코드와 동일하고, 롬복이 자바의 애노테이션 프로세서라는 기능을 이용해 컴파일 시점에 생성자 코드를 자동으로 생성해준다.

💡정리

• 최근 생성자를 1개 두고, @Autowired를 생략하는 방법을 주로 사용한다. 여기에 Lombok 라이브러리의 @RequiredArgsConstructor 함께 사용하면 기능은 다 제공하면서, 코드를 깔끔하게 사용가능하다.

💡롬복 라이브러리 적용 방법

1. build.gradle 에 라이브러리 및 환경 추가
2. Preferences(윈도우 File Settings) plugin lombok 검색 설치 실행 (재시작)
3. Preferences Annotation Processors 검색 Enable annotation processing 체크 (재시작)
4. 임의의 테스트 클래스를 만들고 @Getter, @Setter 확인

📌조회 빈이 2개이상 - 문제

💡@Autowired: 타입(Type)로 조회한다.

@Autowired
private DiscountPolicy discountPolicy

• 타입으로 조회하기 때문에, ac.getBean(DiscountPolicy.class)와 유사하게 동작함

 

• 스프링 빈 조회에서 학습했듯이 타입으로 조회하면 선택된 빈이 2개 이상일 때 문제가 발생한다.                                  DiscountPolicy의 하위 타입인 FixDiscountPolicy, RateDiscountPolicy 둘다 스프링 빈으로 선언해보자.

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

의존관계 자동 주입을 실행하면

@Autowired
private DiscountPolicy discountPolicy

NoUniqueBeanDefinitionException오류 발생

NoUniqueBeanDefinitionException: No qualifying bean of type 
'hello.core.discount.DiscountPolicy' available: expected single matching bean 
but found 2: fixDiscountPolicy,rateDiscountPolicy

fixDiscountPolicy, rateDiscountPolicy 2개의 오류 발생

📌@Autowired 필드 명, @Qualifier, @Primary

💡조회 대상 빈이 2개 이상일 때 해결 방법

• @Autowired 필드 명 매칭
• @Qualifier -> @Qualifier끼리 매칭 -> 빈 이름 매칭
• @Primary 사용

💡@Autowired 필드 명 매칭

• @Autowired는 타입 매칭을 시도하고, 여러 빈이 있으면 필드 이름, 파라미터 이름으로 빈 이름을 추가 매칭한다.

기존 코드

@Autowired
private DiscountPolicy discountPolicy

필드 명을 빈 이름으로 변경

@Autowired
private DiscountPolicy rateDiscountPolicy

필드명이 rateDiscountPolicy이므로 정상 주입된다.

필드 명 매칭은 먼저 타입 매칭을 시도 하고 그 결과에 여러 빈이 있을 때 추가로 동작하는 기능이다.

 

💡@Autowired 매칭 정리

• 1. 타입 매칭
• 2. 타입 매칭의 결과가 2개 이상일 때 필드 명, 파라미터 명으로 빈 이름 매칭

 

💡@Qualifier 사용

• @Qualifier는 추가 구분자를 붙여주는 방법, 주입시 추가적인 방법을 제공하는 것. 빈 이름을 변경하는 것은 아님 

빈 등록시 @Qualifier를 붙여 준다.

@Component
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
@Qualifier("fixDiscountPolicy")
public class FixDiscountPolicy implements DiscountPolicy {}

주입시 @Qualifier를 붙여주고 등록한 이름을 적어준다.

 

생성자 자동 주입 예시

@Autowired
public OrderServiceImpl(MemberRepository memberRepository,
 						@Qualifier("mainDiscountPolicy") DiscountPolicy 
discountPolicy) {
 	this.memberRepository = memberRepository;
 	this.discountPolicy = discountPolicy;
}

수정자 자동 주입 예시

@Autowired
public DiscountPolicy setDiscountPolicy(@Qualifier("mainDiscountPolicy")
DiscountPolicy discountPolicy) {
 	this.discountPolicy = discountPolicy;
}

@Qualifier로 주입할 때 @Qualifier("mainDiscountPolicy)를 못찾으면 mainDiscountPolicy라는 이름의 스프링 빈을 추가로 갖는다.

 

💡Qualifier 정리

• 1. @Qualifier끼리매칭
• 2. 빈 이름 매칭
• 3. NoSuchBeanDefinitionException 예외 발생

 

💡Primary 사용

• Primary는 우선순위 정하는 방법

 

rateDiscountPolicy 우선권을 갖는다

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

사용코드

//생성자
@Autowired
public OrderServiceImpl(MemberRepository memberRepository,
 						DiscountPolicy discountPolicy) {
 	this.memberRepository = memberRepository;
 	this.discountPolicy = discountPolicy;
}

//수정자
@Autowired
public DiscountPolicy setDiscountPolicy(DiscountPolicy discountPolicy) {
 	this.discountPolicy = discountPolicy;
}

 

💡@Primary, @Qualifier 활용

• @Primary: 기본값 처럼 동작
• @Qualifier: 매우 상세하게 동작 (우선권이 높다)

📌애노테이션 직접 만들기

package hello.core.annotataion;
import org.springframework.beans.factory.annotation.Qualifier;
import java.lang.annotation.*;

@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER,
ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Qualifier("mainDiscountPolicy")
public @interface MainDiscountPolicy {
}


@Component
@MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy {}


//생성자 자동 주입
@Autowired
public OrderServiceImpl(MemberRepository memberRepository,
 @MainDiscountPolicy DiscountPolicy discountPolicy) {
 this.memberRepository = memberRepository;
 this.discountPolicy = discountPolicy;
}
//수정자 자동 주입
@Autowired
public DiscountPolicy setDiscountPolicy(@MainDiscountPolicy DiscountPolicy 
discountPolicy) {
 	this.discountPolicy = discountPolicy;
}

• 애노테이션에는 상속이라는 개념이 없다. 애노테이션으 모아서 사용하는 기능이 스프리이 지원해주는 기능이다.

📌조회한 빈이 모두 필요할 때, List, Map

package hello.core.autowired;
import hello.core.AutoAppConfig;
import hello.core.discount.DiscountPolicy;
import hello.core.member.Grade;
import hello.core.member.Member;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import
org.springframework.context.annotation.AnnotationConfigApplicationContext;
import java.util.List;
import java.util.Map;
import static org.assertj.core.api.Assertions.assertThat;
public class AllBeanTest {
 	
    @Test
 	void findAllBean() {
 		ApplicationContext ac = new
AnnotationConfigApplicationContext(AutoAppConfig.class, DiscountService.class);
 		DiscountService discountService = ac.getBean(DiscountService.class);
 		Member member = new Member(1L, "userA", Grade.VIP);
 		int discountPrice = discountService.discount(member, 10000,
"fixDiscountPolicy");
 		
        assertThat(discountService).isInstanceOf(DiscountService.class);
 		assertThat(discountPrice).isEqualTo(1000);
 	}
 	
    static class DiscountService {
 		
        private final Map<String, DiscountPolicy> policyMap;
 		private final List<DiscountPolicy> policies;
 		
        public DiscountService(Map<String, DiscountPolicy> policyMap,
List<DiscountPolicy> policies) {
 			this.policyMap = policyMap;
 			this.policies = policies;
 			System.out.println("policyMap = " + policyMap);
 			System.out.println("policies = " + policies);
 		}
 		
        public int discount(Member member, int price, String discountCode) {
 			DiscountPolicy discountPolicy = policyMap.get(discountCode);
 			
            System.out.println("discountCode = " + discountCode);
 			System.out.println("discountPolicy = " + discountPolicy);
 			
            return discountPolicy.discount(member, price);
 		}
 	}
}

 

로직 분석

• DiscountService는 Map으로 모든 DiscountPolicy를 주입받는다. 이때 fixDisocuntPolicy, rateDiscountPolicy가 주입된다.
• discount()메서드는 discountCode로 "fixDiscountPolicy"가 넘어오면 map에서 fixDiscountPolicy 스프링 빈을 찾아서 실행한다. "rateDiscountPolicy"가 넘어오면 rateDisocuntPolicy 스프링 빈을 찾아서 실행한다. 

주입 분석

• Map<String, DiscountPolicy>: DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다.
• 해당하는 타입의 스프링 빈이 없으면, 빈 컬렉션이나 Map을 주입한다.

참고 - 스프링 컨테이너를 생성하면서 스프링 빈 등록하기

스프링 컨테이너는 생성자에 클래스 정보를 받는다. 여기에 클래스 정보를 넘기면 해당 클래스가 스프링 빈으로 자동 등록된다.

new AnnotationConfigApplicationContext(AutoAppConfig.class,DiscountService.class);

• new AnnotationConfigApplicationContext()를 통해 스프링 컨테이너를 생성한다.
• AutoAppConfig.class, DiscountService.class를 피라미터로 넘기면서 해당 클래스를 자동으로 스프링 빈으로 등록한다.
• 정리 - 스프링 컨테이너를 생성하면서, 해당 컨테이너에 동시에 AutoAppConfig, DiscountService를 스프링 빈으로 자등 등록한다.

📌자동, 수동의 올바른 실무 운영 기준

• 업무 로직 빈: 웹을 지원하는 컨트롤러, 핵심 비지니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리 등이 업무 로직이다. 
• 기술 지원 빈: 기술적인 문제나 공통 관심사(AOP)를 처리할때 사용된다. 데이터베이스 연결이나, 공통 로그 처리 처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들이다.

---