[Spring] Spring 핵심 원리 : 스프링 빈 조회하기

컨테이너에 등록된 모든 빈 조회

public class ApplicationContextInfoTest {
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

    @Test
    @DisplayName("모든 빈 출력하기")
    void findAllBean() {
        String[] beanDefinitionNames = ac.getBeanDefinitionNames();
        for (String beanDefinitionName : beanDefinitionNames) {
            Object bean = ac.getBean(beanDefinitionName);
            System.out.println("name = " + beanDefinitionName + "bean = " + bean);
        }
    }

    @Test
    @DisplayName("애플리케이션 빈 출력하기")
    void findApplicationBean() {
        String[] beanDefinitionNames = ac.getBeanDefinitionNames();
        for (String beanDefinitionName : beanDefinitionNames) {
            BeanDefinition beanDefinition = ac.getBeanDefinition(beanDefinitionName);

            //Role ROLE_APPLICATION: 직접 등록한 애플리케이션 빈
            //Role ROLE_INFRASTRUCTURE: 스프링 내부에서 사용하는 빈
            if (beanDefinition.getRole() == BeanDefinition.ROLE_APPLICATION) {
                Object bean = ac.getBean(beanDefinitionName);
                System.out.println("name = " + beanDefinitionName + " bean = " + bean);
            }
        }
    }
}
/*
모든 빈 출력하기 실행 결과
name = org.springframework.context.annotation.internalConfigurationAnnotationProcessorbean = org.springframework.context.annotation.ConfigurationClassPostProcessor@681a8b4e
name = org.springframework.context.annotation.internalAutowiredAnnotationProcessorbean = org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor@5cbe877d
name = org.springframework.context.annotation.internalCommonAnnotationProcessorbean = org.springframework.context.annotation.CommonAnnotationBeanPostProcessor@5c08c46a
name = org.springframework.context.event.internalEventListenerProcessorbean = org.springframework.context.event.EventListenerMethodProcessor@4cf8b2dc
name = org.springframework.context.event.internalEventListenerFactorybean = org.springframework.context.event.DefaultEventListenerFactory@708400f6
name = appConfigbean = study.conversiontospring.AppConfig$$EnhancerBySpringCGLIB$$ab2c30b8@5829e4f4
name = memberServicebean = study.conversiontospring.member.MemberServiceImpl@4218500f
name = orderServicebean = study.conversiontospring.order.OrderServiceImpl@4bff64c2
name = orderRepositorybean = study.conversiontospring.order.MemoryOrderRepository@1b2c4efb
name = memberRepositorybean = study.conversiontospring.member.MemoryMemberRepository@c35172e
name = discountPolicybean = study.conversiontospring.discount.FixDiscountPolicy@c2db68f

애플리케이션 빈 출력하기 실행 결과
name = appConfig bean = study.conversiontospring.AppConfig$$EnhancerBySpringCGLIB$$ab2c30b8@681a8b4e
name = memberService bean = study.conversiontospring.member.MemberServiceImpl@5cbe877d
name = orderService bean = study.conversiontospring.order.OrderServiceImpl@5c08c46a
name = orderRepository bean = study.conversiontospring.order.MemoryOrderRepository@4cf8b2dc
name = memberRepository bean = study.conversiontospring.member.MemoryMemberRepository@708400f6
name = discountPolicy bean = study.conversiontospring.discount.FixDiscountPolicy@5829e4f4
*/

모든 빈 출력
 - 컨테이너에 등록된 모든 빈을 출력한다.
 - ac.getBeanDefinitionNames() : 스프링 컨테이너에 등록된 모든 빈의 '이름'을 조회한다.
 - ac.getBean() :  빈 이름 혹은 타입으로 빈 객체를 조회한다. 여기서는 이름으로 조회했다.

애플리케이션 빈 출력
 - 스프링 내부에서 사용하는 빈은 제외하고, 개발자가 직접 정의한 빈만 조회한다.
 - BeanDefinition은 스프링 빈의 메타정보를 담은 클래스다.
 - getRole() 메서드를 통해 직접 정의한 빈인지 아닌지 구분할 수 있다.
 - ROLE_APPLICATION : 개발자가 직접 정의한 빈
 - ROLE_INFRASTRUCTURE : 스프링 내부에서 사용하는 빈

한 개의 빈 조회

public class ApplicationContextBeanFindTest {
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

    @Test
    @DisplayName("빈 이름으로 조회")
    void findBeanByName() {
        Object bean = ac.getBean("memberService");
        assertThat(bean).isInstanceOf(MemberServiceImpl.class);
    }

    @Test
    @DisplayName("빈 이름과 타입으로 조회")
    void findBeanByNameAndType() {
        MemberService memberService = ac.getBean("memberService", MemberService.class);
        assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
    }

    @Test
    @DisplayName("빈 타입으로 조회")
    void findBeanByType() {
        MemberService memberService = ac.getBean(MemberService.class);
        assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
    }

    @Test
    @DisplayName("빈 구체 타입으로 조회")
    void findBeanByType2() {
        // 구체 타입으로 조회하는 것은 구현 클래스(저수준 모듈)에 의존하는 것이기 때문에 좋은 코드는 아니다.
        MemberService memberService = ac.getBean(MemberServiceImpl.class);
        assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
    }

    @Test
    @DisplayName("빈 이름으로 조회 실패")
    void findBeanByNameFail() {
        assertThrows(NoSuchBeanDefinitionException.class,
                () -> ac.getBean("nullBean"));
    }
}

ApplicationContext의 getBean() 메서드를 통해 하나의 빈을 조회할 수 있다. 빈 이름, 빈 타입 그리고 두 개 모두를 통해 조회할 수 있다. 반환받은 객체가 내가 설정한 MemberServiceImpl 타입이면 테스트가 통과하는 구조이다. 주의할 점은 빈 이름으로만 조회할 때는 테스트 실행 시 어떤 타입의 객체인지 모르기 때문에 Object 타입을 반환받는다는 점이다.

마지막 테스트는 전달한 매개변수를 통해 빈 조회가 실패했을 때, NoSuchBeanDefinitionException이 발생하면 통과하는 실패 테스트다. nullBean이라는 이름으로 빈을 등록하지 않았으므로 NoSuchBeanDefinitionException이 발생한다.

동일한 타입의 빈이 두 개 이상 있는 경우

public class ApplicationContextSameBeanFindTest {
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SameBeanConfig.class);
    
    @Test
    @DisplayName("타입으로 조회 시 같은 타입이 둘 이상 있으면, 오류가 발생한다.")
    void findBeanByTypeDuplicate() {
        assertThrows(NoUniqueBeanDefinitionException.class,
                () -> ac.getBean(MemberRepository.class));
    }

    @Test
    @DisplayName("타입으로 조회 시 같은 타입이 둘 이상 있으면, 빈 이름을 지정하면 된다.")
    void findBeanByName() {
        MemberRepository memberRepository = ac.getBean("memberRepository1", MemberRepository.class);
        assertThat(memberRepository).isInstanceOf(MemberRepository.class);
    }

    @Test
    @DisplayName("특정 타입을 모두 조회하기")
    void findAllBeanByType() {
        Map<String, MemberRepository> beansOfType = ac.getBeansOfType(MemberRepository.class);
        // 조회된 빈이 두 개인지 검증
        assertThat(beansOfType.size()).isEqualTo(2);
        for (String key : beansOfType.keySet()) {
            // 빈 타입이 MemberRepository인지 검증
            assertThat(beansOfType.get(key)).isInstanceOf(MemberRepository.class);
            System.out.println("key = " + key + " value = " + beansOfType.get(key));
        }
    }

    @Configuration
    static class SameBeanConfig {
    
        @Bean
        MemberRepository memberRepository1() {
            return new MemoryMemberRepository();
        }
        
        @Bean
        MemberRepository memberRepository2() {
            return new MemoryMemberRepository();
        }
    }
}

같은 타입의 빈을 등록하기 위해 임의의 설정파일 SameBeanConfig를 정의했다. memberRepository1, memberRepository2 둘 다 MemberRepository 타입의 빈을 등록한다. 

타입으로 빈을 조회했을 때 같은 타입의 빈이 두 개 이상 존재하면 NoUniqueBeanDefinitionException이 발생하므로 이를 확인하기 위한 테스트가 첫 번째 테스트다. 빈 이름과 함께 존재하면 이 오류를 피할 수 있다.

ApplicationContext의 getBeansOfType() 메서드를 통해 특정 타입의 빈을 모두 조회할 수 있다. 빈 이름과 빈을 Map형태로 반환한다.  마지막 테스트는 SameBeanConfig에서 같은 타입의 빈을 두 개 등록했으므로 반환된 Map의 사이즈가 2인지 검증한 후, 반복문을 통해 Map에 저장된 각각의 value가 MemberRepository 타입인지 검증한다.

상위 타입으로 빈 조회

public class ApplicationContextExtendsFindTest {
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(ExtendsBeanConfig.class);

    @Test
    @DisplayName("상위 타입을 조회 시, 하위 타입이 둘 이상 있으면, 오류가 발생한다.")
    void findBeanByParentTypeDuplicate() {
        assertThrows(NoUniqueBeanDefinitionException.class,
                () -> ac.getBean(DiscountPolicy.class));
    }

    @Test
    @DisplayName("상위 타입을 조회 시, 하위 타입이 둘 이상 있으면, 빈 이름을 지정하면 된다.")
    void findBeanByParentTypeBeanName() {
        DiscountPolicy rateDiscountPolicy = ac.getBean("rateDiscountPolicy", DiscountPolicy.class);
        assertThat(rateDiscountPolicy).isInstanceOf(RateDiscountPolicy.class);
    }

    @Test
    @DisplayName("특정 하위 타입으로 조회")
    void findBeanBySubType() {
        RateDiscountPolicy rateDiscountPolicy = ac.getBean(RateDiscountPolicy.class);
        assertThat(rateDiscountPolicy).isInstanceOf(RateDiscountPolicy.class);
    }

    @Test
    @DisplayName("상위 타입을 모두 조회")
    void findAllBeanByParentType() {
        Map<String, DiscountPolicy> beansOfType = ac.getBeansOfType(DiscountPolicy.class);
        assertThat(beansOfType.size()).isEqualTo(2);
        for (String key : beansOfType.keySet()) {
            assertThat(beansOfType.get(key)).isInstanceOf(DiscountPolicy.class);
        }
    }

    @Configuration
    static class ExtendsBeanConfig {
        @Bean
        public DiscountPolicy rateDiscountPolicy() {
            return new RateDiscountPolicy();
        }
        @Bean
        public DiscountPolicy fixDiscountPolicy() {
            return new FixDiscountPolicy();
        }
    }
}

상위 타입으로 스프링 빈을 조회하면 하위 타입도 함께 조회된다. 그래서 Object 타입을 조회하면 모든 스프링 빈을 조회한다. 상위 타입으로 빈을 조회했을 때 두 개이상의 하위 타입이 존재하면 NoUniqueBeanDefinitionException이 발생하고 이름을 지정해서 조회함으로써 이를 피할 수 있다.