스프링 핵심 원리 정리 - 6

의존 관계 자동 주입(1)

의존 관계 주입 방법

  • 생성자 주입
  • setter 주입
  • 필드 주입
  • 일반 메서드 주입
생성자 주입
  • 생성자를 통해 의존 관계를 주입
  • 빈을 등록하면서 의존 관계 주입도 같이 함
  • 생성자 호출 시점에 딱 1번만 호출되는 것 보장
  • 불변, 필수 의존 관계에 사용
  • 생성자가 1개만 있으면 @Autowired가 없어도 자동 주입(스프링 빈에만 해당)
setter 주입
  • setter라 불리는 필드의 값을 변경하는 수정자 메서드를 통해 의존 관계 주입
  • 선택, 변경 가능성이 있는 의존 관계에 사용
  • 선택적으로 의존 관계 주입 가능(required 이용)
  • 자바 빈 프로버티 규약의 수정자 메서드 방식 사용

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

자바 빈 프로버티 규약(JavaBeans Properties)

자바는 필드의 값을 직접 변경하지 않고 setXxx, getXxx f라는 메서드를 통해 값을 읽거나 수정하는 규칙이 있다.

필드 주입
  • 필드에 바로 주입하는 방법

    @Autowired private MemberRepository memberRepository;
    
  • 코드가 간결하지만, 외부에서 변경이 불가능해 테스트 하기 어려움
  • DI 프레임워크가 없으면 아무것도 할 수 없음
  • 애플리케이션의 실제 코드와 관계 없는 테스트 코드 또는 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서나 특별한 용도로 사용
일반 메서드 주입
  • 일반 메서드 통해 주입
  • 한 번에 여러 필드 주입 가능
  • 일반적으로 잘 사용하지 않음

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

옵션 처리

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

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

  • @Autowired(required = false): 자동 주입할 대상이이 없으면 수정자 메서드 자체가 호출되지 않음
  • org.springframework.lang.@Nullable: 자동 주입할 대상이 없으면 null 입력
  • Optional<>: 자동 주입할 대상이 없으면 Optional.empty 입력 (Java 8)
// 호출 안 됨
@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
public void setNoBean3(Optional<Member> member) {
  System.out.println("setNoBean3 = " + member);
}

생성자 주입

과거에는 수정자 주입과 필드 주입을 많이 사용했지만, DI 프레임워크 대부분이 생성자 주입을 권장한다.

불변

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

누락

프레임워크 없이 순수 자바 코드를 단위 테스트 할 때 수정자 의존관계인 경우

public class OrderServiceImpl implements OrderService {
  
  private MemberRepository memberRepository;
    
  @Autowired
  public void setMemberRepository(MemberRepository memberRepository) {
    this.memberRepository = memberRepository;
  }

}

// test
class OrderServiceImplTest {
  @Test
  void createOrder() {
    OrderServiceImpl orderService = new OrderServiceImpl();
    orderService.createOrder(1L, "itemA", 10000);
  }
}
  • @Autowired가 프레임워크 안에서 동작할 때는 의존관계가 없으면 오류가 발생하지만, 지금은 프레임워크 없이 순수한 자바 코드로만 단위 테스트를 수행
  • 테스트는 실행은 되지만, memberRepository 의존 관계가 누락되어 NullPointException 발생

final

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

  • 나머지 주입 방식은 생성자 이후에 호출되므로 필드에 final 키워드를 사용할 수 없다.

정리

  • 생성자 주입 방식은 프레임워크에 의존하지 않고 순수한 자바 언어의 특징을 잘 살리는 방법이다.
  • 기본으로 생성자 주입을 사용하고 필수값이 아닌 경우에는 수정자 주입 방식을 옵션으로 부여할 수 있다.