의존관계 주입 방법

의존관계 주입의 방법은 다음과 같다.

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

본 게시글에서 총 4개의 의존관계 주입 방법에 대하여 먼저 다루도록 하고, 최근 트랜드에서의 의존관계 스타일을 설명한다.

생성자 주입

생성자를 통해서 의존 관계를 주입받는 방법이다.
이전 Spring 핵심 원리 관련 게시글들에서 진행했던 방법들이 바로 생성자 주입이다.
특징
- 생성자 호출시점에 딱 1번만 호출되는 것이 보장된다.
- 불변 , 필수 의존관계에 사용한다.
  - 불변 : 딱 한번만 호출되기 때문에 더이상 수정이 불가능하다.
  - 필수 : 반드시 값이 있어야 한다. ( final )
- 생성자가 딱 1개만 있으면 @Autowired 를 생략해도 자동 주입된다!

예시 코드 - `@Autowired`

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

}

예시 코드 - `@Autowired` 생략

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

}

수정자 주입(setter 주입)

setter라 불리는 필드의 값을 변경하는 수정자 메서드를 통해서 의존관계를 주입하는 방법이다.
특징
- 선택 , 변경 가능성이 있는 의존관계에 사용한다.
- 자바빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방법이다.
자바빈 프로퍼티 규약 이란 setXxx, getXxx 라는 메서드를 통해서 필드의 값을 읽거나 수정하는 것이다.

예시 코드

@Component
public class OrderServiceImpl implements OrderService {

	private MemberRepository memberRepository;
	private DiscountPolicy discountPolicy;

	//setter로 멤버변수에 의존관계 주입
	@Autowired
	public void setMemberRepository(MemberRepository memberRepository) {
		this.memberRepository = memberRepository;
	}

	//setter로 멤버변수에 의존관계 주입
	@Autowired
	public void setDiscountPolicy(DiscountPolicy discountPolicy) {
		this.discountPolicy = discountPolicy;
	}

}

필드 주입

필드에 바로 주입하는 방법
특징
- 외부에서 변경이 불가능하여 테스트하기 힘들다.
- DI 프레임워크가 없으면 아무것도 할 수 없다.
  
  new 연산자로 (순수한 자바로) 객체 생성 및 테스트가 불가능하다.
사용하지 않는 것을 권장한다.
- Only ‘스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용

예시 코드

@Component
public class OrderServiceImpl implements OrderService {

	//필드에 바로 주입
	@Autowired
	private MemberRepository memberRepository;

	//필드에 바로 주입
	@Autowired	
	private DiscountPolicy discountPolicy;

}

일반 메서드 주입

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

예시 코드

@Component
public class OrderServiceImpl implements OrderService {

	private MemberRepository memberRepository;
	private DiscountPolicy discountPolicy;

	// init(..) 은 일반 메서드이다.
	@Autowired
	public void init(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
		this.memberRepository = memberRepository;
		this.discountPolicy = discountPolicy;
	}

}

옵션 처리

옵션의 종류

@Autowired( required=false )
- 자동 주입할 대상이 없으면 (주입할 빈이 없으면) 수정자 메서드 자체가 호출이 안된다.
org.springframework.lang.@Nullable
- 자동 주입할 대상이 없으면 null 이 입력된다.
Optional<>
- 자동 주입할 대상이 없으면 Optional.empty 가 입력된다.

예시 코드

Member 빈 객체가 등록이 안되어있는 상태라고 가정한 뒤, 예시 코드를 통해 좀더 자세히 알아본다.

`@Autowired( required=false )`

//메서드 자체가 호출이 안된다.
@Autowired(required = false)
public void setNoBean1(Member member) {
    System.out.println("setNoBean1 = " + member);
}

`org.springframework.lang.@Nullable`

//null이 매개변수 member에 주입된다.
@Autowired
public void setNoBean2(@Nullable Member member) {
	System.out.println("setNoBean2 = " + member);
}

`Optional.empty`

//Optional.empty이 주입된다.
@Autowired(required = false)
public void setNoBean3(Optional<Member> member) {
	System.out.println("setNoBean3 = " + member);
}

의존관계 주입 스타일의 트랜드

권장되는 의존관계 주입 방식

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

생성자 주입을 권장하는 이유

불변
- 대부분의 의존관계 주입은 애플리케이션 종료 전까지 변하면 안된다. (불변해야 한다.)
- 수정자 주입 사용시, setXxx 메서드를 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);
  }

실행은 되지만, NullPointException 이 발생한다. 왜냐하면, memberRepository 와 discountPolicy 모두 의존관계 주입이 누락 되었기 때문이다. (스프링이 없으므로)
하지만, 생성자 주입을 사용한다면 데이터를 누락했을 때 컴파일 오류가 발생한다.
- 따라서, 문제를 캐치하기가 용이하다.

OrderServiceImpl 를 다음과 같이 수정해보자.

  public class OrderServiceImpl implements OrderService {
  	private final MemberRepository memberRepository; //final 추가
  	private final DiscountPolicy discountPolicy; //final 추가

  	//생성자 주입
  	@Autowired
  	public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
  		this.memberRepository = memberRepository;
  		this.discountPolicy = discountPolicy;
  	}
        	
  	//...
  }

위 코드와 같이 수정할 경우 final 덕분에 생성자에 의존관계 주입이 되지 않는다면 (순수한 자바코드로 테스트 한다면) 컴파일 오류가 발생한다.

롬복과 최신 트랜드

롬복 라이브러리를 추가하는 방법은 따로 검색하여 적용해보자. 본 게시글에서는 추가방법에 대해 다루지 않는다.

@RequiredArgsConstructor 애너테이션

롬복 라이브러리에서 제공하는 @RequiredArgsConstructor 애너테이션을 추가하면 final이 붙은 필드를 모아서 생성자를 자동으로 만들어준다.
만약 생성자가 단 한개라면, @Autowired 가 자동으로 붙는다는 점을 기억하자!
- 따라서, @RequiredArgsConstructor 애너테이션이 만들어준 생성자를 제외하고 다른 생성자가 없다면 @Autowired 가 자동으로 붙는다.

따라서 @RequiredArgsConstructor 를 적용하면 다음과 같다.

기존 코드

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

  }

@RequiredArgsConstructor 적용 코드

  @Component
  @RequiredArgsConstructor //새로 추가된 롬복 애너테이션
  public class OrderServiceImpl implements OrderService {

  	private final MemberRepository memberRepository;
  	private final DiscountPolicy discountPolicy;

  	// @Autowired 는 생성자가 한개라면 자동으로 붙는다.
  	// @RequiredArgsConstructor 가 아래 생성자를 자동으로 생성해준다.
  	/*
  	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;

  }

훨씬 간결해졌다.

이와 같이 최근에는 롬복 라이브러리를 활용하여 의존관계를 설정하는 것을 선호한다.

본 게시글은 김영한님의 강의를 토대로 정리한 글입니다.
더 자세한 내용을 알고 싶으신 분들이 계신다면, 해당 강의를 수강하시는 것을 추천드립니다.

의존관계 주입 방법

생성자 주입

예시 코드 - @Autowired

예시 코드 - @Autowired 생략

수정자 주입(setter 주입)

예시 코드

필드 주입

예시 코드

일반 메서드 주입

예시 코드

옵션 처리

옵션의 종류

예시 코드

@Autowired( required=false )

org.springframework.lang.@Nullable

Optional.empty

의존관계 주입 스타일의 트랜드

권장되는 의존관계 주입 방식

생성자 주입을 권장하는 이유

롬복과 최신 트랜드

@RequiredArgsConstructor 애너테이션

예시 코드 - `@Autowired`

예시 코드 - `@Autowired` 생략

`@Autowired( required=false )`

`org.springframework.lang.@Nullable`

`Optional.empty`