[Spring] 스프링 빈 조회 - 동일한 타입이 둘 이상인 경우

빈을 타입으로 조회할 경우, 같은 타입의 스프링 빈이 둘 이상이라면 오류가 발생하게 된다. 

이때는 빈 이름을 지정해주면 된다. 

 

테스트에 앞서 클래스를 하나 만들고, 그 안에 중복을 테스트하기 위해 새로운 컨테이너 SameBeanConfig.class를 임시로 만들어주자. 아래와 같다.

package hello.core.beanfind;

import hello.core.AppConfig;
import hello.core.discount.DiscountPolicy;
import hello.core.member.MemberRepository;
import hello.core.member.MemoryMemberRepository;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

public class ApplicationContextSameBeanFindTest {
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SameBeanConfig.class);

    @Test
    @DisplayName("If there are more than two same type when find by type, error occurs")
    void findBeanByTypeDuplicate(){
        MemberRepository bean = ac.getBean(MemberRepository.class);
    }

    @Configuration
    static class SameBeanConfig{
        //Bean의 이름이 다르고, 타입이 같은 경우
        @Bean
        public MemberRepository memberRepository1(){
            return new MemoryMemberRepository();
        }

        @Bean
        public MemberRepository memberRepository2(){
            return new MemoryMemberRepository();
        }
    }
}

위의 경우를 실행해보면 참조하는 SameBeanConfig 클래스 안에 MemberRepository 타입의 빈이 두 개 존재하므로, 스프링의 입장에서는 어떤 것을 선택해야 할지 결정할 수 없기 때문에 오류(예외)가 발생한다.

NoUniqueBeanDefinitionException 오류가 발생한다.

위의 예외를 처리하기 위해 코드를 다음과 같이 수정하자.

...
@Test
@DisplayName("If there are more than two same type when find by type, error occurs")
void findBeanByTypeDuplicate(){
    //MemberRepository bean = ac.getBean(MemberRepository.class);
    Assertions.assertThrows(NoUniqueBeanDefinitionException.class,
            () -> ac.getBean(MemberRepository.class));
}
...

※ 예외가 터지는 것이 이 코드의 테스트 성공 로직이다. 

 

위의 해결책은 타입으로 조회 시 같은 타입이 둘 이상 있으면, 빈의 이름을 지정하면 된다. 앞서 봤던 코드와 같은 코드이다.

import static org.assertj.core.api.Assertions.assertThat;
...
@Test
@DisplayName("If there are more than two same type, designates bean name")
void findBeanByName(){
    MemberRepository memberRepository = ac.getBean("memberRepository1", MemberRepository.class);
    assertThat(memberRepository).isInstanceOf(MemberRepository.class);
}
...

---

.getBeansOfType()

해당 타입의 모든 빈을 조회하는 메서드이다. 이 메서드를 실행하면 Key, Value가 설정되어있는 Map 타입으로 나온다.

...
@Test
@DisplayName("find all bean by type")
void findAllBeanByType(){
    Map<String, MemberRepository> beansOfType = ac.getBeansOfType(MemberRepository.class);
    for (String key : beansOfType.keySet()) {
        System.out.println("key  = " + key + " | value = " + beansOfType.get(key));
    }
    System.out.println("beansOfType = " + beansOfType);
    assertThat(beansOfType.size()).isEqualTo(2);
}
...

이 테스트 코드의 실행 결과는 다음과 같이 컨테이너에 등록되어 있는 모든 빈이 출력되는 것을 확인할 수 있다.

---

같은 타입이 둘 이상 있을 때 해결하는 방법과 같은 타입의 모든 빈을 조회하는 방법에 대하여 알아보았다.

다음 포스팅에서는 상속관계에서 조회하는 방법에 대해 알아보도록 하자.