Spring

[스프링 핵심 원리 - 기본편] 생성자 주입을 선택해라!

박성민 2021. 9. 20. 15:46

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

불변

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

누락

수정자 의존관계를 사용하여 프레임워크 없이 순수한 자바 코드를 단위 테스트 하는 경우

@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가 프레임워크 안에서 동작할 때는 의존관계가 없으면 오류가 발생하지만, 지금은 프레임워크 없이 순수한 자바 코드로만 단위 테스트를 수행하고 있습니다.

이렇게 테스트를 수행하면 실행은 됩니다.

@Test
void createOrder() {
    OrderServiceImpl orderService = new OrderServiceImpl();
    orderService.createOrder(1L, "itemA", 10000);
}

그런데 막상 실행 결과는 NPE(Null Point Exception)이 발생하는데, memberRepository, discountPolicy 모두 의존관계 주입이 누락되었기 때문입니다.

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

@Test
void createOrder() {
    OrderServiceImpl orderService = new OrderServiceImpl();
    orderService.createOrder(1L, "itemA", 10000);
}

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

    ...

}
  • 잘 보면 필수 필드인 discountPolicy에 값을 설정해야 하는데, 이 부분이 누락되었습니다. 자바는 컴파일 시점에 다음 오류를 발생시킵니다.
  • java: variable discountPolicy might not have been initialized
  • 컴파일 오류는 세상에서 가장 빠르고, 좋은 오류입니다.

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

정리

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

참조