[Spring] 스프링 컨테이너(Spring Container)

※ 본문은 인프런 김영한님의 스프링 강의를 바탕으로 학습한 내용을 기록한 글입니다.

오개념이 있다면 댓글로 알려주세요!

 

 

[ 1 ] 스프링 컨테이너란?

스프링 컨테이너는 애노테이션 기반의 자바 설정 클래스(@Configuration)나 XML을 기반으로 만들어지며 스프링 빈을 등록, 관리, 조회하는 기능을 제공한다.

 

스프링 컨테이너는 ApplicationContext 인터페이스로 만들 수 있으며 애노테이션 기반의 자바 설정 클래스를 사용한다면 AnnotationConfigApplicationContext 구현 클래스를, XML 기반이라면 GenericXmlApplicationContext 구현 클래스를 사용하면 된다.

 

※ 최근에는 XML 보다 스프링부트를 사용하여 애노테이션 기반의 자바 설정 클래스를 주로 사용한다.

 

 

---

[ 2 ] 자바 설정 클래스를 기반으로 스프링 컨테이너를 만드는 과정

(1) 스프링 설정 클래스(AppConfig라고 가정)에 @Configuration 애노테이션을 설정한다. 해당 클래스는 구성 정보이다.

(2) 스프링 빈으로 등록할 메서드에 @Bean 애노테이션을 설정한다.

(3) new AnnotationConfigApplicationContext(AppConfig.class); 로 스프링 컨테이너 객체를 생성한다.

(4) 스프링 컨테이너는 구성 정보(AppConfig)에 @Bean이 붙은 메서드를 모두 호출하여 생성된 객체를 스프링 컨테이너의 내부 스프링 빈 저장소에 저장한다.

(5) 스프링 빈 객체를 등록한 후 스프링 컨테이너는 설정 정보(AppConfig)를 참고하여 의존관계를 주입(DI)한다.

 

 

※ 사실 자바 설정 클래스로 스프링 빈을 등록하면 생성자를 호출하면서 의존관계 주입도 한번에 처리된다. 해당 과정을 더 쉽게 이해하기 위해 '(4)스프링 빈 객체 등록 → (5)DI'를 두 단계로 나누었다.

※ 빈 이름은 메서드 이름이다. @Bean(name="name")으로 빈 이름을 직접 부여할 수도 있다.

※ 빈 이름은 항상 다른 이름을 부여해야 한다.

 

 

---

[ 3 ] Test로 스프링 컨테이너의 빈 조회하기

실제로 스프링 컨테이너에 빈이 등록되었는지 조회해보자.

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

    }

}

해당 코드를 통해 스프링 컨테이너에 등록된 빈을 조회할 수 있다.

 

하지만, 해당 코드는 스프링이 내부에서 사용하는 빈까지 모두 조회하기 때문에 직접 등록한 빈만 조회하려면 조건문을 추가해야 한다.

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

}

주석에 적힌 것처럼 BeanDefinition.ROLE_APPLICATION은 직접 등록한 애플리케이션 빈을 의미한다. 위 코드처럼 조건문을 추가하면 내가 직접 등록한 빈만 조회할 수 있다.

 

※ 비교 대상을 BeanDefinition.INFRASTRUCTURE로 변경하면 스프링이 내부에서 사용하는 빈만 조회할 수 있다.

 

 

---

[ 4 ] getBean() 으로 조회하기

간단하게 ac.getBean(빈 이름, 타입); 혹은 ac.getBean(타입); 으로 빈을 조회할 수 있다.

조회 대상 스프링 빈이 스프링 컨테이너에 없으면 예외(NoSuchBeanDefinitionException)가 발생한다.

 

(1) ac.getBean(빈 이름, 타입); 테스트 

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

public class ApplicationContextBeanFindTest {

    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

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

 

(2) NoSuchBeanDefinitionException 테스트

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

public class ApplicationContextBeanFindTest {

    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

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

}

 

※ assertThat은 assertj.core.api.Assertions 라이브러리의 메서드이고, assertThrows는 junit.jupiter.api.Assertions 라이브러리의 메서드이다.

 

(3) ac.getBean(타입); 테스트

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

public class ApplicationContextBeanFindTest {

    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

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

}

단, 타입으로 조회 시 같은 타입의 빈이 둘 이상 존재한다면 NoUniqueBeanDefinitionException이 발생한다. 그러므로 같은 타입의 빈이 둘 이상 존재한다면 ac.getBean(빈 이름, 타입); 으로 조회하자.

 

 

(4) 특정 타입을 모두 조회하기

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

public class ApplicationContextSameBeanFindTest {

    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SameBeanConfig.class);

    @Test
    @DisplayName("특정 타입을 모두 조회하기")
    void findAllBeansByType() {
        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();
        }

    }

}

 

(5) 상속관계에서의 스프링 빈 조회

부모 타입으로 스프링 빈을 조회하면 자식 타입도 함께 조회한다. 즉, 모든 자바 객체의 최고 부모인 Object를 조회하면, 모든 스프링 빈을 조회한다. 그러므로 부모 타입으로 조회 시 자식이 둘 이상이라면 ac.getBean(빈 이름, 타입); 으로 조회하자.

 

물론 특정 하위 타입으로 조회할 수도 있으나 좋지 않은 방법이므로 지양하자.

 

 

---

[ 5 ] BeanFactory와 ApplicationContext

스프링 컨테이너를 부를 때 'BeanFactory'와 'ApplicationContext'를 구분한다. 하지만, BeanFactory를 직접 사용하는 경우는 거의 없으므로 일반적으로 ApplicationContext를 스프링 컨테이너라고 한다.

 

(1) BeanFactory

 - 스프링 컨테이너의 최상위 인터페이스이다.

 - 스프링 빈을 관리하고 조회하는 역할을 담당한다. 즉, getBean() 등의 메서드를 제공한다.

 

(2) ApplicationContext

 - BeanFactory 인터페이스를 상속받는 인터페이스이다.

 - 여러 부가 기능이 추가되었다는 점에서 BeanFactory와 차이를 보인다.

public interface ApplicationContext extends EnvironmentCapable, ListableBeanFactory, HierarchicalBeanFactory,
		MessageSource, ApplicationEventPublisher, ResourcePatternResolver {}

 - 위 코드에서 알 수 있듯이 ApplicationContext 인터페이스는 BeanFactory 외 여러 인터페이스를 상속 받는다.

 - 다음은 상속받고 있는 대표적인 인터페이스이다.

 

①  MessageSource : 메시지소스를 활용한 국제화 기능 제공 (한국에서는 한국어, 영어권에서는 영어로 웹 페이지 출력 등)

② EnvironmentCapable : 로컬, 개발, 운영 환경을 구분해서 처리하는 기능 제공

③ ApplicationEventPublisher : 이벤트를 발행하고 구독하는 모델 지원

④ ResourceLoader : 파일, 클래스패스, 외부 등의 리소스를 편리하게 조회

 

즉, BeanFactory와 ApplicationContext 모두 스프링 컨테이너이지만, ApplicationContext는 BeanFactory의 스프링 빈 관리 및 조회 기능을 상속 받을 뿐만 아니라 다른 부가 기능도 상속 받아 제공한다는 차이가 있다. 그러므로 편리한 부가 기능을 제공하는  ApplicationContext를 주로 사용한다.

 

 

---

[ 6 ] BeanDefinition

스프링 컨테이너가 자바 설정 클래스가 오든, xml이 오든 유연하게 스프링 빈을 관리하고 조회할 수 있는 이유는 BeanDefinition이라는 빈 설정 메타정보가 존재하기 때문이다. 스프링 컨테이너는 BeanDefinition를 바탕으로 스프링 빈을 생성하는데, AnnotationConfigApplicationContext는 각  @Bean 당 하나의 BeanDefinition를, GenericXmlApplicationContext은 각 <bean> 당 하나의 BeanDefinition를 생성한다.

 

즉, BeanDefinition이라는 역할 인터페이스를 정의하고, AnnotationConfigApplicationContext과 GenericXmlApplicationContext이 BeanDefinition을 생성할 수 있도록 구현한 것이다.

 

이를 통해 스프링 컨테이너는 설정 정보가 자바 클래스인지 xml인지 알 필요가 없고, 오직 BeanDefinition만 얻으면 스프링 빈을 생성하고 관리할 수 있다.