다양한 의존관계 주입 방법 (@Autowired)

스프링 빈끼리의 의존관계 주입은 크게 4가지 방법이 있습니다.

 

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

이번 포스팅은 각각을 이용하여 의존관계를 주입하는 방법에 대해서 알아보겠습니다.

---

생성자 주입

이름 그대로 생성자를 통해서 의존 관계를 주입받는 방법입니다. 

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

아래 코드처럼 생성자 위에 @Autowired를 붙여서 의존관계를 주입하면 됩니다.

---

@Component
public class OnlineOrder implements Order {
    Product product;

    @Autowired
    public OnlineOrder(Product product) {
        this.product = product;
    }
}

 

 

사실! 생성자가 딱 1개만 있으면 @Autowired를 생략해도 자동 주입됩니다. 

---

@Component
public class OnlineOrder implements Order {
    private Product product;

   // @Autowired
    public OnlineOrder(Product product) {
        this.product = product;
    }
}

 

---

수정자 주입 (Setter 주입)

setter라 불리는 수정자 메서드를 통해서 의존관계를 주입하는 방법입니다.

• 선택, 변경 가능성이 있는 의존관계에 사용됩니다.

아래 코드와 같이 setter 메서드 위에 @Autowired를 선언하면 됩니다.

---

@Component
public class OnlineOrder implements Order {
    private Product product;
    
    // 생성자 주입
    /*public OnlineOrder(Product product) {
        this.product = product;
    }*/


    @Autowired
    public void setProduct(Product product){
        this.product=product;
    }

}

 

---

필드 주입

이름 그대로 필드에 바로 주입하는 방법입니다.

• 코드가 간결하지만, 외부에서 변경 및 접근이 불가능하여 테스트하기가 힘들다는 단점이 있습니다.
• 사용하지 않는 것을 권장합니다만, 아래와 같은 상황에서는 유용할 수도 있습니다.
  • 애플리케이션의 실제 코드와 관계 없는 테스트 코드
  • 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용
  • 즉, 애플리케이션 코드 내부에서는 쓰지 않는 것이 좋습니다.

아래와 같이 필드 위에 @Autowired를 선언하면 필드 주입이 이루어집니다.

---

@Component
public class OnlineOrder implements Order {
    @Autowired
    private Product product;

// 생성자 주입
    /*public OnlineOrder(Product product) {
        this.product = product;
    }*/

// setter 주입
  /*  @Autowired
    public void setProduct(Product product){
        this.product=product;
    }
*/
}

 

---

일반 메서드 주입

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

•  한번에 여러 필드를 주입받을 수 있습니다.
• 하지만, setter를 통해서 주입받는 방법도 존재하여서 일반적으로 잘 사용하지는 않습니다.

아래와 같이 원하는 메서드 위에 @Autowired를 선언하면 메서드 주입이 이루어집니다.

---

@Component
public class OnlineOrder implements Order {
    private Product product;
    
// 생성자 주입
    // @Autowired
    /*public OnlineOrder(Product product) {
        this.product = product;
    }*/

// setter 주입
    /*  @Autowired
      public void setProduct(Product product){
          this.product=product;
      }
  */
    
    @Autowired
    public void init(Product product){
        this.product = product;
    }
}

---

 

의존관계 주입의 다양한 방법에 대해서 알아보았습니다. 당연한 이야기지만, 의존관계 자동 주입은 스프링 컨테이너가 관리하는 스프링 빈이어야 동작합니다!! 즉, 위 코드에서 Product와 OnlineOrder 모두 스프링 빈으로 등록되어 있어야 합니다.

 

---

위의 4가지 방법 중 가장 많이 사용하고 권장되는 방법은 생성자 주입 입니다. 그 이유는 아래와 같습니다.

 

코드의 불변성

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

---

누락의 위험성

만약, Spring Framework 없이, 순수한 자바 코드를 단위 테스트하는 경우에 생성자 주입이 아닌 다른 방법의 주입을 사용하는 경우, 에러 발생 시 컴파일 시점에 에러를 잡아낼 수 없는 불편함이 있습니다. (즉, 실행을 하고 런타임에 NPE가 발생합니다.)

 

@Autowired가 프레임워크 안에서 동작할 때 의존관계가 없으면 오류가 발생하지만, 순수한 자바 코드로만 단위테스트를 수행한다면 컴파일 시점에 오류를 잡아낼 수 없습니다.

 

아래 코드를 실행하면 실행은 되지만, 실행 결과는 NPE(Null Pointer Exception)이 발생하는데, product 의존관계 주입이 누락되었기 때문입니다.

---

@Component
public class OnlineOrder implements Order {
    private Product product;

     @Autowired
      public void setProduct(Product product){
          this.product=product;
      }
      
      public void createOrder(){ product.order(); }
}

class AppTest {
    @Test
    void createOrder() {
        OnlineOrder orderService = new OnlineOrder();
        orderService.createOrder(); // product는 NULL 로 실행 시, Exception이 발생합니다.
    }
}

 

 

위 setter 주입을 생성자 주입으로 변경하면 아래와 같이 주입 데이터를 누락했을 때 컴파일 오류가 발생하여 IDE에서 바로 어떤 값을 필수로 주입해야 하는지 확인할 수 있습니다. (컴파일 시점에 오류를 파악할 수 있는 것이 가장 바람직합니다.)

---

---

final 키워드

생성자 주입을 사용하면 필드에 final 키워드를 사용할 수 있어 생성자에서 혹시라도 값이 설정되지 않는 오류를 컴파일 시점에 막아줍니다. (다른 주입 방식은 모두 생성자 이후에 호출되므로 필드에 final 키워드를 사용할 수 없습니다. 오직 생성자 주입만 가능합니다.)

---

 

 

정리하자면, 생성자 주입은 프레임워크에 의존하지 않고 순순한 자바 언어의 특징을 잘 살리는 방법이기도 합니다. 기본으로 생성자 주입을 사용하되, 필수 값이 아닌 경우 수정자 주입 방식으로 사용하면 됩니다. (동시에 사용이 가능합니다!) 항상 생성자 주입을 먼저 선택하는 것이 좋습니다.

---

[참고자료]

김영한, "스프링 핵심 원리 - 기본편", 인프런