스프링 핵심 원리 - 기본편 | 7. 의존관계 자동 주입 1

김영한님의 [스프링 핵심 원리 - 기본편]을 보고 작성한 글입니다:)

---

1. 다양한 의존관계 주입 방법

• 생성자 주입
• setter 주입
• 필드 주입
• 일반 메서드 주입

 

생성자 주입

• 생성자를 통해서 의존 관계를 주입 받는 방법
• 생성자 위에 @Autowired를 붙임
• 생성자 호출시점에 딱 1번만 호출되는 것이 보장
• 따라서 불변, 필수 의존관계에 사용

@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
     this.memberRepository = memberRepository;
     this.discountPolicy = discountPolicy;
}

생성자가 딱 1개만 있으면 @Autowired를 생략해도 자동 주입 된다. (스프링 빈에만 해당)

 

setter 주입 (수정자 주입)

• setter 메서드를 통해서 의존관계를 주입하는 방법
• 선택, 변경 가능성이 있는 의존관계에 사용

@Autowired
public void setMemberRepository(MemberRepository memberRepository) {
	 this.memberRepository = memberRepository;
}

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

 

필드 주입

• 이름 그대로 필드에 바로 주입하는 방법
• 외부에서 변경이 불가능해서 테스트하기 힘들다.
• DI 프레임워크가 없으면 아무것도 할 수 없다.
• 따라서 사용하지 않는 것이 좋다.

@Autowired
private MemberRepository memberRepository;

애플리케이션의 실제 코드와 관계 없는 테스트 코드

또는 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서 특별한 용도로 사용

 

일반 메서드 주입

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

@Autowired
public void init(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
     this.memberRepository = memberRepository;
	 this.discountPolicy = discountPolicy;
}

 

당연한 이야기지만 의존관계 자동 주입은 스프링 컨테이너가 관리하는 스프링 빈이어야 동작한다.

 

😆 결론은 생성자 주입을 사용하자!

최근에는 스프링을 포함한 DI 프레임워크 대부분이 생성자 주입을 권장한다. 그 이유는 다음과 같다.

 

불변

• 대부분의 의존관계 주입은 애플리케이션 종료 전까지 변하면 안된다. 
• setter 주입을 사용하면, setter 메서드를 public으로 열어두어야 하고, 변경하면 안되는 메서드를 열어두는 것은 좋은 설계 방법이 아니다.
• 셍성자 주입은 객체를 생성할 때 딱 1번만 호출되므로 불변하게 설계할 수 있다.

 

누락

• 생성자 주입을 사용하면 주입 데이터를 누락 했을 떄 컴파일 오류가 발생한다.
• 따라서 IDE에서 바로 어떤 값을 필수로 주입해야 하는지 알 수 있다.
• 생성자 주입을 사용하면 필드에 final키워드를 사용할 수 있다. 그래서 생성자에서 혹시라도 값이 설정되지 않은 오류를 컴파일 시점에 막아준다.

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

 

정리

• 생성자 주입 방식은 프레임워크에 의존하지 않고, 순수한 자바 언어의 특징을 잘 살리는 방법이다.
• 항상 생성자주입을 선택하자! 가끔 필수 값이 아닌 경우에는 setter 주입 방식을 옵션으로 사용하면 된다.

 

---

 

2. 옵션 처리

@Autowired만 사용하면 required 옵션의 기본값이 true로 되어 있어서 자동 주입 대상이 없으면 오류가 발생한다.

따라서 주입할 스프링 빈이 없어도 동작해야 할 때, 자동 주입 대상을 옵션으로 처리하는 방법에 대해 소개하겠다.

 

1. @Autowired(required=false)

• 자동으로 주입할 대상이 없으면 setter 메서드 자체가 호출 안된다.

2. @Nullable

• 자동 주입할 대상이 없으면 null이 입력된다.

3. Optional<>

• : 자동 주입할 대상이 없으면 Optional.empty 가 입력된다.

 

예제로 확인해보자.

스프링 빈이 아닌 Member를 의존관게 주입할 때, 위에 3가지 방법으로 옵션 처리를 해보자.

//결과: 호출 자체가 안됨
@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

setNoBean1() 은 @Autowired(required=false)이므로 호출 자체가 안됐다.

 

참고: @Nullable, Optional은 스프링 전반에 걸쳐서 지원된다. 예를 들어서 생성자 자동 주입에서 특정 필드에만 사용해도 된다.

 

---

 

3. 롬복과 최신 트랜드

롬복 라이브러리가 제공하는 @RequiredArgsConstructor 기능을 사용하면 final이 붙은 필드를 모아서 생성자를 자동으로 만들어준다.

 

롬복 적용 전 코드

@Component
public class OrderServiceImpl implements OrderService {
     private final MemberRepository memberRepository;
     private final DiscountPolicy discountPolicy;
     
     //생성자가 1개이므로 @Autowired 생략
     public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
         this.memberRepository = memberRepository;
         this.discountPolicy = discountPolicy;
    }
}

 

롬복 적용 후 코드

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

 

정리

최근에는 생성자를 딱 1개 두고 @Autowired를 생략하는 방법을 주로 사용한다. 여기에 Lombok 라이브러리의 @RequiredArgsConstructor을 함께 사용하면 기능은 다 제공하면서, 코드는 깔끔하게 사용할 수 있다.

 

+ Lombok이란?

• Annotation 기반으로 코드를 자동완성 해주는 자바 라이브러리
• 생성자, Getter, Setter, ToString 등의 반복되는 메소드를 작성
• 롬복을 사용했을 때의 장점
  • 어노테이션 기반의 코드 자동 생성을 통한 생산성 향샹
  • 반복코드 다이어트를 통해 가독성 및 유지보수성 향상
  • Getter / Setter 외 빌더 패턴이나 로그생성 등 다양한 방면으로 활용 가능

 

 

 

다음 글 보러 가기😉

2022.09.26 - [Spring] - 스프링 핵심 원리 - 기본편 | 7. 의존관계 자동 주입 2

스프링 핵심 원리 - 기본편 | 7. 의존관계 자동 주입 2