[Spring] 다양한 의존관계 주입 방법

의존관계 주입 4가지

• 생성자 주입
• 수정자 주입(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 메서드를 통해 의존관계를 주입하는 방법
• 선택, 변경 가능성이 있는 의존관계에 사용

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) 지정 -> 주입할 대상 없으면 호출 x

필드 주입

• 필드에 바로 주입하는 방법
• 코드가 간결해지만 외부에서 변경이 불가능함 -> 테스트 불가능
• DI 프레임워크가 없으면 사용 불가
• 사용 권장 x
  • 애플리케이션의 실제 코드와 관계 없는 테스트 코드
  • 스프링 설정을 목적으로 하는 @Configuration 같은 곳에서만 특별한 용도로 사용

@Component
public class OrderServiceImpl implements OrderService {

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

}

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

• @Bean에서 파라미터의 의존관계는 자동 주입됨

    @Bean
    public OrderService orderService(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
        return new OrderServiceImpl(memberRepository, discountPolicy);
    }

일반 메서드 주입

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

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

옵션처리

• 스프링 빈이 없어도 동작할 수 있도록 옵션 처리하는 방법 3가지
• @Autowired(required=false) : 자동 주입할 대상이 없으면 수정자 메서드 호출 x
• org.springframework.lang.@Nullable: 자동 주입할 대상이 없으면 null 입력
• Optional<>: 자동 주입할 대상이 없으면 Optional.empty 입력
• @Nullable, Optional은 스프링 전반에 걸쳐 지원, 생성자 자동 주입에서 특정 필드에만 사용 가능

// 호출 안됨
@Autowired(required = false)
public void setNoBean1(Member member) {
    System.out.println("member1 = " + member);
}

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

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

---
// 실행결과
member2 = null
member3 = Optional.empty

생성자 주입 사용하기!

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

불변

• 대부분의 의존관계 주입은 한번 일어나면 애플리케이션 종료시점까지 의존관계를 변경할 일 x
  => 오히려 대부분의 의존관계는 애플리케이션 종료 전까지 변하면 x = 불변해야 한다
• 수정자 주입 사용시, setter 메서드를 public으로 열어두어야 함
• 생성자 주입은 객체 생성 시 1번만 호출 -> 불변하게 설계 가능

누락

• 수정자 주입 사용시 의존관계를 누락하면 실행이 되지만 NPE가 발생함 -> 런타임 오류
• 생성자 주입 사용시 의존관계를 누락하면 바로 컴파일 오류 발생, IDE에서 필수로 주입할 값을 알 수 있음
• 생성자 주입을 사용하면 필드에 final 키워드 지정 가능 -> 생성자에서 값이 설정되지 않으면 컴파일 오류 발생

정리

• 생성자 주입 방식은 프레임워크에 의존하지 않고 순수한 자바 언어의 특징을 살릴 수 있는 방법임
• 항상 기본으로 생성자 주입 사용하기!
• 필수 값이 아닌 경우에는(옵션이 필요할 경우에만) 수정자 주입 방식을 옵션으로 부여하기
• 필드 주입은 사용하지 않는 것이 좋음