[Spring] 의존관계 자동 주입

다양한 의존관계 주입 방법

1. 생성자 주입
2. 수정자 주입 (setter 주입)
3. 필드 주입
4. 일반 메소드 주입

생성자 주입

• 정의 : 이름 그대로 생성자를 통해 의존 관계를 주입 받는 방법
• 특징
  - 생성자 호출 시점에 딱 1번만 호출되는 것이 보장됨
  • 불변, 필수 의존 관계에 사용

@Component
public class OrderService {

	private final MemberRepository memberRepository;
    
    @Autowired
    public OrderService (MemberRepository memberRepository) {
    	this.memberRepository = memberRepository;
    }

}

스프링빈에서는 생성자가 1개만 있으면 @Autowired가 생랼되어도 자동으로 주입된다.

수정자 주입(setter 주입)

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

@Component
public class OrderService {

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

}

@Autowired는 주입할 대상이 없으면 오류가 발생하기에 주입할 대상이 없어도 동작하게 하려면 @Autowired(required = false) 로 지정하면 된다.

필드 주입

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

@Component
public class OrderService {
	
    @Autowired
    private MemberRepository memberRepository;
    
}

순수한 자바 테스트 코드에서는 @Autowired가 동작하지 않는다.

일반 메서드 주입

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

@Component
public class OrderService {

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

}

옵션 처리

• 자동 주입 대상을 옵션으로 처리하는 방법은 다음과 같다.
  - @Autowired(required = false) 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출 안됨
  • org.springframework.lang.@Nullable 자동 주입할 대상이 없으면 null 이 입력된다.
  • Optional<> 자동 주입할 대상이 없으면 Optional.empty 가 입력된다.

결론 : 생성자 주입하기

왜 생성자로 해야할까??

1. 불변

• 대부분의 의존관계 주입은 한번 일어나면 애플리케이션 종료시점까지 의존관계를 변경할 일이 없다. 오히려 대부분의 의존관계는 불변해야한다.
• 수정자 주입을 사용하면, set 메소드를 public으로 사용
• 생성자 주입은 객체를 생성할 때 딱 1번만 호출되므로 이후에 호출되는 일이 없다. 따라서 불변하게 설계할 수 있다.

2. 누락

• 프레임워크 없이 순수한 자바 코드를 단위 테스트 하는 경우에 의존 관계가 없으면 어떤 값을 필수로 주입해야 하는지 알 수 있다.

3. final 키워드

• 생성자 주입을 사용하면 final 키워드를 사용할 수 있다. 그래서 생성자에서 혹시라도 값이 설정되지 않는 오류를 컴파일 시점에 막아준다.

@Component
public class OrderService {

	private final MemberRepository memberRepository;
    
    @Autowired
    public OrderService(MemberRepository memberRepository) {
    	this.memberRepository = memberRepository;
    }

}

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

요약

• 생성자 주입 방식을 선택하는 이유는 "프레임워크에 의존하지 않고, 순수한 자바 언어의 특징을 잘 살리는 방법"이기 때문이다.
• 기본으로 생성자 주입을 사용하고 필수 값이 아닌 경우에는 수정자 주입 방식을 옵션으로 부여하면 된다. 생성장 주입과 수정자 주입을 동시에 사용할 수 있다.

Lombok을 사용한 간단한 방법

롬복에서 @RequiredArgsConstructor를 사용하면 컴파일 시점에 생성자 코드를 자동으로 생성해주기에 코드가 간결해진다.

@Component
@RequiredArgsConstructor를
public lcass OrderService {

	private final MemberRepository memberReposiory;

}

우리가 조회하고자 하는 빈이 2개 이상일 때

• @Autowired는 타입으로 조회한다. 그래서 우리가 Coffee라는 객체를 2개의 객체에 상속시키고 빈으로 등록하게 되면 오류가 발생한다.

@Autowired
private Coffee coffee;

@Component
public class IceAmericano implements Coffee {}

@Component
public class HotAmericano implements Coffee {}

이 경우 실행하면 NoUniqueBeanDefinitionException 에러가 발생한다. 따라서 이를 해결하디 위한 방식을 알아보자.

1. @Autowired 필드 명 매칭
2. @Qualifier -> @Qualifier 끼리 매칭 -> 빈 이름 매칭
3. @Primary 사용

1. @Autowired 필드명 매칭

기존에 @Autowired 로 작성한 코드에서 명칭을 변경함

@Autowired
private Coffee coffee;

// 필드 명을 빈 이름으로 ㅇ변경
@Autowired
private Coffee iceAmericano;

2. @Qualifier 사용

@Qualifier는 추가 구분자를 붙여주는 방식으로 주입 시 추가적인 방법을 제공하는 것이지 빈 이름을 변경하는 것은 아니다.

@Component
@Qualifier("IceAmericano")
public class IceAmericano implements coffee {}

@Component
@Qualifier("HotAmericano")
public class HotAmericano implements coffee {}

@Qualifier를 사용하게 되면 빈 이름을 적어주어 생성자, 수정자를 자동으로 주입할 때 편하게 할 수 있다.

@Autowired
public OrderService (@Qualifier("HotAmericano") Coffee coffee) {
	this.coffee = coffee;
}

@Autowired
public Coffee setCoffee(@Qualifier("HotAmericano") Coffee coffee) {
	return coffee;
}

3. @Primary 사용

• @Primary는 우선순위를 정하는 방법으로 @Autowired 시에 여러 빈이 매칭되면 @Primary 가 우선권을 가진다.

@Component
@Primary
public class IceAmericano implements coffee {}

@Component
public class HotAmericano implements coffee {}

• @Qualifier 와 @Primary가 있는데 @Qualifier는 이름을 각각 붙여줘야 하기에 @Primary보다 번거롭다. 그러나 스프링 빈을 등록하고 조회하는 과정에서 명시적으로 잘 정의를 한다면 @Qualifier도 상관이 없다.
• @Primary 는 기본값 처럼 동작하는 것이고, @Qualifier 는 매우 상세하게 동작한다. 이런 경우 어떤 것이 우선권을 가져갈까? 스프링은 자동보다는 수동이, 넒은 범위의 선택권 보다는 좁은 범위의 선택권이 우선 순위가 높다. 따라서 여기서도 @Qualifier 가 우선권이 높다.