(스프링 기본) 4. 스프링 컨테이너와 스프링 빈

 

이 글은 김영한 님의 스프링 핵심 원리 - 기본편 강좌 수강 후 정리한 글입니다.

https://www.inflearn.com/course/스프링-핵심-원리-기본편/dashboard

스프링 핵심 원리 - 기본편 - 인프런 | 강의

 

스프링 컨테이너 생성

스프링 컨테이너가 생성되는 과정을 알아보겠다.

ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

 

ApplicationContext를 스프링 컨테이너라 한다. ApplicationContext는 인터페이스이다.
스프링 컨테이너는 XML을 기반으로 만들 수 있고, 애노테이션 기반의 자바 설정 클래스로 만들 수 있다.

스프링 부트는 애노테이션에 특화되어 있어서 XML 기반의 방식은 잘 사용하지 않는다.
이전에 AppConfig를 사용했던 방식이 애노테이션 기반의 자바 설정 클래스로 스프링 컨테이너를 만든 것이다.

 

new AnnotationConfigApplicationContext(AppConfig.class) : 이 클래스는 ApplicationContext 인터페이스의 구현체이다.

 

※ 더 정확히는 스프링 컨테이너를 부를 때 BeanFactory , ApplicationContext로 구분해서 이야기한다. BeanFactory를 직접 사용하는 경우는 거의 없으므로 일반적으로 ApplicationContext를 스프링 컨테이너라 한다.

 

1. 스프링 컨테이너 생성

 

new AnnotationConfigApplicationContext(AppConfig.class) 코드를 통해서 스프링 컨테이너를 생성한다.

스프링 컨테이너를 생성할 땐 구성 정보를 명시해줘야 하며, 여기서의 구성 정보는 AppConfig.class이다.

 

2. 스프링 빈 등록

 

스프링 컨테이너는 파라미터로 넘어온 설정 클래스(AppConfig.class) 정보를 사용해서 스프링 빈들을 등록한다.

스프링 빈의 이름은 보통 메소드의 이름을 사용한다. 하지만 @Bean(name=" ") 같은 방식으로 이름을 직접 부여할 수도 있다. 하지만 빈 이름이 중복되면 기존 빈을 덮어버리거나 오류가 발생하기 때문에 빈 이름은 항상 달라야 한다.

 

3. 스프링 빈 의존관계 설정 - 준비

스프링 빈 간의 의존관계를 설정하기 전에 먼저 스프링 컨테이너에 @Bean을 사용하여 스프링 빈들을 등록한다.

 

4. 스프링 빈 의존관계 설정 - 완료

 

스프링 컨테이너는 설정 정보를 참고해서 의존관계를 주입(DI)한다.
단순히 자바 코드를 호출하는 것 같지만, 차이가 있다. 이 차이는 추후 싱글톤 컨테이너에서 설명하겠다.

 

※ 스프링은 빈을 생성하고, 의존관계를 주입하는 단계가 나누어져 있다. 그런데 이렇게 자바 코드로 스프링 빈을 등록하면 생성자를 호출하면서 의존관계 주입도 한 번에 처리된다. 여기서는 이해를 돕기 위해 개념적으로 나누어 설명했다. 자세한 내용은 의존관계 자동 주입에서 설명하겠다.

 

5. 정리

스프링 컨테이너를 생성하고, 설정 정보를 참고하여 스프링 빈을 스프링 컨테이너에 등록했다.

그러고 나서 스프링 빈들 간의 의존 관계도 설정하였다.

 

스프링 컨테이너 생성

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

package hello.core.beanfind;

import hello.core.AppConfig;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

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);
            }
        }
    }
}

 

1. 모든 빈 출력하기

스프링에 등록된 모든 빈 정보를 출력할 수 있다.

ac.getBeanDefinitionNames() : 스프링에 등록된 모든 빈 이름을 조회한다.

ac.getBean() : 빈 이름들로 빈 객체(인스턴스)를 조회한다.

 

2. 애플리케이션 빈 출력하기

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

 

스프링 빈 조회 - 기본

package hello.core.beanfind;

import hello.core.AppConfig;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

import static org.assertj.core.api.Assertions.*;
import static org.junit.jupiter.api.Assertions.*;

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

    @Test
    @DisplayName("빈 이름으로 조회")
    void findBeanByName() {
        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 findBeanByNameX() {
        //ac.getBean("xxxx",MemberService.class);
        assertThrows(NoSuchBeanDefinitionException.class,
                ()-> ac.getBean("xxxx", MemberServiceImpl.class));
    }
}

 

 

스프링 컨테이너에서 스프링 빈을 찾는 가장 기본적인 조회 방법

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

조회 대상 스프링 빈이 없으면 예외 발생 ex) NoSuchBeanDefinitionException: No bean named 'xxxxx' available

 

※ 구현체 타입으로 조회를 하게 되면 구현에 의존하기 때문에 역할에 의존할 때보다 변경 시에 유연성이 떨어지게 된다.

 

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

package hello.core.beanfind;

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.beans.factory.NoSuchBeanDefinitionException;
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 ApplicationContextSameBeanFindTest {
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SameBeanConfig.class);

    @Test
    @DisplayName("타입으로 조회시 같은 타입이 둘 이상 있으면 중복 오류가 발생한다.")
    void findBeanByTypeDuplicate(){
        assertThrows(NoSuchBeanDefinitionException.class,
                ()-> ac.getBean("xxxx", 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));
        }
        System.out.println("beansOfType = " + beansOfType);
        assertThat(beansOfType.size()).isEqualTo(2);
    }

    @Configuration
    static class SameBeanConfig {

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

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

 

타입으로 조회할 때 같은 타입의 스프링 빈이 둘 이상이면 NoUniqueBeanDefinitionException 예외가 발생한다.

이를 방지하기 위해 스프링 빈을 조회할 때 빈 이름도 지정해주면 된다.

ac.getBeansTypeof()을 사용하면 해당 타입의 모든 빈을 조회할 수 있다.

 

스프링 빈 조회 - 상속 관계

package hello.core.beanfind;

import hello.core.discount.DiscountPolicy;
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.*;
import static org.junit.jupiter.api.Assertions.*;

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 findBeansByParentType(){
        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 FixDiscountPolicy fixDiscountPolicy(){
            return new FixDiscountPolicy();
        }
    }
}

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

그렇기 때문에 모든 자바 객체의 부모인 Object 타입으로 조회를 하게 되면, 모든 스프링 빈을 조회하게 된다.

 

BeanFactory와 ApplicationContext

 

● BeanFactory

스프링 컨테이너의 최상위 인터페이스로써 스프링 빈을 관리하고 조회하는 역할을 담당한다.

getBean()과 같은 지금까지 사용한 기본적인 기능을 제공한다.

 

● ApplicationContext

BeanFactory의 모든 기능을 상속받아서 제공한다. BeanFactory가 제공하는 빈을 관리하고 조회해주는 기능뿐만 아니라 애플리케이션의 개발에 필요한 수많은 부가 기능들을 제공한다.

 

● ApplicationContext가 제공하는 부가기능

 

1. MessageSource

메시지 소스를 활용한 국제화 기능을 제공한다. 한국에서 접속하면 한국어로, 영어권에서 접속하면 영어로 출력하게끔 국제화 관련 기능을 제공한다.

 

2. EnvironmentCapable

로컬, 개발, 운영 등을 구분해서 처리할 수 있는 환경변수 기능을 제공한다.

 

3. ApplicationEventPublisher

애플리케이션 이벤트를 발행하고 구독하는 모델을 편리하게 제공한다.

 

4. ResourceLoader

파일, 클래스 패스, 외부 등에서 리소스를 편리하게 조회하는 기능을 제공한다.

 

● 정리

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

 

다양한 설정 형식 지원 - 자바 코드, XML

스프링 컨테이너는 자바 코드뿐만 아니라 XML, Groovy 등 다양한 형식의 설정 정보를 받아들일 수 있게 유연하게 설계되어 있다.

 

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

지금까지 해왔던 것이다.

new AnnotationConfigApplicationContext(AppConfig.class);

 

위 예시처럼 AnnotationConfigApplicationContext 클래스를 사용하면서 자바 코드로 된 설정 정보(AppConfig.class)를 넘겨주면 된다. 

 

● XML 설정 사용

최근 스프링 부트가 많이 사용되면서 XML 기반의 설정은 잘 사용하지 않는다. 하지만 아직 많은 레거시 프로젝트들은 XML로 되어있고, 또 XML을 사용하면 컴파일 없이 빈 설정 정보를 변경할 수 있는 장점도 있다.

※ 레거시 프로젝트는 과거에 개발되어 현재에도 영향을 끼치며 사용 중인 오래된 프로젝트를 의미한다.

 

1. XmlAppConfig 사용 자바 코드

package hello.core.xml;

import hello.core.member.MemberService;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.GenericXmlApplicationContext;

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

 

GenericXmlApplicationContext를 사용하면서 xml 설정 파일(appConfig.xml)을 넘기면 된다.

 

2. 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>

 

xml 기반의 appConfig.xml와 자바 코드로 이루어진 AppConfig.java의 설정 정보를 비교해보면 거의 비슷함을 알 수 있다.

xml 기반의 설정을 자세히 알고 싶다면 공식 레퍼런스 문서를 확인하자. (https://spring.io/projects/spring-framework)

Spring Framework

 

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

위에서 말했듯 스프링은 다양한 설정 형식을 지원한다. 이는 BeanDefinition이라는 추상화 덕분이다.

역할과 구현을 개념적으로 나누는 추상화가 있어 가능한 것이다.

XML을 읽었던, 자바 코드를 읽었던 BeanDefinition을 만들면 된다. 스프링 코드는 무엇을 읽었던 상관없이 BeanDefinition만 알면 된다.

BeanDefinition을 빈 설정 메타 정보라고 하며, @Bean(XML에서 <bean>) 각각 하나씩 메타 정보가 생성된다.

그리고 스프링 컨테이너는 이 메타 정보를 기반으로 스프링 빈을 생성한다.

 

AnnotationConfigApplicationContext는 AnnotatedBeanDefinitionReader를 사용해서 AppConfig.class를 읽고 BeanDefinition을 생성한다.
GenericXmlApplicationContext는 XmlBeanDefinitionReader를 사용해서 appConfig.xml 설정 정보를 읽고 BeanDefinition을 생성한다.
새로운 형식의 설정 정보가 추가되면, XxxBeanDefinitionReader를 만들어서 BeanDefinition을 생성하면 된다.

 

● BeanDefinition 살펴보기

 

1. BeanDefinition 정보

BeanDefinition의 정보들은 다음과 같다.

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

package hello.core.beandefinition;

import hello.core.AppConfig;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
//import org.springframework.context.support.GenericXmlApplicationContext;

public class BeanDefinitionTest {
   AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
//    GenericXmlApplicationContext ac = new GenericXmlApplicationContext("appConfig.xml");
   @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);
           }
       }
   }
}

 

위의 예시에서 ApplicationContext가 아닌 구체화된 AnnotationConfigApplicationContext나 GenericXmlApplicationContext를 사용한 이유는 getBeanDefinition 메소드는 복잡하고 잘 사용하지 않는 기능이라 ApplicationContext에 존재하지 않기 때문이다.

 

● 정리

BeanDefinition을 직접 생성해서 스프링 컨테이너에 등록할 수 도 있다. 하지만 실무에서 BeanDefinition을 직접 정의하거나 사용할 일은 거의 없다.
BeanDefinition에 대해서는 너무 깊이 있게 이해하기보다는, 스프링이 다양한 형태의 설정 정보를 BeanDefinition으로 추상화해서 사용하는 것 정도만 이해하면 된다.
가끔 스프링 코드나 스프링 관련 오픈 소스의 코드를 볼 때, BeanDefinition이라는 것이 보일 때가 있다. 이때 이러한 메커니즘을 떠올리면 된다.