[핵심원리][7-1] 의존관계 자동 주입

Section 7. 의존관계 자동 주입

오늘은 지난 시간에 살짝 언급했던 의존관계 자동 주입에 대해 알아볼 것이다!

---

[ 다양한 의존관계 주입 방법 ]

의존관계 주입은 크게 4가지 방법이 있다. 각 방법마다 사용법과 특징을 알아보자!

1. 생성자 주입

생성자를 통해 의존관계를 주입받는 방식. 지금까지 우리가 사용했던 방식이다.

• 생성자 호출시점에 딱 1번만 호출되는 것이 보장된다.
• 불변, 필수 의존관계에 사용한다.

OrderServiceImpl.java

@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를 생략해도 자동으로 주입된다. (스프링 빈에만 해당)

2. 수정자 주입(setter 주입)

필드의 값을 변경하는 수정자 메서드, setter를 통해서 의존관계를 주입하는 방법

• 선택, 변경 가능성이 있는 의존관계에서 사용한다.
• 자바빈 프로퍼티 규약의 수정자 메서드를 사용하는 방식이다.
  • 자바빈 프로퍼티 규약: 필드의 값을 직접 변경하지 않고 setXxx, getXxx라는 메서드를 통해 값을 읽거나 수정하는 것.

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

⭐ final 키워드가 있으면 안된다!

📌 참고

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

3. 필드 주입

필드에 바로 주입하는 방법

• 코드가 간결하지만, 외부에서 변경이 불가능해서 테스트하기 힘들다는 치명적인 단점이 있다.
• DI 프레임워크가 없으면 아무것도 할 수 없다.😢
• 어플리케이션의 실제 코드와 관계 없는 테스트 코드나, 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용하기도 하지만, 다른 방법을 사용하면 되기 때문에 굳~이~ 사용하지는 않는다.

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

4. 일반 메서드 주입

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

생성자처럼 한번에 여러 필드를 주입받을 수 있지만, 일반적으로 잘 사용하지는 않는다.

@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.springframework.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);
}

실행 결과는 다음과 같다.

setNoBean2 = null
setNoBean3 = Optional.empty

---

[ 생성자 주입을 선택해라! ]

위에서 의존관계를 주입하는 4가지 방법에 대해 알아보았는데, 이 중 어떤 방법을 사용해야 할까?

분명 생성자 주입이 좋으니까 지금까지 써왔을 것이다.
지금부터 왜! 생성자 주입 방식을 써야하는지!에 대해 알아보자.

1. 불변

대부분의 의존관계 주입은 최초 1회 이후 애플리케이션 종료 시점까지 의존관계를 변경할 일이 없다.
오히려! 대부분의 의존관계는 애플리케이션 종료 전까지 변하면 안된다.

하지만 수정자 주입 방식을 사용하면, setter를 public으로 열어두어야 해서 변경 가능성이 생긴다.

누군가가 실수로 변경할 수도 있고, 변경하면 안되는 메서드를 열어두는 것은 좋은 설계 방법이 아니기 때문에,
불변하게 설계할 수 있는 생성자 주입 방식을 주로 사용하는 것이다.

2. 누락

프레임워크 없이 순수 자바로 단위 테스트를 하는 경우,

1. 수정자 주입 방식을 사용했을 경우, 실행은 가능하지만 NPE가 발생한다.
2. 생성자 주입 방식을 사용했을 경우, 컴파일 오류가 발생하여, IDE에서 어떤 값을 필수로 주입해야 하는지 알 수 있다.

3. final 키워드

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

📌 참고

생성자 주입을 제외한 나머지 주입 방식은 모두 생성자 이후에 호출되므로, 필드에 final 키워드를 사용할 수 없다!

💡 정리

• 생성자 주입은 프레임워크에 의존하지 않고, 순수 자바 언어의 특징을 잘 살리는 방식이다.
• 기본으로 생성자 주입을 사용하고, 필수 값이 아닌 경우에는 수정자 주입 방식을 옵션으로 부여하는 방식이 좋다!

---

[ 롬복과 최신 트렌드 ]

앞에서 의존관계 주입은 생성자 주입으로 하는 것이 좋다고 배웠다.
그러면 이제 필요한 부분에 생성자를 다 만들어주고, 주입받은 값을 대입하는 코드도 만들어야 한다.

하지만 이건 너무 귀찮으니까 롬복(Lombok) 라이브러리를 사용해보자!

롬복 설정

1. build.gradle에 라이브러리 및 환경 추가

//lombok 설정 추가 시작
configurations {
 compileOnly {
 extendsFrom annotationProcessor
 }
}
//lombok 설정 추가 끝
...

dependencies {
    ...
 
    //lombok 라이브러리 추가 시작
    compileOnly 'org.projectlombok:lombok'
    annotationProcessor 'org.projectlombok:lombok'
    testCompileOnly 'org.projectlombok:lombok'
    testAnnotationProcessor 'org.projectlombok:lombok'
    //lombok 라이브러리 추가 끝
	
    ...
}

2. File → Settings → plugin → lombok 검색 설치 실행
3. File → Annotation Processors 검색 → Enable annotation processing 체크

이렇게 롬복 설정을 해주고, 롬복이 제공하는 @RequiredArgsConstructor를 추가해준다.
이 어노테이션을 추가하면 final이 붙은 붙은 필드를 모아서 생성자를 자동으로 만들어준다!

@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService {

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;      // 인터페이스에만 의존하게 된다!

}

이렇게 코드를 간결하게 작성할 수 있다!

---

[ 📘 오늘의 TIL ]

생성자 주입과 롬복 기억하자!
다음 시간에 이어서 공부해보자🔥