[SpringBoot] @Autowired 매칭한 빈이 2개 이상일 때 해결방안

목차

 

문제: @Autowired로 조회한 빈이 2개 이상

@Autowired는 객체의 타입(Type)으로 조회합니다.

@Autowired
private DiscountPolicy discountPolicy

타입으로 조회하기 때문에 마치 다음 코드처럼 동작합니다. 

ac.getBean(DiscountPolicy.class)  //ac: ApplicatoinContext(스프링 컨테이너)

(실제로는 더 많은 기능을 제공합니다.)

 

만약, 할인 정책(DiscountPolicy)이 두 개가 있다면 어떻게 될까요?

할인 정책이 고정 금액 할인 정책(FixDiscountPolicy)과 퍼센트 할인 정책(RateDiscountPolicy) 두 개가 있어 둘 다 스프링 빈으로 등록되어 DiscountPolicy 타입의 빈을 조회했을 때 2개 이상이 조회된다고 가정해봅시다.

 

코드로 살펴봅시다.

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

@Component
public class RateDiscountPolicy implements DiscountPolicy {}

 

이 상태에서 의존관계 자동 주입을 실행하면

@Autowired
private DiscountPolicy discountPolicy

 

NoUniqueBeanDefinitionException 오류가 발생합니다.

NoUniqueBeanDefinitionException: No qualifying bean of type
'hello.core.discount.DiscountPolicy' available: expected single matching bean
but found 2: fixDiscountPolicy,rateDiscountPolicy

 

오류메시지의 내용은 하나의 빈을 기대했는데 fixDiscountPolicy, rateDiscountPolicy 2개가 발견된다는 내용입니다.

 

이때, 특정한 하위 타입(FixDiscountPolicy나 RateDiscountPolicy)으로 지정하여 해결할 수도 있지만, 하위 타입으로 지정하는 것은 DIP에 위배되며 유연성이 떨어집니다. (DIP는 간단히 말하면 역할에 의존해야 하고 구체적인 것에는 의존하면 안된다는 원칙입니다.)

또한, 똑같은 타입의 스프링 빈이 2개 있을 땐 해결이 안됩니다. 

@Autowired가 아닌 스프링 빈을 수동으로 등록하여 해결하는 방법도 있지만, 의존 관계 자동 주입에서 해결하는 방법이 3개 있습니다.

 

 

해결 방법

1. @Autowired 필드명 매칭
2. @Qualifier
3. @Primary

 

@Autowired 필드명 매칭

@Autowired는 타입 매칭을 시도한 후 여러 개의 빈이 조회되거나 조회되지 않을 경우, 필드 이름이나 파라미터 이름으로 추가로 매칭합니다.

 

기존 코드

@Autowired
private DiscountPolicy discountPolicy

 

필드 명을 빈 이름으로 변경

@Autowired
private DiscountPolicy rateDiscountPolicy

필드 명이 rateDiscountPolicy 이므로 정상으로 주입됩니다.

 

파라미터 이름을 빈 이름으로 변경

@Component
public class OrderServiceImpl implements OrderService {

    private final MemberRepository memberRepository;
    private final DiscountPolicy discountPolicy;

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

파라미터 명이 rateDiscountPolicy 이므로 정상으로 주입됩니다.

 

정리

1. @Autowired 는 타입으로 매칭한다.
2. 타입 매칭의 결과가 2개 이상이거나 없다면 필드 명, 파라미터 명으로 빈 이름을 추가로 매칭한다.

 

 

@Qualifier

@Qualifier 는 추가 구분자를 붙여주는 방법입니다.

(주의: 주입 시 추가적인 방법을 제공하는 것이지 빈 이름을 변경하는 것은 아닙니다.)

 

빈 등록 시 @Qulifier를 붙여준다.

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

@Component
@Qualifier("fixDiscountPolicy")
public class FixDiscountPolicy implements DiscountPolicy {}

 

생성자 자동 주입 적용 예시

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

 

수정자 자동 주입 적용 예시

@Autowired
public DiscountPolicy setDiscountPolicy(@Qualifier("mainDiscountPolicy") DiscountPolicy discountPolicy) {
    this.discountPolicy  = discountPolicy;
}

 

빈 수동 등록 시 적용 예시

@Bean
@Qualifier("mainDiscountPolicy")
public DiscountPolicy discountPolicy() {
    return new ...
}

 

참고 @Qualifier로 주입할 때 @Qualifier("mainDiscountPolicy")를 못찾으면 어떻게 될까?
그런 경우엔 Qualifier 이름명 대신 mainDiscountPolicy 라는 이름의 스프링 빈을 찾습니다. 
하지만 경험상 @Qualifier는 @Qualifier를 찾는 용도로만 사용하는 게 명확하고 좋습니다.

 

 

정리

1. @Qualifier 끼리 매칭한다.
2. 없다면 빈 이름으로 매칭한다.
3. 그래도 못찾는다면 NoSuchBeanDefinitionException 예외가 발생한다.

 

 

@Primary

@Primary는 우선순위를 정하는 방법입니다. @Autowired 시에 여러 빈이 매칭되면 @Primary가 붙은 빈이 우선 순위를 가집니다.

 

rateDiscountPolicy가 우선권을 가지도록 해봅시다.

@Component
@Primary
public class RateDiscountPolicy implements DiscountPolicy {}

@Component
public class FixDiscountPolicy implements DiscountPolicy {}

 

//생성자
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, DiscountPolicy discountPolicy) {
    this.memberRepository = memberRepository;
    this.discountPolicy = discountPolicy;
}

//수정자
@Autowired
public DiscountPolicy setDiscountPolicy(DiscountPolicy discountPolicy) {
    this.discountPolicy = discountPolicy;
}

코드를 실행하면 문제 없이 @Primary 가 잘 동작합니다.

 

 

@Primary VS @Qualifier

@Primary와 @Qualifier 둘 중 어느 것을 사용해야 하는 지 고민이 될 수 있습니다.

@Qualifier의 단점은 주입을 받을 때 다음과 같이 모든 코드에 @Qualifier 를 붙여주어야 합니다.

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

 

반면에 @Primary를 사용하면 번번히 @Qualifier를 붙일 필요 없이 해당 빈에만 @Primary 애노테이션을 붙이면 적용이 됩니다.

 

@Primary  + @Qualifier 활용

코드에서 자주 사용하는 메인 데이터베이스의 커넥션을 획득하는 스프링 빈이 있고, 코드에서 특별한 기능으로 가끔 사용하는 서브 데이터베이스의 커넥션을 획득하는 스프링 빈이 있다고 생각해봅시다.

메인 데이터베이스의 커넥션을 획득하는 스프링 빈은 @Primary 를 적용하여 조회하는 곳에서 @Qualifier 지정 없이 편리하게 사용하고, 서브 데이터베이스 커넥션 빈을 획득할 때는 @Qualifier를 지정하여 명시적으로 획득하는 방식으로 사용하면 코드를 깔끔하게 유지할 수 있습니다. (물론 이때 메인 데이터베이스의 스프링 빈을 등록할 때 @Qualifier 를 지정해줘도 상관은 없습니다.)

 

참고 우선순위
@Primary는 기본 값처럼 동작하는 것이고 @Qualifier는 매우 상세하게 동작합니다.
이런 경우 둘 다 사용되었다면 @Qualifier 가 우선권이 높습니다.
스프링은 자동보다 수동이, 넓은 범위의 선택권보다 좁은 범위의 선택권이 우선순위가 높습니다.

 

 

애노테이션 만들기

@Qualifier("mainDiscountPolicy") 와 같이 문자를 적는다면 컴파일 시 타입 체크가 되지 않습니다.

다음과 같이 애노테이션을 만들어 문제를 해결할 수 있습니다.

 

애노테이션 생성

package hello.core.annotation;

import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Component;

import java.lang.annotation.*;

@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER,
        ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Qualifier("mainDiscountPolicy")
public @interface MainDiscountPolicy {
}

 

애노테이션 적용

@Component
@MainDiscountPolicy
public class RateDiscountPolicy implements DiscountPolicy {}

//생성자 자동 주입
@Autowired
public OrderServiceImpl(MemberRepository memberRepository, @MainDiscountPolicy DiscountPolicy discountPolicy) {
    this.memberRepository = memberRepository;
    this.discountPolicy = discountPolicy;
}

//수정자 자동 주입
@Autowired
public DiscountPolicy setDiscountPolicy(@MainDiscountPolicy DiscountPolicy discountPolicy) {
    this.discountPolicy = discountPolicy;
}

 

참고
애노테이션에는 상속이란 개념이 없습니다. 이렇게 여러 애노테이션을 모아서 사용하는 기능은 자바가 아닌 스프링이 지원하는 기능입니다. @Qualifier 뿐만 아니라 다른 애노테이션도 함께 조합해서 사용할 수 있습니다.
단적으로 @Autowired도 재정의할 수 있습니다. 물론 스프링이 제공하는 기능을 뚜렷 목적없이 무분별하게 재정의하는 것은 유지보수에 더 혼란만 가중할 수 있습니다.

 

 

조회한 빈이 모두 필요할 때: List, Map 자동 주입

의도적으로 해당 타입의 빈이 모두 필요한 경우도 있습니다.

예를 들어, 할인 서비스를 제공하는데 클라이언트가 할인의 종류(rate, fix)를 선택할 수 있다고 가정해봅시다.

스프링을 사용하면 소위 말하는 전략 패턴을 매우 간단하게 구현할 수 있습니다.

 

다음 코드는 DiscountPolicy 타입의 모든 빈들을 Map과 List의 프로퍼티에 자동으로 주입하는 테스트 코드입니다.

 

public class AllBeanTest {

    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);
            System.out.println("discountCode = " + discountCode);
            System.out.println("discountPolicy = " + discountPolicy);

            return discountPolicy.discount(member, price);
        }
    }
    
    @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");
        assertThat(discountService).isInstanceOf(DiscountService.class);
        assertThat(discountPrice).isEqualTo(1000);

        int rateDiscountPrice = discountService.discount(member, 20000, "rateDiscountPolicy");
        assertThat(rateDiscountPrice).isEqualTo(2000);
    }
}

출력 결과

policyMap = {fixDiscountPolicy=hello.core.discount.FixDiscountPolicy@76494737, rateDiscountPolicy=hello.core.discount.RateDiscountPolicy@4a003cbe}
policies = [hello.core.discount.FixDiscountPolicy@76494737, hello.core.discount.RateDiscountPolicy@4a003cbe]

discountCode = fixDiscountPolicy
discountPolicy = hello.core.discount.FixDiscountPolicy@76494737

• Map<String, DiscountPolicy> policyMap : map의 키에는 스프링 빈의 이름을 넣고 그 값으로 DiscountPolicy 타입으로 조회한 스프링 빈을 담습니다. 
• List<DiscountPolicy> policies : DiscountPolicy 타입으로 조회한 모든 스프링 빈을 담습니다.
• 만약, 해당하는 타입의 스프링 빈이 없다면 빈 컬렉션을 주입합니다.

로직 분석

• DiscountService는 Map으로 모든 DiscountPolicy 타입의 빈들을 주입받습니다. 이때 fixDiscountPolicy와 rateDiscountPolicy가 자동으로 주입됩니다.
• discount() 메서드는 discountcode로 "fixDiscountPolicy"가 넘어온다면 map 에서 fixDiscountPolicy 키를 가진 스프링 빈을 찾아 실행합니다.

 

참고 스프링 컨테이너를 생성하면서 스프링 빈 등록하기
스프링 컨테이너는 생성자로 클래스 정보를 받습니다. 여기에 클래스 정보를 넘기면 해당 클래스가 스프링 빈으로 자동 등록됩니다.

new AnnotationConfigApplicationContext(AutoAppConfig.class, DiscountService.class);​

이 코드는 2가지로 나누어 이해할 수 있습니다.
- new AnnotationConfigApplicationContext() : 스프링 컨테이너를 생성한다.
- AutoAppConfig.class, DiscountService.class 를 파라미터로 넘기면서 해당 클래스를 자동으로 스프링 빈으로 등록한다.

정리하면 스프링 컨테이너를 생성하면서 해당 컨테이너에 동시에 AutoAppConfig, DiscountPolicy 를 스프링 빈으로 등록합니다.

 

 

자동 vs 수동의 올바른 실무 기준

수동 빈 등록, 컴포넌트 스캔, 의존관계 자동 주입

어떤 경우에 컴포넌트 스캔과 자동 주입을 하고 어떤 경우에 설정 정보를 통해 수동으로 빈을 등록하고 의존관계를 수동으로 주입해야 할까요?

 

편리한 자동 기능을 기본으로 사용하자.

스프링이 나오고 시간이 갈수록 자동을 선호하는 추세입니다.

스프링은 @Component 뿐만 아니라 @Controller, @Service, @Repository 처럼 계층에 맞추어 일반적인 애플리케이션 로직을 자동으로 스캔할 수 있도록 지원합니다. 거기에 더해서 최근 스프링부트는 컴포넌트 스캔을 자동으로 하며 스프링 부트의 다양한 스프링 빈들도 조건이 맞는다면 자동으로 등록하도록 설계되었습니다.

 

설정 정보를 기반으로 애플리케이션을 구성하는 부분과 실제 동작을 하는 부분을 명확하게 나누는 것이 이상적이지만, 개발자 입장에서 스프링 빈을 하나 등록할 때 @Component 만 넣어주면 끝나는 일을 @Configuration 설정 정보에 @Bean을 적고, 객체를 생성하고, 주입할 대상을 일일이 적어주는 과정을 상당히 번거롭습니다.

또한 관리할 빈이 많아서 설정 정보가 커진다면 설정 정보를 관리하는 것 자체가 부담이 됩니다.

결정적으로, 자동 빈 등록을 사용해도 OCP, DIP 원칙을 지킬 수 있습니다.

 

그러면 수동 빈 등록은 언제하면 좋을까?

1. 기술 지원 빈 등록할 때 사용

애플리케이션은 크게 업무 로직과 기술 지원 로직으로 나눌 수 있습니다.

• 업무 로직 빈 : 웹을 지원하는 컨트롤러, 핵심 비지니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리 등이 모두 업무로직입니다. 보통 비지니스 요구사항을 개발할 때 추가되거나 변경됩니다.
• 기술 지원 빈 : 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용됩니다. 데이터베이스 연결이나, 공통 로그 처리처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들입니다.

 

업무 로직 빈은 숫자도 많고 한 번 개발하면 컨트롤러, 서비스, 리포지토리처럼 어느 정도 유사한 패턴이 있습니다. 이런 경우 자동 기능을 적극 사용하는 것이 좋습니다. 보통 문제가 발생해도 어떤 곳에서 문제가 발생했는지 명확하게 파악하기 쉽습니다.

 

반면, 기술 지원 로직은 업무 로직과 비교해서 그 수가 매우 적고, 보통 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미칩니다. 그러므로 업무 로직은 문제가 발생했을 때 어디가 문제인지 명확하게 드러나지만, 기술 지원 로직은 적용이 잘 되고 있는지 아닌지조차 파악하기 어려운 경우가 많습니다. 따라서 이런 기술 지원 로직들은 가급적 수동 빈 등록을 사용해 명확하게 드러내는 것이 좋습니다.

 

결론

애플리케이션에 광범위하게 영향을 미치는 기술 지원 객체는 수동 빈으로 등록해서 설정 정보에 바로 나타나게 하는 것이 유지보수하기에 좋습니다.

 

 

2. 비지니스 로직 중에서 다형성을 적극 활용할 때, 수동 빈 등록을 하는 것이 유리하다.

조회한 빈이 모두 필요할 때 - List, Map 예시를 다시 보겠습니다.

DiscountService가 의존관계 자동 주입으로 Map<String, DiscountPolicy> 을 주입받고 있습니다.

DiscountPolicy에 어떤 빈들이 주입되는지 알 수 있나요?

수동 빈 등록이 아닌 자동 빈 등록을 하고 있기 때문에 여러 코드를 살펴봐야 파악할 수 있습니다. 내가 개발했다면 크게 상관은 없지만, 만약 이 코드를 다른 개발자가 나에게 준것이라면 어떨까요?

이런 경우, 수동 빈으로 등록하거나 또는 자동으로 한다면 특정 패키지에 묶어두는 것이 좋습니다.

 

DiscountPolicy 구현 빈들을 특정 패키지에 모아둔 모습

핵심은 한 눈에 보고 이해가 가는 것입니다.

이 부분을 별도의 설정 정보로 만들고 수동으로 등록한다면 다음과 같습니다.

 

수동 빈으로 등록

@Configuration
public class DiscountPolicyConfig {

    @Bean
    public DiscountPolicy rateDiscountPolicy() {
            return new RateDiscountPolicy();
    }

    @Bean
    public DiscountPolicy fixDiscountPolicy() {
            return new FixDiscountPolicy();
    }
}

이 설정 정보를 보면 한 눈에 빈의 이름은 물론이고, 어떤 빈들이 주입되는 지 알 수 있습니다.

 

참고 스프링과 스프링부트가 자동으로 등록하는 수 많은 빈들은 예외입니다.
이런 부분들은 스프링 자체를 잘 이해하고 스프링의 의도대로 잘 사용하는 게 중요합니다.
스프링 부트의 경우, DataSource 같은 데이터베이스 연결에 사용하는 기술 지원 로직까지 내부에서 자동으로 등록되는데, 이런 부분은 메뉴얼을 잘 참고해서 스프링 부트가 의도한 대로 편리하게 사용하면 됩니다.
반면에 "스프링 부트가 아니라 내가 직접 기술 지원 객체를 스프링 빈으로 등록한다면 수동으로 등록해서 명확하게 드러내는 것이 좋습니다."

 

 

결론

• 편리한 자동 기능을 기본으로 사용하자.
• 직접 등록하는 기술 지원 객체는 수동 등록을 사용하자.
• 다형성을 적극 활용하는 비지니스 로직은 수동 등록을 고민해보자.

 

---

출처 

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8/dashboard

스프링 핵심 원리 - 기본편 - 인프런 | 강의