9 min read

<Spring> 스프링 핵심원리 이해 4 - 스프링 컨테이너와 스프링 빈

스프링 컨테이너 생성

  • 이전 시간에 우리는 ConfigApp 클래스에 스프링 빈을 등록하고 해당 컨테이너가 객체를 찾고 의존성을 연결해주는 과정을 진행했다.
  • 스프링 컨테이너의 생성은 아래의 코드와 같이 ApplicationContext라는 인터페이스와 AnnotationConfigApplicationContext라는 구현체를 통해서 만들 수 있다.
//스프링 컨테이너 생성
ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);
  • 우리가 진행했던 방식은 애노테이션 기반의 자바 설정 클래스로 스프링 컨테이너를 만든 것이다.

스프링 컨테이너와 스프링 빈 생성과정 및 활용

  1. 아래 그림과 같이 new AnnotationConfigApplicationContext(AppConfig.class)를 통해서 컨테이너를 구현하고 해당 컨테이너의 구성정보를 AppConfig.class로 사용한다.
  1. 위와 같이 컨테이너가 생성되면 @Bean이 있는 메서드들을 스프링 빈으로 스프링 컨테이너가 등록한다. 빈 이름은 메서드 이름을 사용한다.(중복 없이)
  1. 이번 단계에서는 스프링 빈의 의존관계를 설정한다.AppConfig에 있는 의존 관계를 보고 스프링 컨테이너가 의존관계를 주입한다.

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

  • test에 beanfind 패키지 생성후, ApplicationContextInfoTest 클래스를 생성한다.
public class ApplicationContextInfoTest {
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

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

    //ROLE_APPLICATION : 직접 등록한 애플리케이션 빈
    //ROLE_INFRASTRUCTURE : 스프링이 내부에서 사용하는 빈
    @Test
    @DisplayName("Application Bean 출력해보기")
     void findApplicationBean() {
        String[] beanDefinitionNames = ac.getBeanDefinitionNames();
        for (String beanDefinitionName : beanDefinitionNames) {
            BeanDefinition beanDefinition = ac.getBeanDefinition(beanDefinitionName);
            //ROLE_APPLICATION : 직접 등록한 애플리케이션 빈
            //ROLE_INFRASTRUCTURE : 스프링 내부에서 사용하는 빈
            if (beanDefinition.getRole() == BeanDefinition.ROLE_APPLICATION) {
                Object bean = ac.getBean(beanDefinitionName);
                System.out.println("beanDefinitionName = " + beanDefinitionName + " object = " + bean);
            }
        }
    }
}
  • findAllBean()메서드의 경우 아래와 같이 스프링이 내부에서 사용하는 빈과 내가 직접 등록한 빈,모두를 출력해주는 메서드이다.
findAllBean() 메서드 출력결과
findAllBean() 메서드 출력결과
  • 반대로 findApplicationBean의 경우, getRole()을 사용해서 내가 직접 등록한 빈과 스프링이 내부에서 사용하는 빈을 구분해 줄 수 있다.

스프링 빈 조회 - 기본

  • 스프링 컨테이너에서 빈을 찾는 가장 기본적인 방법인 ac.getBean(타입) or ac.getBean(이름,타입)을 통해 빈을 조회한다.
  • 만약 조회할 빈이 없는 경우, NoSuchBeanDefinitionException 에러가 발생한다.
  • beanfind 패키지에 ApplicationContextBasicFindTest라는 클래스를 생성한다.
  • 해당 테스트에서는 4가지 테스트를 진행한다.1)이름으로 찾기 2)타입으로 찾기 3)구현체 타입으로 찾기 4)실패 테스트 순으로 작성된다.
  • 실패 테스트를 제외한 3가지 테스트의 경우, ac.getBean()메서드의 인자를 바꿔가면서 빈 조회를 위한 테스트 코드를 작성하면 된다.
  • 특히, 3번째 구현체 타입으로 찾기의 경우, 추상화된 인터페이스가 아니라 구현체에 의존하고 있는 코드라서 많이 사용되지는 않는다.
  • 실패 테스트는 빈 이름으로 등록되지 않은 “test”를 빈 이름 인자로 넘겨주었으며, 당연히 오류가 터지기 때문에 테스트는 성공하는 것을 볼 수 있다.
빈 조회 실패 테스트
빈 조회 실패 테스트
public class ApplicationContextBasicFindTest {

    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

    @Test
    @DisplayName("빈 이름으로 조회")
    void findByName() {
        MemberService memberService = ac.getBean("memberService", MemberService.class);
        System.out.println("memberService = " + memberService);
        System.out.println("memberService.getClass() = " + memberService.getClass());
        assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
    }

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

    //구현에 의존하는 코드라서 자주 쓰이지는 않는다
    @Test
    @DisplayName("구체 타입으로 빈 조회")//인터페이스의 타입이 아니라 구현체의 타입을 인자로 넘겨서 조회
    void findByName2() {
        MemberServiceImpl memberService = ac.getBean("memberService", MemberServiceImpl.class);
        assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
    }

    @Test
    @DisplayName("빈 이름으로 조회 실패")
    void findByBeanNameX() {
        //오류가 터지면 테스트 성공
        assertThrows(NoSuchBeanDefinitionException.class,
                ()-> ac.getBean("test", MemberService.class));

    }
}

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

  • 동일한 타입이 생기는 경우의 빈 조회를 위해 ApplicationContextSameBeanFindTest 클래스를 생성한다.
  • 해당 컨테이너는 중복되는 타입의 빈을 만들기 위해 AppConfig가 아니라 SameBeanConfig라는 해당 클래스의 이너 클래스를 구성정보로 참고한다.
  • SameBeanConfig는 동일한 타입의 두개의 빈을 등록하는 클래스이다.
  • 만약 위와 같이 동일한 타입이 둘 이상인 경우에는 이름을 인자로 넘겨줘서 빈들의 중복을 방지해주면 된다.
  • findAllBeanByType()메서드의 경우 동일한 타입을 가지는 빈들을 모두 조회하는 메서드이며, 해당 빈들은 Map<이름,타입>으로 출력된다.
public class ApplicationContextSameBeanFindTest {
    //같은 타입인 빈 생성을 위해서 임의적인 SameBeanConfig 를 만들어서 구성정보로 활용!
    // SameBeanConfig 는 내부 클래스로 횔용
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SameBeanConfig.class);

    @Test
    @DisplayName("타입으로 조회시, 같은 타입이 둘 이상 있으면 중복 오류 발생시키는 테스트")
    void findBeanByTypeDup() {
        Assertions.assertThrows(NoUniqueBeanDefinitionException.class,
                () -> ac.getBean(MemberRepository.class));
    }

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

    @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("beansOfType = " + beansOfType);
        assertThat(beansOfType.size()).isEqualTo(2);
    }

    @Configuration
    static class SameBeanConfig {
        //컨테이너에 빈은 2개 등록시킴
        @Bean
        public MemberRepository memberRepository1() {
            return new MemoryMemberRepository();
        }
        @Bean
        public MemberRepository memberRepository2() {
            return new MemoryMemberRepository();
        }
    }
}

스프링 빈 조회 - 상속관계

  • 기본적인 원칙은 부모 타입으로 빈 조회시, 자식 타입도 함께 조회된다.
  • 예를 들어 설명하면, Object타입으로 빈을 조회하면 해당 컨테이너가 가지는 모든 스프링 빈들을 조회한다.
  • 위의 동일한 타입 존재 시 빈 조회와 마찬가지로, 상속관계 빈 조회에서도 TestConfig라는 이너 클래스를 구성정보로 참조해서 컨테이너를 만든다.
  • ApplicationContextExtendsFindTest 클래스를 생성한다.
findAllBeanByObjectType() 결과
findAllBeanByObjectType() 결과
findAllBeanByParandType() 결과
findAllBeanByParandType() 결과
public class ApplicationContextExtendsFindTest {
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);

    //자식이 동일한 타입이라서 생기는 오류 터지게 하는 테스트
    @Test
    @DisplayName("부모 타입으로 조회 시 동일 타입의 자식이 둘 이상 있으면 중복 오류 발생하는 테스트")
    void findBeanByParentTypeDup() {
        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 bean = ac.getBean(RateDiscountPolicy.class);
        assertThat(bean).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()) {
            System.out.println("key = " + key + "value = " + beansOfType.get(key));
        }
    }
	
    @Test
    @DisplayName("부모 타입으로 모두 조회하기 - Object Type")
    void findAllBeanByObjectType() {
        Map<String, Object> beansOfType = ac.getBeansOfType(Object.class);
        for (String key : beansOfType.keySet()) {
            System.out.println("key = " + key + "value = " + beansOfType.get(key));
        }
    }

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

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

BeanFactory와 ApplicationContext

BeanFactory

  • 스프링 컨테이너의 최상위 인터페이스이다.
  • 스프링 빈을 관리하고 조회하는 기본적인 기능을 제공한다.
  • 위의 예제에서 우리가 사용했던 getBean() 메서드를 제공한다.
  • 컨테이너가 구동될 때 Bean 객체를 생성하는 것이 아니라 클라이언트의 요청에 의해 Bean 객체가 사용되는 시점에 객체를 생성하는 방식을 사용한다.(Lazy Init)
  • 스프링 컨테이너의 의존관계는 아래의 그림과 같이 나타난다.
스프링 컨테이너 상속관계
스프링 컨테이너 상속관계

ApplicationContext

  • BeanFactory의 모든 기능을 상속받아서 사용한다.
  • BeanFactory와 달리 다양한 부가기능들을 제공한다.
ApplicationContext가 제공하는 다양한 부가기능들
ApplicationContext가 제공하는 다양한 부가기능들

두가지 인터페이스 비교

  • BeanFactory나 ApplicationContext를 스프링 컨테이너라고 한다.
  • BeanFactory를 직접 사용하는 일은 거의 없다. 주로 부가 기능이 추가된ApplicationContext를 사용한다.

소스코드 : https://github.com/brido4125/core-spring

해당 글은 김영한님의 <스프링 핵심> 강좌를 기반으로 작성되었습니다.