의존관계 자동 주입

 

다양한 의존관계 주입 방법

1. 생성자 주입
2. 수정자 주입(Setter 주입)
3. 필드 주입
4. 일반 메서드 주입

 

생성자 주입

생성자를 통해서 의존 관계 주입

생성자 호출 시점에 딱 1번만 호출되는 것이 보장

불변, 필수 의존관계에 사용

스프링 빈 등록될 때 자동으로 주입이 일어난다. (1단계로 다 빈등록 의존관계 주입)

 

생성자가 딱 1개만 있으면 @Autowired를 생략해도 자동 주입이 된다. (스프링 빈에만 해당: 아래 코드에서는 @Component로 스프링 빈으로 등록함)

@Component
public class OrderServiceImpl implements OrderService {

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

    @Autowired //생성자 한개면 @Autowired 생략해도 의존관계 주입 가능
    public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        this.memberRepository = memberRepository;
        this.discountPolicy = discountPolicy;
    }

 

수정자 주입(setter 주입)

setter라 불리는 필드의 값을 변경하는 수정자 메서드를 통해서 의존 관계를 주입하는 방법

선택, 변경 가능성이 있는 의존관계에 사용

자바빈 프로퍼티 규약의 수정자 메서드 방식을 사용하는 방식

스프링 빈을 등록하고 연관 관계를 자동으로 주입 (클래스를 빈으로 등록 (1단계) → setter를 통해서 의존관계 주입 (2단계))

@Component
public class OrderServiceImpl implements OrderService {
    
    private MemberRepository memberRepository; //final 아니므로 변경 가능
    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) 로 지정하면 된다.

자바빈 프로퍼티, 자바에서는 과거부터 필드의 값을 직접 변경하지 않고, setXxx, getXxx 라는 메서드를 통해서 값을 읽거나 수정하는 규칙을 만들었는데, 그것이 자바빈 프로퍼티 규약이다

 

필드 주입

사용을 권장하지 않음

필드에 바로 주입

외부에서 변경이 불가능해서 테스트 하기 힘들다

DI프레임워크가 없으면 아무것도 할 수 없다, 자바 코드로만 작성하면 아무것도 할 수 없다.

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

 

Autowired는 스프링 빈에 등록된 객체를 연결해주는 것이다. 즉, new로 객체를 생성하면 setter메서드가 없으면 필드에 값을 넣어줄 수 없다.

@Test
void fieldInjectionTest() {

    //new로 생성한 객체는 스프링 빈이 아니므로 필드에 의존관계 주입을 할 수 없다.
    OrderServiceImpl orderServiceImpl = new OrderServiceImpl();
    
    //setter 메서드를 만들어서 따로 넣어줘야한다.
    oderServiceImpl.setRepository(new MemoryMemberRepository)

}

 

@Bean 에서 파라미터에 의존관계는 자동 주입된다. 수동 등록시 자동 등록된 빈의 의존관계가 필요할 때 문제를 해결할 수 있다.

@Bean
OrderService orderService(MemberRepository memberRepoisitory, DiscountPolicy discountPolicy) {
    return new OrderServiceImpl(memberRepository, discountPolicy);
}
//OderServic가 수동으로 빈으로 등록 되므로 필드 값도 빈 중에서 동일한 타입을 가져와서 의존관계 주입이 가능하다

 

일반 메서드 주입

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

한번에 여러 필드를 주입 받을 수 있다. → 생성자 주입도 가능함

일반적으로 잘 사용하지 않는다.

수정자 주입과 동일하다

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

 

어떤 의존관계 주입 방법을 사용해야 할까

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

 

이유는 아래와 같다

 

불변

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

누락

프레임워크 없이 순수한 자바 코드를 단위 테스트 하는 경우에 수정자 의존관계인 경우 @Autowired 가 프레임워크 안에서 동작할 때는 의존관계가 없으면 오류가 발생하지만, 지금은 프레임워크 없이 순수한 자바 코드로만 단위 테스트를 수행하고 있다

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);
}
//실행 결과는 NPE(Null Point Exception)이 발생하는데, memberRepository, discountPolicy 모두 의존관계 주입이 누락되었기 때문이다

생성자 주입을 사용하면 다음처럼 주입 데이터를 누락 했을 때 컴파일 오류가 발생한다. 그리고 IDE에서 바로 어떤 값을 필수로 주입해야 하는지 알 수 있다.

오류 중에 제일 좋은게 컴파일 오류이다.

 

final 키워드

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

컴파일 오류

final 키워드가 있는 discountPolicy가 초기화가 안됐다고 빨간줄이 뜬다

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

 

• 생성자 주입 방식을 선택하는 이유는 여러가지가 있지만, 프레임워크에 의존하지 않고, 순수한 자바 언어의 특징을 잘 살리는 방법이기도 하다.
• 기본으로 생성자 주입을 사용하고, 필수 값이 아닌 경우에는 수정자 주입 방식을 옵션으로 부여하면 된다.
• 생성자 주입과 수정자 주입을 동시에 사용할 수 있다. 항상 생성자 주입을 선택하자 그리고 가끔 옵션이 필요하면 수정자 주입을 선택해라.
• 필드 주입은 사용하지 않는게 좋다.

 

@Autowired 옵션 처리

주입할 스프링 빈 없이도 동작해야할 때가 있는데 @Autowired만 사용하면 required 옵션의 디폴트 값이 true이므로 자동 주입 대상이 없으면 오류 발생 

 

@Autowired(required=false) : 자동 주입할 대상이 없으면 수정자 메서드 자체가 호출 안됨

org.springframework.lang.@Nullable : 자동 주입할 대상이 없으면 null이 입력된다.

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

 

@Test
void AutowiredOption() {
    ApplicationContext ac = new AnnotationConfigApplicationContext(TestBean.class);
}

static class TestBean {

    @Autowired(required = false)
    //Member는 스프링 빈이 아니다
    public void setNoBean1(Member noBean1) {
        System.out.println("noBean1 = " + noBean1);
    }

    @Autowired
    //Member는 스프링 빈이 아니다
    public void setNoBean2(@Nullable Member noBean2) {
        System.out.println("noBean2 = " + noBean2);
    }

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

}