[기본] #4 스프링 컨테이너, 스프링 빈

본 포스팅은 인프런 - 스프링 핵심 원리(기본편)을 강의를 바탕으로 공부하고 정리한 글입니다.

 

이전까지 순수 JAVA로 DI를 적용해보았다.

이제는 Spring을 사용해 AppConfig와 DI 방식을 더욱 간략히 하는 기술들을 적용시켜보도록 하자.

 

스프링 컨테이너, 스프링 빈

---

• ApplicationContext를 스프링 컨테이너라 한다.
• 스프링 컨테이너는 @Configuration이 붙은 AppConfig를 설정 정보로 사용한다.
• 이때 @Bean이 붙은 메소드를 모두 호출해서 반환된 객체를 스프링 컨테이너에 등록한다. 이렇게 등록된 객체를 스프링 빈이라 한다.
• 스프링 빈은 @Bean이 붙은 메소드의 명을 스프링 빈의 이름으로 사용한다.
• 스프링 빈은 applicationContext.getBean()메소드를 사용해 찾을 수 있다.

 

 

스프링 컨테이너 생성 과정

---

스프링 컨테이너 생성

스프링 컨테이너를 생성할 때는 파라미터로 설정 정보를 넘겨줘야 한다. 

ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class)

• 인터페이스 : ApplicationContext
  • ApplicationContext는 인터페이스이다. 다형성이 적용되어 XML 기반으로 만들 수 있고, 애노테이션 기반의 자바 설정 클래스로도 만들 수 있다.
• 구현체 : AnnotationConfigApplicationContext(AppConfig.class)
  
  • AppConfig를 사용했던 방식이 바로 애노테이션 기반으로 스프링 컨테이너를 만든 것으로, AnnotationConfigApplicationContext 클래스는 ApplicationContext의 구현체이다.

 

👉🏻 순수 자바 코드

AppConfig appConfig = new AppConfig();
MemberService memberService = appConfig.memberService();

👉🏻 스프링 코드

ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class)
MemberService memberService = applicationContext.getBean("memberService", MemberService.class);

이전까지는 AppConfig에서 직접 객체를 생성하고 사용했다면, 스프링에게 설정 정보를 던져주고 스프링 컨테이너를 통해 이를 사용할 수 있게 된다.

 

스프링 빈 등록

스프링 컨테이너는 파라미터로 넘어온 설정 클래스 정보(AppConfig)를 사용해서 @Bean이 붙은 메소드를 찾아 생성된 객체를 모두 스프링 빈으로 등록해 관리한다.

 

👉🏻 스프링으로 변경 및 스프링 빈 등록

📁 AppConfig

@Configuration // 애플리케이션의 설정 정보
public class AppConfig {

    @Bean // 스프링 컨테이너에 스프링 빈으로 등록
    public MemberService memberService() {
        return new MemberServiceImpl(memberRepository());
    }

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

    @Bean
    public OrderService orderService() {
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }

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

• @Configuration : AppConfig를 설정 정보로 사용한다는 의미
• @Bean : 스프링 컨테이너에 스프링 빈으로 등록하겠다는 의미

 

💡 빈 이름

• 빈 이름은 메소드 이름을 사용한다.
• 빈 이름을 직접 부여할 수 도 있다. → @Bean(name = "memberService2")
• 이때 빈 이름은 항상 다른 이름을 부여해야 한다.

 

스프링 빈 의존관계 설정

스프링 컨테이너는 설정 정보를 참고해서 의존관계를 주입(DI)한다.

 

 

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

---

모든 빈 조회

스프링 컨테이너에 실제 스프링 빈들이 잘 등록되었는지 확인해보자.

 

📁 test/beanfind/ApplicationContextInfoTest

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 + " object = " + 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 + " object = " + bean);
            }
        }
    }
}

• 모든 빈 출력하기
  • 스프링에 등록된 모든 빈 정보를 출력할 수 있다.
  • ac.getBeanDefinitionNames() : 스프링에 등록된 모든 빈 이름을 조회
  • ac.getBean() : 빈 이름으로 빈 객체를 조회

• 애플리케이션 빈만 출력하기
  • 스프링이 내부에서 사용하는 빈은 제외하고, 직접 등록한 빈만 출력할 수 있다.
  • 스프링이 내부에서 사용하는 빈은 getRole()으로 구분할 수 있다.
    • ROLE_APPLICATION : 일반적으로 사용자가 정의한 빈
    • ROLE_INFRASTRUCTURE : 스프링이 내부에서 사용하는 빈

 

하나의 빈 조회

📁 test/beanfind/ApplicationContextBasicFindTest

public class ApplicationContextBasicFindTest {

    // 스프링 컨테이너 생성
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

    @Test
    @DisplayName("빈 이름, 클래스 타입 조회")
    void findBeanByName() {
        Object memberService = ac.getBean("memberService", MemberService.class);
        assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
    }

    @Test
    @DisplayName("빈 이름, 구체 타입 조회")
    void findBeanByName2() {
        MemberServiceImpl memberService = ac.getBean("memberService", MemberServiceImpl.class);
        assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
    }

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

    @Test
    @DisplayName("빈 이름으로 조회X")
    void findBeanByNameX() {
        //  ac.getBean("xxxx", MemberService.class);
        
        assertThrows(NoSuchBeanDefinitionException.class,
                () -> ac.getBean("xxxx", MemberService.class));
    }
}

• getBean()을 사용해 클래스 빈 조회
  • getBean(빈 이름, 타입) : 가장 구체적이고 명확한 방법 (Bean 이름은 유니크하기 때문)
  • getBean(빈 이름 , 구체타입) : 여러 Bean이 존재할 수 있어 주의가 필요한 방법
  • getBean(타입)
• 만약 조회 대상 스프링 빈이 없으면 예외(NoSuchBeanDefinitionException)가 발생한다.

 

동일 타입이 빈 조회

📁 test/beanfind/ApplicationContextSameBeanFindTest

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);
        for (String key : beansOfType.keySet()) {
            System.out.println("key = " + key + " value = " + beansOfType.get(key));
        }
        assertThat(beansOfType.size()).isEqualTo(2);
    }

    // 테스트용 Config
    @Configuration
    static class SameBeanConfig {

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

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

• 테스트 클래스 내에 SameBeanConfig 컨테이너를 만들고 테스트를 진행한다.
  • MemberRepository 타입으로 2개(memberRepository1, memberRepository2)의 빈을 등록
• ac.getBean(MemberRepository.class);
  • 타입으로 조회했을 때 같은 타입의 스프링 빈이 둘 이상 있으면 오류(NoUniqueBeanDefinitionException)가 발생한다.
  • 이럴 경우 빈 이름까지 지정해줘야 한다.
  • getBean("memberRepository1", MemberRepository.class)
• ac.getBeansOfType(MemberRepository.class);
  • 특정 타입의 모든 빈을 한번에 조회할 수 있다.
  • 특정 타입의 빈이 2개 이상인 경우, 빈 이름과 클래스 타입을 Map<Stirng, 클래스 타입>으로 반환해준다.

 

상속관계 빈 조회

• 스프링 빈은 부모 타입으로 조회하면, 자식 타입도 함께 조회한다.
• 따라서 모든 자바 객체의 최상위 부모인 Object 타입으로 조회하면, 모든 스프링 빈을 조회할 수 있다.

 

📁 test/beanfind/ApplicationContextExtendsFindTest

public class ApplicationContextExtendsFindTest {

    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.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 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")
    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();
        }
    }
}

• 테스트 클래스 내에 TestConfig 컨테이너를 만들고 테스트를 진행한다.
  • DiscountPolicy를 상속하는 2개의 빈(RateDiscountPolicy, FixDiscountPolicy) 등록
• ac.getBean(DiscountPolicy.class);
  • 부모 타입으로 조회 시 자식 타입이 둘 이상 있으면 예외(NoUniqueBeanDefinitionException)가 발생한다.
  • 이럴 경우 빈 이름을 지정하면 된다.
  • getBean("rateDiscountPolicy", DiscountPolicy.class)
• ac.getBeansOfType(DiscountPolicy.class)
  • 부모 타입으로 모든 자식 타입을 조회하면 Map<빈 이름, 클래스 타입>으로 반환해준다.
• ac.getBean(Object.class);
  • 최상위 타입인 Object 타입으로 조회 시 모든 빈이 조회된다.
  • 자바는 모든 클래스가 Object 클래스를 상속받으므로 Spring 내부 클래스까지 모두 출력되는 것을 확인할 수 있다.

 

 

스프링 컨테이너 - BeanFactory, ApplicationContext

---

 

• BeanFactory
  • 스프링 컨테이너의 최상위 인터페이스이다.
  • 스프링 빈을 관리하고 조회하는 역할을 담당한다.
  • getBean()을 제공한다.
  • 우리가 사용했던 대부분의 기능은 BeanFactory가 제공하는 기능이다.
• ApplicationContext
  • BeanFactory 기능을 모두 상속 받아서 제공한다.
  • 빈을 관리하고 조회하는 기능은 BeanFactory가 제공해주지만, 애플리케이션을 개발할 때는 빈을 관리하고 조회하는 기능은 물론이고, 수 많은 부가 기능이 필요하다.
  • ApplicationContext는 BeanFactory 이외의 다양한 인터페이스를 상속 받아 빈을 관리하고 조회하는 기능은 물론이고, 수많은 부가 기능을 제공한다.
    
    • MessageSource(메시지소스를 활용한 국제화 기능) : 한국에서 들어오면 한국어로, 영여권에서 들어오면 영어로 출력하는 기능 제공
    • EnvironmentCapable(환경 변수) : 로컬, 개발, 운영 등을 구분해서 처리하는 기능 제공
    • ApplicationEventPublisher(어플리케이션 이벤트) : 이벤트를 발행하고 구독하는 모델을 편리하게 지원하는 기능 제공
    • ResourceLoader(편리한 리소스 조회) : 파일, 클래스패스, 외부 등에서 리소스를 편리하게 조회하는 기능 제공

 

💡 정리

• ApplicationContext는 BeanFactory의 기능을 상속받는다.
• ApplicationContext는 빈 관리 기능 + 편리한 부가 기능을 제공한다.
• 부가기능이 포함된 ApplicationContext를 사용한다. (BeanFactory를 직접 사용할 일은 거의 없음)
• BeanFactory나 ApplicationContext를 스프링 컨테이너라 한다.

 

다양한 설정 형식 지원

스프링 컨테이너는 다양한 형식의 설정 정보를 받아드릴 수 있도록 유연하게 설계되어 있다.

• 자바 코드, XML, Groovy 등

 

애노테이션 기반 자바 코드 설정 사용

• AnnotationConfigApplicationContext를 사용하면서 자바 코드로된 설정 정보를 넘긴다.

 ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class)

 

XML 설정 사용

최근에는 xml로 Bean을 설정하지 않지만, 과거 프로젝트들은 xml로 존재하는 경우가 있기 때문에 간단하게만 알고 넘어가자.

• GenericXmlApplicationContext를 사용하면서 xml 설정 파일을 넘긴다.

📁 test/xml/XmlAppContext

public class XmlAppContext {

    @Test
    void xmlAppContext() {
        ApplicationContext ac = new GenericXmlApplicationContext("appConfig.xml");
        MemberService memberService = ac.getBean("memberService", MemberService.class);
        assertThat(memberService).isInstanceOf(MemberService.class);
    }
}

📁 resources/appConfig.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">

    <bean id="memberService" class="hello.core.member.MemberServiceImpl">
        <constructor-arg name="memberRepository" ref="memberRepository" />
    </bean>

    <bean id="memberRepository"
          class="hello.core.member.MemoryMemberRepository" />

    <bean id="orderService" class="hello.core.order.OrderServiceImpl">
        <constructor-arg name="memberRepository" ref="memberRepository" />
        <constructor-arg name="discountPolicy" ref="discountPolicy" />
    </bean>

    <bean id="discountPolicy" class="hello.core.discount.RateDiscountPolicy" />
</beans>

• Bean 태그에 이름을 고유의 id값으로 지정하고, class명을 넣어서 설정해준다.
• xml 기반의 appConfig.xml 설정 정보와 자바 코드로 된 AppConfig.java 설정 정보를 비교해보면 거의 비슷하다.
• 하지만 xml 기반의 GenericXmlApplicationContext보다, 자바 코드 기반의 AnnotationConfigApplicationContext가 더 많은 기능을 제공하고 최신화되어 있기때문에 요즘 xml 기반의 설정은 잘 사용하지 않는다.
• xml 사용이나 추가적인 정보가 필요하면 스프링 공식 레퍼런스 문서를 참조하자.

 

 

스프링 빈 설정 메타 정보 - BeanDefinition

---

스프링 빈을 등록하는 방식이 어떻게 이렇게 많은 형식(자바 코드, xml...)으로 확장 가능한지 간단하게 알아보자.

실무에서 BeanDefinition을 직접 정의하거나 사용할 일은 거의 없기 때문에, 스프링이 다양한 형태의 설정 정보를 BeanDefinition으로 추상화해 사용한다는 것만 이해하고 넘어가도 좋다.

• 스프링이 다양한 설정 형식을 지원할 수 있는 것은 BeanDefinition이라는 추상체 때문이다.
• 형식이 JAVA든, XML이든 설정 정보를 읽어서 BeanDefinition 객체를 만든다.
  → 스프링 컨테이너는 JAVA인지, XML인지 몰라도 된다. 오직 BeanDefinition만 알면 된다.
• 이러한 BeanDefinition을 스프링 빈 설정 메타정보라 한다.
  • @Bean, <bean> 당 각각 하나씩 메타 정보가 생성
• 스프링 컨테이너는 이 메타정보를 기반으로 스프링 빈을 생성한다.

스프링 컨테이너는 인터페이스인 BeanDefinition에만 의존

 

👉🏻 BeanDefinition 확인 테스트 

📁 test/beandefinition/BeanDefinitionTest

public class BeanDefinitionTest {

    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

    @Test
    @DisplayName("빈 설정 메타정보 확인")
    void findApplicationBean() {
        String[] beanDefinitionNames = ac.getBeanDefinitionNames();
        for (String beanDefinitionName : beanDefinitionNames) {
            BeanDefinition beanDefinition = ac.getBeanDefinition(beanDefinitionName);

            if (beanDefinition.getRole() == BeanDefinition.ROLE_APPLICATION) {
                System.out.println("beanDefinitionName = " + beanDefinitionName + " beanDefinition = " + beanDefinition );
            }
        }
    }
}

 

💡 BeanDefinition 정보

• BeanClassName : 생성할 빈의 클래스 명
• factoryBeanName : 팩토리 역할의 빈을 사용할 경우 이름, 예) appConfig
• factoryMethodName : 빈을 생성할 팩토리 메소드 지정, 예) memberService
• Scope : 싱글톤(기본값)
• lazyInit : 스프링 컨테이너를 생성할 때 빈을 생성하는 것이 아니라, 실제 빈을 사용할 때 까지  최대한 생성을 지연처리 하는지 여부
• InitMethodName : 빈을 생성하고, 의존관계를 적용한 뒤에 호출되는 초기화 메소드 명
• DestroyMethodName : 빈의 생명주기가 끝나서 제거하기 직전에 호출되는 메소드 명
• Constructor arguments, Properties : 의존관계 주입에서 사용 (자바 설정처럼 팩토리 역할의 빈을 사용하면 없음)