본문 바로가기
Spring/Basic

의존관계 자동 주입

by o3oppp 2024. 8. 29.
생성자 주입
@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번만 호출되는 것이 보장
  • 불변, 필수 의존관계에 사용
  • 생성자가 딱 1개만 있으면 @Autowired 생략 가능(스프링 빈에만 해당)

수정자 주입(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;
    }
}
  • setter라 불리는 필드의 값을 변경하는 수정자 메서드를 통해서 의존관계를 주입하는 방법
  • 자바빈 프로퍼티 규약(setXxx, getXxx 를 통해 값을 읽거나 수정하는 규약)의 수정자 메서드 방식을 사용하는 방법
  • 선택, 변경 가능성이 있는 의존관계에 사용

필드 주입
@Component
public class OrderServiceImpl implements OrderService {

    @Autowired
    private MemberRepository memberRepository;
    
    @Autowired
    private DiscountPolicy discountPolicy;
}
  • 필드에 바로 주입하는 방법
  • 외부에서 변경이 불가능하여 테스트 하기 힘듬
  • DI 프레임워크가 없으면 아무것도 할 수 없음
  • 일반적으로 잘 사용하지 않음

일반 메서드 주입
@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;
    }
}
  • 일반 메서드를 통해서 주입 받는 방법
  • 한번에 여러 필드를 주입 받을 수 있음
  • 일반적으로 잘 사용하지 않음
  • 스프링 컨테이너가 관리하는 스프링 빈이 아닌 일반 클래스의 경우 @Autowired를 적용하여도 아무 기능도 동작하지 않음

옵션 처리
  • @Autowired 사용 시 required 옵션의 기본값이 true 이므로 자동 주입 대상이 없으면 오류 발생

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

@Autowired(required = false)
public void setNoBean1(Member member) {
     ...
 }

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

@Autowired
public void setNoBean2(@Nullable Member member) {
     ...
 }

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

@Autowired(required = false)
public void setNoBean3(Optional<Member> member) {
	...
}

생성자 주입을 선택하자

불변

  • 대부분의 의존관계 주입은 애플리케이션 종료시점까지 변하면 안됨
  • 수정자 주입을 사용하면 setXxx 메서드를 public으로 열어두어야 함(실수로 변경 가능)
  • 생성자 주입은 객체를 생성할 때 딱 1번만 호출되므로 불변하게 설계 가능

누락

  • 생성자 주입을 사용하면 주입 데이터를 누락 했을 때 컴파일 오류 발생하여 어떤 값을 필수로 주입해야 하는지 확인 가능

final 키워드

  • 생성자 주입을 사용하면 필드에 final 키워드를 사용할 수 있음
  • 생성자에서 값이 설정되지 않는 오류를 컴파일 시점에 막아줌
  • 오직 생성자 주입 방식만 fianl 키워드를 사용할 수 있음

최신 트랜드

1. 기본 코드

@Component
public class OrderServiceImpl implements OrderService{

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

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

2. 생성자가 딱 1개 있을 시 @Autowired 생략 가능

@Component
public class OrderServiceImpl implements OrderService{

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

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

3. @RequiredArgsConstructor : final이 붙은 필드를 모아서 생성자를 자동으로 생성

@Component
@RequiredArgsConstructor
public class OrderServiceImpl implements OrderService{

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;   
}

조회 빈이 2개 이상인 경우
@Component
public class FixDiscountPolicy implements DiscountPolicy{}

@Component
public class RateDiscountPolicy implements DiscountPolicy{}

@Autowired
private DiscountPolicy discountPolicy
// NoUniqueBeanDefinitionException 오류 발생
  • @Autowired는 타입으로 조회
  • DiscountPolicy의 하위 타입인 FixDiscountPolicy, RateDiscountPolicy 둘 다 스프링 빈으로 설정한 경우, 스프링 빈 조회 시 NoUniqueBeanDefinitionException 오류 발생
     
  • 하위 타입으로 지정 시 DIP를 위배하고 유연성이 떨어짐

해결 방법

1. @Autowired 필드 명 매칭

// 기존 코드
@Autowired
private DiscountPolicy discountPolicy
 
// 필드 명을 빈 이름으로 변경
@Autowired
private DiscountPolicy rateDiscountPolicy
  • 필드 명 매칭은 먼저 타입 매칭을 시도
  • 그 결과에 여러 빈이 있을 경우 추가로 동작(필드 명, 파라미터 명으로 빈 매칭)

2. @Qualifier

@Component
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
@Qualifier("fixDiscountPolicy")
public class FixDiscountPolicy implements DiscountPolicy {}
  • 추가 구분자를 붙여주는 방법
  • 빈 이름을 변경하는 것은 아님
  • 빈 등록 시 @Qualifier를 붙임
// 생성자 자동 주입
@Autowired
public OrderServiceImpl(MemberRepository memberRepository,
		@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
    this.memberRepository = memberRepository;
    this.discountPolicy = discountPolicy;
}

// 빈 등록 시
@Bean
@Qualifier("mainDiscountPolicy")
public DiscountPolicy discountPolicy() {
	...
}
  • @Qualifier("mainDiscountPolicy")를 찾지 못하는 경우 mainDiscountPolicy라는 스프링 빈을 추가로 찾음
  • @Qualifier는 Qualifier를 찾는 용도로만 사용하는게 명확하고 좋음
  • 주입 받을 때 모든 코드에 @Qualifier("명칭")을 붙어야 하는 단점 존재
  • 컴파일 시 타입 체크가 되지 않아 NoSuchBeanDefinitionException 오류 발생 가능
    •     애노테이션을 직접 만들어서 문제 해결

3. @Primary 사용

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
public class FixDiscountPolicy implements DiscountPolicy {}
  • @Autowired 시에 여러 빈이 매칭되면 @Primary가 우선권을 가짐
  • @Qualifier 보다 우선권이 낮음

'Spring > Basic' 카테고리의 다른 글

프로토타입 스코프  (0) 2024.09.01
빈 생명주기 콜백  (1) 2024.09.01
@ComponentScan  (0) 2024.08.21
@Configuration  (0) 2024.08.20
Singleton  (0) 2024.08.20