의존관계 자동 주입 방법

이 글은 김영한 님의 스프링 핵심 원리 - 기본편(https://inf.run/ZtdV)을 수강하며 정리한 글입니다.

 

생성자 주입
수정자 주입(setter 주입)
필드 주입
일반 메서드 주입

의존관계 자동 주입은 스프링 컨테이너가 관리하는 스프링 빈이어야 동작한다는 것을 전제로 한다.

 

---

 

생성자 주입

 

• 생성자 호출 시점에 딱 1번만 호출되는 것이 보장된다.
• 불변, 필수 의존관계에 사용한다. (이후에 값을 수정할 수 없어서 안전하다.)

@Component
public class OrderServiceImpl implements OrderService {

    private final MemberRepository memberRepository
    private final DiscountPolicy discountPolicy;

    // 생성자가 딱 1개만 있으면 @Autowired 생략 가능
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }
}

 

---

 

수정자 주입

setter 주입

 

• 선택, 변경 가능성이 있는 의존관계에 사용한다.
• 생성자 주입이 함께 존재할 수도 있고, 생략할 수도 있다.

@Component
public class OrderServiceImpl implements OrderService {
    
    private MemberRepository memberRepository;
    private DiscountPolicy discountPolicy;
    
    @Autowired // 주입할 대상이 없으면 오류가 발생하므로 그럴 땐 아래와 같이 명시한다
    // @Autowired(required = false)
    public void setMemberRepository(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }
    
    @Autowired
    public void setDiscountPolicy(DiscountPolicy discountPolicy) {
        this.discountPolicy = discountPolicy;
    }
}

 

필드 주입

 

필드에 바로 주입하는 방법이다. 테스트 코드와 같은 특수한 목적으로만 사용하고 애플리케이션 소스 내에서는 가급적 사용하지 않는다.

@Component
public class OrderServiceImpl implements OrderService {

    @Autowired
    private MemberRepository memberRepository; //private여도 가능
    
    @Autowired
    private DiscountPolicy discountPolicy;
}

• 코드가 간결하지만 외부에서 변경이 불가능해서 테스트 하기 힘들다는 치명적인 단점이 있다.
• DI 프레임워크가 없으면 아무것도 할 수 없다.
• 주입 대상을 생성자 주입과 같이 지정할 수 없다.
  
  • 외부에서 접근하려면 별도의 setter가 필요하다 → 이런 방식을 사용할 바에 필드 주입을 사용한다
• 아래와 같은 경우 외에는 사용하지 말자!
  1. 애플리케이션의 실제 코드와 관계 없는 테스트 코드
  2. 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용

 

---

 

일반 메서드 주입

 

• 아무 메서드에 @Autowired를 붙일 수 있다.

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

 

---

 

생성자 주입을 선택해라!

 

항상 생성자 주입을 선택해라! 그리고 가끔 옵션이 필요하면 수정자 주입을 선택해라.
필드 주입은 사용하지 않는 게 좋다.

 

🌳 불변

• 대부분의 의존관계 주입은 애플리케이션 종료 시점까지 의존관계를 변경할 일이 없다.
  오히려 대부분의 의존관계는 애플리케이션 종료 전까지 변하면 안 된다.
• 수정자 주입을 사용하면, setXxx 메서드를 public으로 열어 두어야 한다.

 

🌳 누락 방지 (final 키워드)

생성자 주입 방식은 final 키워드를 사용해서 실수로 파라미터 값을 누락하는 것을 막을 수 있다. (컴파일 오류가 발생) 나머지 주입 방식은 모두 생성자 이후에 호출되므로, final 키워드를 사용할 수 없다.

 

---

 

옵션 처리

 

@Autowired를 사용하면 'required = true'가 기본 옵션이라서 자동 주입 대상이 없으면 오류가 발생한다.

1. @Autowired(required = false): 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출이 안 된다.
2. org.springframework.lang.@Nullable: 자동 주입할 대상이 없으면 null이 입력된다.
3. Optional<>: 자동 주입할 대상이 없으면 Optional.empty가 입력되고, 값이 있으면 Optional로 값을 감싼다.