mojo's Blog
애너테이션 및 List, Map 본문
@Autowired 필드 명, @Qualifier, @Primary
조회할 대상의 빈이 2개 이상일 때 해결 방법은 다음과 같다.
- @Autowired 필드 명 매칭
- @Qualifier -> @Qualifier 끼리 매칭 -> 빈 이름 매칭
- @Primary 사용
※ @Autowired 필드 명 매칭
@Autowired 는 타입 매칭을 시도하고, 이때 여러 빈이 있으면 필드 이름, 파라미터 이름으로 빈 이름을 추가로 매칭한다.
@Component
public class OrderServiceImpl implements OrderService{
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy rateDiscountPolicy){
this.memberRepository = memberRepository;
this.discountPolicy = rateDiscountPolicy;
}
...
}
생성자 파라미터로 DiscountPolicy discountPolicy 를 Discount Policy rateDiscountPolicy 로 파라미터명을 변경해주면 에러없이 성공한다.
즉, 필드 명이 rateDiscountPolicy 으로 정상 주입된다.필드 명 매칭은 먼저 타입 매칭을 시도 하고 그 결과에 여러 빈이 있을 때 추가로 동작하는 기능이다.
※ @Qualifier 사용
@Qualifier 는 추가 구분자를 붙여주는 방법이다.
주입시 추가적인 방법을 제공하는 것이지 빈 이름을 변경하는 것은 아니다.
@Component
@Qualifier("fixDiscountPolicy")
public class FixDiscountPolicy implements DiscountPolicy{
...
}
@Component
@Qualifier("mainDiscountPolicy")
public class RateDiscountPolicy implements DiscountPolicy{
...
}
@Component
public class OrderServiceImpl implements OrderService{
private final MemberRepository memberRepository;
private final DiscountPolicy discountPolicy;
@Autowired
public OrderServiceImpl(MemberRepository memberRepository,
@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy){
this.memberRepository = memberRepository;
this.discountPolicy = discountPolicy;
}
...
}
위와 같이 @Qualifier 를 지정하여 등록한 이름을 불러올 수 있다.
@Qualifier 로 주입할 때 @Qualifier("mainDiscountPolicy") 를 못찾으면 어떻게 될까?
mainDiscountPolicy 라는 이름의 스프링 빈을 추가로 찾는다.
만약 스프링 빈 이름 매칭까지 실패한다면 NoSuchBeanDefinitionException 예외가 발생한다.
@Qualifier 는 @Qualifier 를 찾는 용도로만 사용하는 것이 명확하고 좋다.
※ Primary 사용
@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy{
...
}
@Component
public class FixDiscountPolicy implements DiscountPolicy{
...
}
@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;
}
...
}
RateDiscountPolicy 에 @Primary 애너테이션을 붙임으로써 OrderServiceImpl 생성자의 파라미터 discountPolicy 는 클래스 RateDiscountPolicy 에 대한 객체가 주입된다.
@Primary 와 @Qualifier 중에 어떤 것을 사용하는 것이 효율적인가?
@Qualifer 의 단점은 주입 받을 때 모든 코드에 @Qualifer 를 붙여줘야 한다는 단점이 있다.
반면에 @Primary 를 사용하면 @Qualifier 처럼 모든 코드에 붙이는 것이 아닌 가장 우선순위를 둔 클래스에 딱 하나만 붙여주면 되기 때문에 @Primary 가 더 효율적이다.
※ 우선순위
@Primary 는 기본값 처럼 동작하고 @Qualifier 는 매우 상세하게 동작한다.
이런 경우 어떤 것이 우선권을 가져가냐면, 스프링은 자동보다는 수동으로 즉, 넓은 범위의 선택권보다는 좁은 범위의 선택권이 우선 순위가 더 높다.
따라서 @Qualifier 가 우선권이 더 높다.
애너테이션 직접 만들기
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Qualifier {
String value() default "";
}
@Qualifier 위에 있는 애너테이션들을 복사하여 아래와 같이 새로운 애너테이션 MainDiscountPolicy 를 만들도록 한다.
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@Qualifier("mainDiscountPolicy")
public @interface MainDiscountPolicy {
}
@Component
@MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy{
...
}
@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;
}
...
}
애너테이션은 상속이라는 개념이 없다.
이렇게 여러 애너테이션을 모아서 사용하는 기능은 스프링이 지원해주는 기능이다.
@Qualifier 뿐만 아니라 다른 애너테이션들도 함께 조합해서 사용할 수 있다.
단적으로 @Autowired 도 재정의 가능하다.
물론 스프링이 제공하는 기능을 뚜렷한 목적 없이 무분별하게 재정의 하는 것은 유지보수에 더 혼란만 가중할 수 있다.
조회한 빈이 모두 필요할 때, List, Map
의도적으로 해당 타입의 스프링 빈이 다 필요한 경우도 있다.
예를 들어서 할인 서비스를 제공하는데, 클라이언트가 할인의 종류(rate, fix)를 선택할 수 있다고 가정한다고 볼 수 있다.
스프링을 사용하면 소위 말하는 전략 패턴을 간단하게 구현할 수 있다.
public class AllBeanTest {
@Test
void findAllBean(){
ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class, DiscountService.class);
DiscountService discountService = ac.getBean(DiscountService.class);
Member member = new Member(1L, "userA", Grade.VIP);
int discountPrice = discountService.discount(member, 10000, "fixDiscountPolicy");
Assertions.assertThat(discountService).isInstanceOf(DiscountService.class);
Assertions.assertThat(discountPrice).isEqualTo(1000);
int rateDiscountPrice = discountService.discount(member, 20000, "rateDiscountPolicy");
Assertions.assertThat(rateDiscountPrice).isEqualTo(2000);
}
static class DiscountService {
private final Map<String, DiscountPolicy> policyMap;
private final List<DiscountPolicy> policies;
@Autowired
public DiscountService(Map<String, DiscountPolicy> policyMap, List<DiscountPolicy> policies){
this.policyMap = policyMap;
this.policies = policies;
System.out.println("policyMap = " + policyMap);
System.out.println("policies = " + policies);
}
public int discount(Member member, int price, String discountCode){
DiscountPolicy discountPolicy = policyMap.get(discountCode);
return discountPolicy.discount(member, price);
}
}
}
위에 대한 출력 결과는 아래와 같다.
policyMap = {fixDiscountPolicy=hello.core.discount.FixDiscountPolicy@e98770d, rateDiscountPolicy=hello.core.discount.RateDiscountPolicy@1ae67cad}
policies = [hello.core.discount.FixDiscountPolicy@e98770d, hello.core.discount.RateDiscountPolicy@1ae67cad]
▲ 로직에 대한 분석
- DiscountService는 Map으로 모든 DiscountPolicy를 주입받는다.
- 이때 fixDiscountPolicy, rateDiscountPolicy 가 주입되는 것을 알 수 있다.
- discount() 메서드는 discountCode로 "fixDiscountPolicy"가 넘어오면 map에서 "fixDiscountPolicy" 스프링 빈을 찾아서 실행한다.
- 마찬가지로 "rateDiscountPolicy"가 넘어오면 "rateDiscountPolicy" 스프링 빈을 찾아서 실행한다.
▲ 주입에 대한 분석
- Map<String, DiscountPolicy> : map의 키에 스프링 빈의 이름을 넣어주고, 그 값으로 DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다.
- List<DiscountPolicy> : DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담아준다.
- 만약 해당하는 타입의 스프링 빈이 없으면, 빈 컬렉션이나 Map 을 주입한다.