[스프링 핵심 원리 - 기본편] #7. 의존관계 자동 주입 (1)

[chaelink]

섹션7. 의존 관계 자동 주입

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

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

생성자 주입

생성자를 통해서 의존 관계를 주입 받는 방법 (지금까지 우리가 진행한 방법)

• 생성자 호출 시점에 딱 1번만 호출되는 것이 보장된다.
• 불변, 필수 의존 관계에 사용
• 생성자가 1개만 있으면 @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를 통해서 의존관계를 주입하는 방법

• 선택, 변경 가능성이 있는 의존관계에 사용
• 자바빈 프로퍼티 규약의 수정자 메서드 방식을 사용

@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(required = false)로 지정하면 된다.

자바빈 프로퍼티 : 필드의 값을 직접 변경하지 않고, set & get 메서드를 이용해서 값을 읽거나 수정하는 규칙이다.

class Data {

   private int age;
   public void setAge(int age) {
       this.age = age;
   }

   public int getAge() {
       return age;
   }
}

필드 주입

필드에 바로 주입하는 방법

• 코드가 간결해서 좋아보이지만, 외부에서 변경이 불가능해서 테스트하기 힘들다는 치명적인 단점이 있다.
• DI프레임워크가 없으면 아무것도 할 수 없다.
• 사용을 자제하자
  ( 테스트 코드, 스프링 설정을 목적으로 하는 @configuration 같은 곳에서만 특별히 사용)

@Component
public class OrderServiceImpl implements OrderService {

    @Autowired  private MemberRepository memberRepository;
    @Autowired  private DiscountPolicy discountPolicy;
}

순수한 자바 코드에서는 @Autowired가 동작하지 않는다. @SpringBootTest처럼 스프링 컨테이너를 테스트에 통합한 경우에만 가능하다.

일반 메서드 주입

일반 메서드를 통해 주입받는 방법

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

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

2. 옵션 처리

주입할 스프링 빈이 없어도 동작해야 할 때가 있다.
그런데 @Autowired만 사용하면 required 옵션의 기본값이 true로 되어 있어 자동 주입 대상이 없으면 오류가 발생한다.

자동 주입 대상을 옵션으로 처리하는 방법

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

static class TestBean {

        @Autowired(required = false)
        public void setNoBean1 (Member noBean1) {
            System.out.println("setNoBean1 = " + noBean1);
        }

        @Autowired
        public void setNoBean2(@Nullable Member member) {
            System.out.println("setNoBean2 = " + member);
        }

        @Autowired(required = false)
        public void setNoBean3(Optional<Member> member) {
            System.out.println("setNoBean3 = " + member);
        }
    }

Member는 스프링 빈이 아니다

@nullable, Optional은 스프링 전반에 걸쳐 지원된다. 예를 들어, 생성자 자동 주입에서 특정 필드에만 사용하는 것도 가능하다

 @Autowired()
        public void setNoBean1 (Member noBean1) {
            System.out.println("setNoBean1 = " + noBean1);
        }

자동 주입 대상이 없으므로 오류가 발생했다.

3. 생성자 주입을 선택해라!

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

불변

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

누락

• 프레임워크 없이 순수한 자바 코드를 단위 테스트하는 경우, 수정자 의존 관계를 사용하면 실행은 되지만 의존 관계 주입이 누락되어 Null Point Exception이 발생한다.
• 생성자 주입을 사용하면 주입 데이터를 누락했을 때 컴파일 오류가 발생한다. & 어떤 값을 필수로 주입해야 하는 지 IDE에서 바로 알 수 있다.

final 키워드

• 생성자 주입을 사용하면 필드에 final 키워드를 사용하여 혹시라도 값이 설정되지 않는 오류를 컴파일 시점에 막아준다.

• java: variable discountPolicy might not have been initialized 가 발생한다

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

정리

1. 생성자 주입 방식 : 프레임워크에 의존하지 않고, 순수한 자바 언어의 특징을 잘 살리는 방법
2. 기본으로 생성자 주입을 사용하고, 필수 값이 아닌 경우에는 수정자 주입 방식을 옵션으로 부여하면 된다.(생성자 주입과 수정자 주입 동시 사용 가능)
3. 항상 생성자 주입 선택! 가끔 옵션이 필요하면 수정자 주입 선택, 필드 주입은 사용 자제

4. 롬복과 최신 트렌드

기본 코드

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

생성자가 1개 이므로 @Autowired 생략

@Component
public class OrderServiceImpl implements OrderService {

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

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

@RequiredArgsConstructor

final이 붙은 필드를 모아서 생성자를 자동으로 만들어주는 기능

@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService {

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

정리

생성자를 하나만 둬서 @Autowired를 생략, lombok 라이브러리의 @requiredargsconstructor 함께 사용하여 깔끔하게 모든 기능을 다 제공한다.