[Spring] 스프링 컨테이너와 빈 2) 스프링 빈 조회

 

목차

• 스프링 컨테이너 생성
• 컨테이너에 등록된 모든 빈 조회
• 스프링 빈 조회 - 기본
• 스프링 빈 조회 - 동일한 타입이 둘 이상
• 스프링 빈 조회 - 상속 관계
•  BeanFactory와 ApplicationContext
• 다양한 설정 형식 지원 - 자바 코드, XML
• 스프링 빈 설정 메타 정보 - BeanDefinition

 

 

스프링 빈 조회 - 기본

 

일단 테스트를 위한 클래스(ApplicationContextBasicFindTest)를 만들어준다.

 

기본적인 스프링 빈 조회는 getBean을 사용한다.

ac.getBean(빈이름, 타입)
ac.getBean(타입)

 

 

빈이름, 타입으로 조회

@Test
    @DisplayName("빈 이름으로 조회")
    void findBeanByName(){

        MemberService memberService = ac.getBean("memberService", MemberService.class); //매개변수 2개(이름, 타입)
        assertThat(memberService).isInstanceOf(MemberServiceImpl.class); //memberServiceImpl가 MemberSerive의 객체인가

    }

 

 

타입만으로 조회

    @Test
    @DisplayName("이름 없이 타입으로만 조회")
    void findBeanByType(){
        MemberService memberService = ac.getBean(MemberService.class); //매개변수 1개 (타입)
        assertThat(memberService).isInstanceOf(MemberServiceImpl.class); //memberServiceImpl가 MemberSerive의 객체인가
    }

*타입으로 조회 시 같은 타입의 스프링 빈이 둘 이상이면, 오류가 발생한다. 

 

구체적 타입(구현체)로 조회

    @Test
    @DisplayName("구체 타입으로만 조회")
    void findBeanByName2(){
        MemberService memberService = ac.getBean(MemberServiceImpl.class); //매개변수 1개 (구체적인 구현객체 타입, 유연성이 떨어짐) -> 비추천 : 역할에 의존하는게 좋음
        assertThat(memberService).isInstanceOf(MemberServiceImpl.class); //memberServiceImpl가 MemberSerive의 객체인가
    }

유연성이 떨어지며, 항상 역할에 의존하는 것이 좋기 때문에 좋지 않은 방법이다. 

 

 

존재하지 않는 빈을 조회했을 경우 (실패 테스트)

    @Test
    @DisplayName("빈 이름으로 조회X") //실패 테스트
    void findBeanByNameX(){
        MemberService xxxx = ac.getBean("xxxxx", MemberService.class);
    }

코드를 다음과 같이 작성할 경우, 오류가 나기 때문에 코드를 다음과 같이 작성해야한다.

 

    @Test
    @DisplayName("빈 이름으로 조회X") //실패 테스트
    void findBeanByNameX(){

        org.junit.jupiter.api.Assertions.assertThrows(NoSuchBeanDefinitionException.class, ()-> ac.getBean("xxxxx", MemberService.class));

    }

이런 인풋이 있을 때, 다음과 같은 오류가 발생하면 정상인 테스트 

 

 

스프링 빈 조회 
-
동일한 타입 둘 이상

 

일단 테스트를 위한 클래스(ApplicationContextSameBeanFindTest)를 만들어준다.

 

타입으로 조회 시 같은 타입의 스프링 빈이 둘 이상이면, 오류가 발생한다. 

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

 

ac.getBeansOfType()

해당 타입의 모든 빈을 조회할 수 있다.

 

 

같은 타입의 스프링 빈이 두가지인 경우를 테스트하기 위해 임시로 해당 조건을 가지도록 Config를 생성한다.

그 후, 테스트에서 getBean을 타입만으로 조회해오는 코드를 먼저 작성한다. 

*실제로도 같은 타입의 스프링 빈이 두가지 경우일 수 있다. 특히 매개변수를 다르게 주는 경우 

ApplicationContextSameBeanFindTest

public class ApplicationContextSameBeanFindTest {


    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SameBeanConfig.class);


    @Test
    @DisplayName("타입으로 조회시 같은 타입이 둘 이상 있으면, 중복 오류가 발생한다. ")
    void findBeanByTypeDuplicate(){
        MemberRepository bean = ac.getBean(MemberRepository.class);

    }


    @Configuration //이 클래스 내에서만 사용할 클래스 static 사용
    static class SameBeanConfig{ //AppConfig변경하기 곤란해서 임시로 (SameBeanFind)테스트에서만 사용할 용도의 Configuration


        //이런 경우가 있을 수 있음, 특히 파라미터 값이 다른경우 -> 예를 들어 한번에 몇개를 저장할지 파라미터로 받는 경우가 그 예 (하나는 10개 하나는 100개씩 받을 수 있음)
        @Bean
        public MemberRepository memberRepository1(){
            return new MemoryMemberRepository();
        }

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


    }



}

 

실행시켜보면 다음과 같이 에러가 발생한다.

org.springframework.beans.factory.NoUniqueBeanDefinitionException: No qualifying bean of type 'hello.core.member.MemberRepository' available: expected single matching bean but found 2: memberRepository1,memberRepository2

유일하지 않고 2가지가 찾아졌다는 에러 

 

마찬가지로 다음과 같이 예외가 발생하면 성공이도록 코드를 변경해준다.

    @Test
    @DisplayName("타입으로 조회시 같은 타입이 둘 이상 있으면, 중복 오류가 발생한다. ")
    void findBeanByTypeDuplicate(){
//        MemberRepository bean = ac.getBean(MemberRepository.class);

        //예외가 발생해도 성공이도록
        assertThrows(NoUniqueBeanDefinitionException.class, ()-> ac.getBean(MemberRepository.class));

    }

 

해결방법은 다음 두가지이다.

 

빈 이름을 함께 명시해줌

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

 

 

getBeansOfType으로 모든 결과를 조회

    @Test
    @DisplayName("특정 타입을 모두 조회하기")
    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("beanOfType = " + beansOfType);
        assertThat(beansOfType.size()).isEqualTo(2); // MemberRepository가 2개이므로
    }

 

 

스프링 빈 조회
-
상속관계

 

부모타입으로 조회하면, 자식 타입도 함께 조회된다.

모든 자바 객체의 최고 부모인 Object타입으로 조회하면, 모든 스프링 빈을 조회할 수 있다.

 

일단 테스트를 위한 클래스(ApplicationContextExtendsFindTest)를 만들어준다.

 

같은 타입의 부모를 가진 스프링 빈이 두가지인 경우를 테스트하기 위해 임시로 해당 조건을 가지도록 Config를 생성한다.

DiscountPolicy를 상속받는 두 클래스 rate/fix를 가지고 예제를 진행한다.

 

ApplicationContextExtendsFindTest

package hello.core.beanfind;

import hello.core.AppConfig;
import hello.core.discount.DisountPolicy;
import hello.core.discount.FixDiscountPolicy;
import hello.core.discount.RateDiscountPolicy;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.NoUniqueBeanDefinitionException;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.util.Map;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertThrows;

public class ApplicationContextExtendsFindTest {

    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);


    @Test
    @DisplayName("부모 타입으로 조회시, 자식이 둘 이상 있으면, 중복 오류가 발생한다.")
    void findBeanByParentTypeDuplicate(){
        assertThrows(NoUniqueBeanDefinitionException.class, ()-> ac.getBean(DisountPolicy.class));
    }


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

    }






}

 

마찬가지로 부모 타입으로 조회시, 자식이 둘 이상 있으면, 중복 오류가 발생한다.

 

이를 해결하기 위한 방법은 다음과 같다.

 

스프링 빈 이름을 지정하여 조회한다(한번에 하나만가능)

    @Test
    @DisplayName("부모 타입으로 조회시, 자식이 둘 이상 있으면, 빈 이름을 지정하면 된다.")
    void findBeanByParentTypeBeanName(){
        DisountPolicy rateDiscountPolicy = ac.getBean("rateDiscountPolicy", DisountPolicy.class); //한개만 조회 가능
        assertThat(rateDiscountPolicy).isInstanceOf(RateDiscountPolicy.class);
    }

 

 

세부 타입으로 조회한다( 부모클래스가 아닌 자식클래스로 조회)

이 역시 추천하지 않는 방법이다.

    @Test
    @DisplayName("(구체적인) 특정 하위 타입으로 조회") //비추천
    void findBeanBySubType(){
        RateDiscountPolicy bean = ac.getBean(RateDiscountPolicy.class); //DiscountPolicy가 아닌 구체적인 RateDiscountPolicy로 조회
        assertThat(bean).isInstanceOf(RateDiscountPolicy.class);
    }

 

 

모두 조회하는 방법

    @Test
    @DisplayName("부모 타입으로 모두 조회하기")
    void findAllBeanParentType(){
        Map<String, DisountPolicy> beansOfType = ac.getBeansOfType(DisountPolicy.class);
        assertThat(beansOfType.size()).isEqualTo(2);

        //확인용도로 출력(실제 테스트에서는 출력문 사용안함)
        for (String key : beansOfType.keySet()) {
            System.out.println("key = " + key + " value = "+ beansOfType.get(key));
        }
    }

 

참고로 부모 타입을 Object타입으로 설정하면, 스프링이 사용하는 모든 객체를 출력한다.