[스프링 핵심 원리] 5. 의존 관계 자동 주입

다양한 의존 관계 주입 방법

---

생성자 주입

이름 그대로 생성자를 통해서 의존 관계를 주입 받는 방법이다

• 생성자 호출 시점에 딱 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의 기본 동작은 주입할 대상이 없으면 오류가 발생한다. 

 

 

필드 주입

이름 그대로 필드에 바로 주입하는 방법이다

• 외부에서 변경이 불가능해서 테스트하기 힘들다는 치명적인 단점이 존재한다
• DI 프레임워크가 없으면 아무것도 할 수 없다

@Component
public class OrderServiceImpl implements OrderService {

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

- 순수한 자바 테스트 코드에는 당연히 @Autowired가 동작하지 않는다. @SpringBootTest처럼 스프링 컨테이너를 테스트에 통합한 경우에만 가능하다.

 

 

일반 메서드 주입

일반 메서드를 통해서 주입 받을 수 있다

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

@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 옵션의 기본값이 true로 되어 있어서 자동 주입 대상이 없으면 오류가 발생한다.

 

자동 주입 대상을 옵션으로 처리하는 방법은 다음과 같다

• @Autowired(required = false) : 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출 안됨
• org.spring.framework.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);
}

 

 

생성자 주입을 선택하라!

과거에는 수정자 주입과 필드 주입을 많이 사용했지만, 최근에는 스프링을 포함한 DI 프레임워크 대부분이 생성자 주입을 권장한다.

 

1. 불변

• 대부분의 의존관계 주입은 한 번 일어나면 애플리케이션 종료시점까지 의존관계를 변경할 일이 없다. 
• 수정자 주입을 사용하면, setXXX메서드를 public으로 열어두어야 한다
• 누군가 실수로 변경할 수도 있고, 변경하면 안되는 메서드를 열어두는 것은 좋은 설계 방법이 아니다
• 생성자 주입은 객체를 생성할 때 딱 1번만 호출되므로 이후에 호출되는 일이 없다.

 

2. 누락

• 생성자 주입을 사용하면 주입 데이터를 누락했을 때 컴파일 오류가 발생한다. 그리고 IDE에서 바로 어떤 값을 필수로 주입해야 하는지 알 수 있다.

 

3. 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;
	}
    
 }

 

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

@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService {

	private final MemberRepository memberRepository;
	private final DiscountPolicy discountPolicy;
    
 }

 

 

조회 빈이 2개 이상 

---

문제

@Autowired는 타입으로 조회한다.

타입으로 조회하기 때문에, ac.getBean(DiscountPolicy.class)와 같은 코드로 유사하게 동작한다.

@Autowired
private DiscountPolicy discountPolicy

 

타입으로 조회할 때 선택된 빈이 2개 이상 존재하면 문제가 발생한다. 

DiscountPolicy의 하위 타입인 FixDiscountPolicy와 RateDiscountPolicy 둘 다 스프링 빈으로 선언하면 NoUniqueBeanDefinitionException 오류가 발생한다. 

 

이 때, 하위 타입으로 지정할 수도 있지만, 하위 타입으로 지정하는 것은 DIP를 위배하고 유연성이 떨어진다. 그리고 이름만 다르고, 완전히 똑같은 타입의 스프링 빈이 2개 있을 때는 해결이 안된다.

 

 

@Autowired 필드명

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

// 기존 코드
@Autowired
private DiscountPolicy discountPolicy


// 필드 명을 빈 이름으로 변경
@Autowired
private DiscountPolicy rateDiscountPolicy

DiscountPolicy로 타입 매칭을 시도하고, 그 결과 빈이 여러 개가 존재한다면 rateDiscountPolicy로 추가 매칭을 한다.

 

정리

1. 타입 매칭

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

 

@Qualifier

@Qualifier는 추가 구분자를 붙여주는 방법이다.

주입 시 추가적인 방법을 제공하는 것이지 빈 이름을 변경하는 것이 아니다.

 @Component
 @Qualifier("mainDiscountPolicy")
 public class RateDiscountPolicy implements DiscountPolicy {}
 
 @Component
 @Qualifier("fixDiscountPolicy")
 public class FixDiscountPolicy implements DiscountPolicy {}
 
 @Autowired
 public OrderServiceImpl(MemberRepository memberRepository,
                        @Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
 	this.memberRepository = memberRepository;
 	this.discountPolicy = discountPolicy;
}

 

정리

1. @Qualifier 끼리 매칭

2. 빈 이름 매칭

3. NoSuchBeanDefinitionException 예외 발생

 

@Primary

@Primary는 우선 순위를 정하는 방법이다. 

@Autowired 시에 여러 빈이 매칭되면 @Primary가 우선권을 가진다.

 @Component
 @Primary
 public class RateDiscountPolicy implements DiscountPolicy {}
 
 @Component
 public class FixDiscountPolicy implements DiscountPolicy {}