Spring DI(Dependency Injection) - 의존 관계 주입 핵심 정리

이번에는 Spring Framework & Spring Boot에서 핵심인 DI(의존 관계 주입)에 대해 정리할 것이다.

DI(Dependency Injection)은 의존성 주입 혹은 의존 관계 주입이라고도 불린다. 그리고 Spring에서 매우 중요한 핵심 중에 하나이다.

또한 과거 국비 교육에서 Spring을 처음 접할 때 의존 관계 주입은 필드 주입을 해야 한다고 잘못 배운 적이 있다.

과거에 만들어진 스프링 레거시 코드를 만지는 경우는 어쩔 수 없겠지만, 꼭 알아둬야 한다고 생각해서 정리하게 되었다.

 

들어가기 앞서

의존성이란?
- 객체를 생성 및 사용함에 있어 의존 관계가 있는 경우를 말합니다.

 

1. DI (Dependency Injection)

DI란 의존 관계 주입 혹은 의존성 주입이라 불리고, Spring은 3가지 핵심 프로그래밍 모델(AOP, DI, IOC)을 지원하는데, 그 중 하나가 바로

의존 관계 주입(Dependency Injection)입니다. 그리고 Spring은 객체의 의존 관계를 의존 관계 주입을 통해 관리합니다.

DI는 외부에서 객체 간의 관계(의존성)를 결정해 주는데 즉, 객체를 직접 생성하는 것이 아니라 외부에서 생성 후 주입시켜 주는 방식이라 할 수 있다.

DI를 통해 객체 간의 관계를 동적으로 주입하여 유연성을 확보하고 결합도를 낮출 수 있다.

 

---

2. Spring에서의 DI 방법 3가지

Spring에서 의존 관계 주입(DI) 방법에는 총 3가지가 있다.

들어가기 전에 앞서 Spring 3.x 버전까지만 해도 Setter 주입을 권장하였으나, 최근에는 순환 참조 등의 문제로 인해 Spring 4.3 이후 버전부터는 생성자 주입(Construct Injection) 방법을 권장하고 있다.

 

[ Spring DI 3가지 방법 ]

• Construct Injection(생성자 주입)
• Field Injection(필드 주입)
• Setter Injection(Setter 주입)

 

(1) Constructor Injection(생성자 주입)

• 현재 가장 권장되는 의존 관계 주입 방식이다.
  • Spring 공식 문서에서도 생성자 주입을 권장한다.
  • 하나의 생성자가 존재할 때 필드 주입의 대부분의 단점을 극복한다.
  • Spring 4.3부터는 @Autowired가 생략 가능해서 최근에는 생성자를 딱 1개 두고, @Autowired를 생략하는 방법을 주로 사용한다.
  • 추가로 Lombok 라이브러리의 @RequiredArgsConstructor를 함께 사용하면 생성자를 생략 가능해서 코드가 깔끔해진다.
• 오직 생성자 주입만이 final 키워드를 사용할 수 있고, 생성자를 통해 주입되는 방식이다.
  
  • final 키워드를 사용하기에 생성자로 인해 인스턴스가 생성될 때 1번만 할당된다.
• final 키워드를 사용해서 값이 한번 할당되면 변경할 수 없기에 객체의 불변성(Immutability)가 보장된다.
  • 불변성에 관해서는 맨 아래에서 추가로 정리하였음.
• 초기에 할당되기에 NPE(Null Pointer Exception)이 절대 발생하지 않는다.

public class Injection {

    private InjectionService injectionService;
    
    // 생성자 DI
    // @Autowired -> Spring4.3부터는 @Autowired 생략 가능
    public Injection(InjectionService injectionService) {
    	this.injectionService = injectionService;
    }
}

위에서는 생성자에 @Autowired 어노테이션을 사용하였다. 하지만 Spring 4.3부터는 @Autowired를 생략 가능하다.

 

생성자 주입이 가장 좋은 방법이지만, 이렇게 하면 매번 생성자를 만들어야 해서 귀찮고, 코드가 길어질 수 있다.

여기서 롬복(Lombok) 라이브러리를 사용하면 생성자 또한 어노테이션으로 생략할 수 있다.

@RequiredArgsConstructor
public class Injection {

    private InjectionService injectionService;
    
}

위의 코드를 보면 @RequiredArgsConstructor 은 롬복(Lombok)의 어노테이션 중 하나이다.

해당 어노테이션은 final 키워드가 붙은 주입에만 생성자를 만들어준다. 만약 final 키워드를 사용하지 않으면 @AllArgsConstructor 어노테이션을 사용하면 된다.

 

(2) Field Injection(필드 주입)

• 어찌 보면 3가지 방법 중 가장 간단한 방법으로 Bean으로 등록된 객체를 사용하고자 하는 클래스에 Field로 선언한 뒤 @Autowired를 붙여주면 자동으로 의존 관계가 주입된다.
• Spring에서 @Autowired 어노테이션을 사용해서 객체 내 필드에 선언해서 주입하는 방법
• 간편하게 의존 관계 주입이 가능하지만 참조 관계를 눈으로 확인하기 어렵고, 순환 참조를 막을 수 없습니다.
  • 예를 들어 A가 B를 가지고 있고, B가 A를 가지고 있어(순환 참조) 실행 전까지 Error를 잡을 수 없다.
• 생성자 주입을 뺀 나머지(필드 주입, Setter 주입)은 모두 생성자 이후에 호출되므로, 필드에 final 키워드를 사용할 수 없다.

public class Injection {
	@Autowired
    private InjectionService injectionService;
}

[ 필드 주입의 장점 ]

• 코드가 간결해진다.

[ 필드 주입의 단점 ]

• Solid 원칙 중에 단일 책임 원칙(SRP)을 위반한다.
• Unit Test가 어렵다.
• final 키워드를 사용할 수 없다.
  • 불변성이 보장되지 않는다. 따라서 객체가 변할 수 있다.

 

(3) Setter Injection(Setter 주입)

• Spring에서 @Autowired 어노테이션을 사용해서 Setter 메서드를 통해 주입하는 방법
  • @Autowired는 Field, Setter Method, Constructor에 사용 가능하다.
• Spring 3.x 버전까지는 DI 권장 방식이였지만, 현재는 아니다.
• NPE(Null Pointer Exception) 발생할 수 있다.
• 생성자 주입을 뺀 나머지(필드 주입, Setter 주입)은 모두 생성자 이후에 호출되므로, 필드에 final 키워드를 사용할 수 없다.

public class Injection {
	
    private InjectionService injectionService;
    
    @Autowired
    public void setInjectionService( InjectionService injectionService) {
    	this.injectionService = injectionService;
    }
}

---

3. 생성자 주입을 지향하자.

 

위에서 언급 했지만 과거 Spring 3.x 버전까지는 권장하는 DI 방식이 Setter 주입, 혹은 과거 레거시 코드를 보면 필드 주입을 사용하였다.

하지만 스프링 공식 문서에서도 언급하듯이 Spring 4.3부터는 생성자 주입 방식을 사용하는 것이 좋다.

 

생성자 주입( Constructor Injection)의 장점은 여러 가지가 있지만, 프레임워크에 의존하지 않고, 순수 Java 언어의 특징을 잘 살리는 방법이기도 하다.

 

[ 핵심 정리 ]

• Spring 개발에서 항상 생성자 주입을 사용하자.
• 가끔 옵션이 필요한 경우 Setter 주입(수정자 주입)을 사용하고, 절대 필드 주입을 사용하지 않는 것이 좋다.

 

추가로 위해서 객체의 불변성(Immutability)에 대해 다뤘다.

 

대부분의 의존 관계 주입은 한번 일어나면 애플리케이션 종료 시점까지 의존 관계를 변경할 일이 없다. 오히려 대부분의 의존 관계는

애플리케이션이 종료되기 전까지 절대 변하면 안된다. (불변해야 한다.)

 

만약 Setter 주입(수정자 주입)을 사용하면 setter 메서드를 public으로 열어둬야 한다.

public으로 열어둔다면 누군가 개발을 하다가 변경할 수 있고, 변경하면 안 되는 메서드를 열어두는 것은 좋은 설계 방법이 아니다.

 

결론은 생성자 주입을 사용하면 객체를 생성할 때 딱 1번만 호출되므로 이후에 호출될 일이 없기에 변경되지 않는다.

즉, 불변성이 유지되도록 설계할 수 있다.