Spring/의존관계 주입/DI/@Autowired

다양한 의존관계 주입 방법

생성자 주입

수정자 주입(setter 주입)

필드 주입

일반 메서드 주입

 

생성자 주입

이름 그대로 생성자를 통해서 의존 관계를 주입 받는 방법이다. 지금까지 우리가 진행했던 방법이 바로 생성자 주입이다. 생성자가 딱 1개만 있으면 @Autowired를 생략해도 자동 주입 된다. 물론 스프링 빈에만 해당한다. 생성자 호출시점에 딱 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;
	}
}

 

수정자 주입(setter 주입)

setter라 불리는 필드의 값을 변경하는 수정자 메서드를 통해서 의존관계를 주입하는 방법이다. 선택, 변경 가능성이 있는 의존관계에 사용

자바빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법이다.

 

*@Autowired 의 기본 동작은 주입할 대상이 없으면 오류가 발생한다. 주입할 대상이 없어도 동작하게

하려면 @Autowired(required = false) 로 지정하면 된다.

 

 

@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;
	}
}

필드 주입

이름 그대로 필드에 바로 주입하는 방법이다. 코드가 간결해서 많은 개발자들을 유혹하지만 외부에서 변경이 불가능해서 테스트 하기 힘들다는 치명적인 단점이 있다. DI 프레임워크가 없으면 아무것도 할 수 없다. 사용하지 말자! 애플리케이션의 실제 코드와 관계 없는 테스트 코드 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용

 

*순수한 자바 테스트 코드에는 당연히 @Autowired가 동작하지 않는다. @SpringBootTest 처럼

스프링 컨테이너를 테스트에 통합한 경우에만 가능하다.

 

*다음 코드와 같이 @Bean 에서 파라미터에 의존관계는 자동 주입된다. 수동 등록시 자동 등록된 빈의

의존관계가 필요할 때 문제를 해결할 수 있다.

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

 

 

일반 메서드 주입

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

 

옵션 처리

주입할 스프링 빈이 없어도 동작해야 할 때가 있다. 그런데 @Autowired 만 사용하면 required 옵션의 기본값이 true 로 되어 있어서 자동 주입 대상이 없으면 오류가 발생한다. 자동 주입 대상을 옵션으로 처리하는 방법은 다음과 같다.

 

@Autowired(required=false) : 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출 안됨

org.springframework.lang.@Nullable : 자동 주입할 대상이 없으면 null이 입력된다.

Optional<> : 자동 주입할 대상이 없으면 Optional.empty 가 입력된다.

 

생성자 주입을 사용해라

대부분의 의존관계 주입은 한번 일어나면 애플리케이션 종료시점까지 의존관계를 변경할 일이 없다. 오히려 대부분의 의존관계는 애플리케이션 종료 전까지 변하면 안된다.(불변해야 한다.) 수정자 주입을 사용하면, setXxx 메서드를 public으로 열어두어야 한다. 누군가 실수로 변경할 수 도 있고, 변경하면 안되는 메서드를 열어두는 것은 좋은 설계 방법이 아니다. 생성자 주입은 객체를 생성할 때 딱 1번만 호출되므로 이후에 호출되는 일이 없다. 따라서 불변하게 설계할 수 있다. 수정자 주입을 포함한 나머지 주입 방식은 모두 생성자 이후에 호출되므로, 필드에 final 키워드를 사용할 수 없다. 오직 생성자 주입 방식만 final 키워드를 사용할 수 있다. 값을 입력하지 않았을 때 컴파일 에러를 발생시킬 수 있는데 컴파일 오류는 세상에서 가장 빠르고, 좋은 오류다!

 

정리

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

 

 

조회 빈이 2개 이상인 경우

@Component
public class FixDiscountPolicy implements DiscountPolicy {
...
}

@Component
public class RateDiscountPolicy implements DiscountPolicy {
...
}

@Autowired // 주입을 하면 NoUniqueBeanDefinitionException 에러가 발생함.
private DiscountPolicy discountPolicy;

위와 같이 Bean이 2개 이상인 경우에는 에러가 발생하게 된다. 이러한 에러를 해결하기 위해서는 3가지의 방법이 있다.

1. @Autowired 필드 명 매칭

2. @Qualifier @Qualifier끼리 매칭 빈 이름 매칭

3. @Primary 사용

 

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

@Autowired //기존 코드
private DiscountPolicy discountPolicy

@Autowired //변경 코드
private DiscountPolicy rateDiscountPolicy

------------------------------------------------------------------------------------------------------------------------------------------------
@Qualifier @Qualifier끼리 매칭 빈 이름 매칭 : @Qualifier 는 추가 구분자를 붙여주는 방법이다. 주입시 추가적인 방법을 제공하는 것이지 빈 이름을
변경하는 것은 아니다.

@Component
@Qualifier("mainDiscountPolicy") // 주입시에 @Qualifier를 붙여주고 등록한 이름을 적어준다.
public class RateDiscountPolicy implements DiscountPolicy {
...
}

@Component
@Qualifier("fixDiscountPolicy") // 주입시에 @Qualifier를 붙여주고 등록한 이름을 적어준다.
public class FixDiscountPolicy implements DiscountPolicy {
...
}



*생성자 자동 주입 예시

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

*수정자 자동 주입 예시

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

@Qualifier 로 주입할 때 @Qualifier("mainDiscountPolicy") 를 못찾으면 mainDiscountPolicy라는 이름의 스프링 빈을 추가로 찾는다. 하지만 경험상 @Qualifier 는
@Qualifier 를 찾는 용도로만 사용하는게 명확하고 좋다.
------------------------------------------------------------------------------------------------------------------------------------------------
@Primary 사용 : @Primary는 우선순위를 정하는 방법이다. @Autowired 시에 여러 빈이 매칭되면 @Primary 가 우선권을 가진다.


@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 가 잘 동작하는 것을 확인할 수 있다.
여기까지 보면 @Primary 와 @Qualifier 중에 어떤 것을 사용하면 좋을지 고민이 될 것이다.
@Qualifier의 단점은 주입 받을 때 다음과 같이 모든 코드에 @Qualifier를 붙여주어야 한다는 점이다.

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

반면에 @Primary 를 사용하면 이렇게 @Qualifier 를 붙일 필요가 없다.

우선순위

@Primary 는 기본값 처럼 동작하는 것이고, @Qualifier 는 매우 상세하게 동작한다. 이런 경우 어떤 것이 우선권을 가져갈까? 스프링은 자동보다는 수동이, 넒은 범위의 선택권 보다는 좁은 범위의 선택권이 우선순위가 높다. 따라서 여기서도 @Qualifier 가 우선권이 높다.