[Spring] 여러가지 의존관계 주입 방식

생성자 주입 방식 4가지

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

 

의존관계 주입 방식은 위와 같이 4가지가 있다. 각각의 방식을 알아보고 생성자 주입 방식을 왜 써야하는지 알아본다.

 

---

생성자 주입

 생성자를 통해서 의존관계를 주입받는 방식이다. 가장 대중적으로 쓰이고 선호되는 방식이다. 생성자 주입 방식은 생성자를 호출하는 시점에 딱 1번만 호출되는 것이 보장된다. 처음 주입이 이뤄지고 난 후에는 변경사항이 없다는 것이다. 생성자 주입 방식은 또한 필수적인 의존관계에 사용되는 방식이다. 다음 OrderServiceImpl 클래스 코드를 보자.

 

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

 

 먼저 스프링 컨테이너가 @Component를 통해 OrderServiceImpl에서 빈을 등록하기 위해  컴포넌트 스캔을 진행한다. 그리고 @Autowired를 확인하고 해당하는 의존 객체인  memberRepository와 discountPolicy를 찾아 주입한다. 앞서 말한 것처럼 생성자 주입 방식은 스프링 빈을 등록할 때 1번만 자동 주입이 일어난다. 이후 외부에서 memberRepository와 discountPolicy의 인스턴스를 변경할 수 있는 방법이 없다. 김영한님의 예시를 인용하면 "공연을 하기 전 배역을 다 정하고, 공연 중간에 배우를 바꿀 수 없다."라는 것이다.

 

 따라서 불변이라는 특징으로 final로 선언이 되어있는데, 이것은 또한 이 객체의 값이 필수적이라는 뜻이기도 하다. 만약 memberRepository나 discountPolicy 중 하나라도 주입이 되지 않는다면, 컴파일 오류가 발생한다. 따라서 외부에서 호출을 할 때에도 생성자에 값을 채워넣어야 한다. 그래서 생성자 주입 방식은 불변이면서 필수적인 의존관계에 보통 사용이 된다.

 

참고로, 생성자가 1개만 있다면 @Autowired를 생략해도 자동으로 생성자가 호출되어 의존관계가 주입된다.

 

수정자 주입

 자바빈 프로퍼티 규약에는 필드의 값을 직접 변경하지 않고 setXxx, getXxx 라는 메서드를 통해서 값을 읽거나 수정하는 규칙이 있다. 예를들어 setter 방식을 따른 setMemberRepository(..) 메서드를 통해서 필드의 값을 수정하는데 이것을 수정자라고 한다. 

 

 수정자 주입 방식은 필드의 값을 변경하는 수정자 메서드를 통해서 의존관계를 주입하는 방식이다. 다음 코드를 보자.

 

@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 어노테이션이 붙은 대상에 자동으로 주입하는데 수정자 주입 방식에서는 @Autowired가 없다면 오류가 발생한다. @Autowired는 기본적으로 주입할 대상이 없으면 오류를 발생하기 때문이다. 주입할 대상이 없어도 동작하게 하려면 @Autowired(required = false)로 옵션을 지정하면 된다. 따라서 선택적이고 변경 가능성 있는 의존관계를 주입할 때는 수정자 방식을 사용한다. 중간에 인스턴스를 바꾸고 싶을 땐 외부에서 강제로 호출하는 방식이 있지만 그럴 일은 거의 없다.

 

 만약 생성자와 수정자가 같이 있으면 어떻게 될까? 정답은 '둘 다 주입이 된다'이다. 물론 스프링 컨테이너는 싱글톤을 보장하기 때문에 memberRepository와 discountPolicy는 똑같은 인스턴스가 주입될 것이다. 

 

필드 주입

 이름 그대로 필드에 바로 주입하는 방식이다. 코드가 간결해서 옛날에 많이 쓰던 방식이나 외부에서 변경이 불가능하여 테스트하기가 어렵다는 단점이 있다. 또한 DI 프레임워크가 없으면 아무 것도 할 수가 없어 필드 주입은 안티 패턴으로 불린다. 임의로 테스트하기 위하여 setMemberRepository와 같이 메서드를 만들어 유연하게 테스트를 구성할 수 있으나 그럴 바에는 수정자 주입 방식을 쓰는게 더 낫다. 결론적으로 필드 주입 사용을 안 쓰는 것을 권장한다. 다음은 필드 주입 예시이다.

 

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

 

 필드 주입 방식은 어플리케이션의 실제 코드와 관계 없는 순수한 자바 테스트 코드나 스프링 설정이 목적인 @Configuration 등 특별한 용도로만 사용된다. 

 

일반 메서드 주입

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

 

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

---

생성자 방식을 사용하는 이유

최근 스프링을 포함한 DI 프레임워크 대부분이 생성자 주입을 권장한다. 그 이유에 대해서 알아보자.

불변

 대부분 의존관계 주입이 한 번 일어나면 어플리케이션 종료시점까지 의존관계를 변경할 일이 없다. 오히려 종료 전까지 불변해야 한다. 만약 수정자 주입을 사용하면 setter 메서드를 public으로 열어두어햐 하는데, 누가 실수로 변경할 수도 있고, 메서드를 열어두는 것은 좋은 설계 방식이 아니다.

 

누락 방지

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

 

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

 

 수정자 주입 방식일 경우, 위와 같은 순수한 자바 코드로만 단위 테스트를 수행하면 실행은 된다. 하지만 실행 결과는 NPE(Null Point Exception)이 발생하는데, memberRepository, discountPolicy 모두 의존관계 주입이 누락되었기 때문이다.

 

 만약 생성자 주입 방식을 사용한다면 다음처럼 주입 데이터가 누락되었을 때 컴파일 오류가 발생한다. 그리고 IDE를 통해서 어떤 값을 필수로 주입해야 하는지 알 수 있다.

 

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

 

 앞서 말한 것처럼 생성자 주입은 필드에 final 키워드를 사용한다. 그래서 값이 설정되지 않은 오류가 있다면 컴파일 시점에 막아준다. 위의 코드에서 discountPolicy가 누락이 되었는데 자바는 컴파일 시점에 'java: variable discountPolicy might not have been initialized' 오류를 띄운다.

 

결론: 생성자 주입 방식을 사용하자

 결론적으로 의존관계를 주입할 때는 항상 생성자 주입 방식을 선택하자. 필수 값이 아닌 경우에는 수정자 주입 방식을 동시에 사용하여 옵션으로 부여하면 된다. 필드 주입은 사용하지 않는 것이 좋다.