[Spring] 스프링 컨테이너와 스프링 빈

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

2022. 1. 10.

---

# 스프링 컨테이너 생성

- ApplicationContext 를 스프링 컨테이너라고 한다.

- ApplicationContext 는 Interface 이다.

- 스프링 컨테이너는 XML 을 기반으로 만들 수 있고 애노테이션 기반의 자바 설정 클래스로 만들 수 있다.

new AnnotationConfigApplicationContext(AppConfig.class);

- 위 클래스는 ApplicationContext 인터페이스의 구현체이다.

- 스프링 컨테이너를 부를 때 BeanFactory, ApplicationContext 로 구분해서 부르지만 BeanFactory 를 직접 사용하는 경우가 없고 일반적으로 ApplicationContext 를 스프링 컨테이너라고 한다는 것을 알아두자.

 

- 스프링 컨테이너의 생성 과정은 아래와 같다.

(1) 스프링 컨테이너 생성

: new AnnotationConfigApplicationContext(AppConfig.class); 와 같이 AppConfig.class 를 구성 정보로 스프링 컨테이너를 생성하면 스프링 컨테이너는 구성 정보를 활용하여,

(2) 스프링 빈 등록

: 스프링 컨테이너 내부의 스프링 빈 저장소를 채운다. 파라미터로 넘어온 설정 클래스의 정보를 사용하여 스프링 빈을 등록한다. 빈 이름은 메서드 이름을 사용하며, @Bean(name="memberService2") 와 같이 직접  부여할 수 도 있다. 하지만 빈 이름이 중복되어서는 안된다. 

(3) 스프링 빈 의존관계 설정

: 스프링 컨테이너는 설정 정보를 참고하여 의존관계를 주입(DI) 한다. 스프링은 빈을 생성하고 주입하는 단계가 구분된다. 자바 코드를 이용하여 스프링 빈을 등록하면 생성자를 호출하면서 의존관계 주입 또한 한번에 처리된다.

 

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

아래 코드를 실행하면 스프링에 등록된 모든 빈 정보를 조회할 수 있다.

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

만약 스프링 빈의 Role 에 따라 출력하고자 한다면 getRole() 메서드를 이용한다.  ROLE_APPLICATION 은 일반적으로 사용자가 정의한 빈이고 ROLE_INFRASTRUCTURE 은 스프링이 내부에서 사용하는 빈이다.

    @Test
    @DisplayName("애플리케이션 빈 출력하기")
    void findApplicationBean(){
        String[] beanDefinitionNames = ac.getBeanDefinitionNames();
        System.out.println("애플리케이션 빈 출력하기");
        for (String beanDefinitionName : beanDefinitionNames) {
            BeanDefinition beanDefinition = ac.getBeanDefinition(beanDefinitionName);
            if(beanDefinition.getRole()==BeanDefinition.ROLE_APPLICATION){
                // ROLE_APPLICATION : 직접 등록한 애플리케이션 빈
                // ROLE_INFRASTRUCTURE : 스프링이 내부에서 사용하는 빈
                Object bean = ac.getBean(beanDefinitionName);
                System.out.println("name = " + beanDefinitionName + "object = " + bean);
            }
        }

 

스프링 컨테이너에서 스프링 빈을 조회할 때 아래와 같이 해주면 된다.

-  ac.getBean(BeanName, Type)

-  ac.getBean(Type)

만약 조회 대상인 스프링 빈이 존재하지 않으면 아래의 예외가 발생된다.

- NoSuchBeanDefinitionException: No bean named 'xx' available

 

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);
    }
    @Test
    @DisplayName("이름 없이 타입으로만 조회")
    void findBeanByType(){
        MemberService memberService = ac.getBean( MemberService.class);
        assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
    }

    @Test
    @DisplayName("구체 타입으로 조회")
    // 구체 타입으로 조회하는 것은 별로 좋지 않다. 유연성이 저하되기 때문이다.
    void findBeanByName2(){
        MemberService memberService = ac.getBean("memberService", MemberServiceImpl.class);
        assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
    }

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

 

스프링 빈을 조회할 때, 동일한 타입이 두 개 이상인 경우에는 어떻게 해야할까?

- 빈 이름을 지정해주면 된다.

- 필요 시 ac.getBeansOfType() 를 사용하면 해당하는 type 의 모든 빈을 조회할 수 있다.

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.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.assertThrows;

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));
        }
        System.out.println("beansOfType = " + beansOfType);
        assertThat(beansOfType.size()).isEqualTo(2);
    }
    @Configuration
    static class SameBeanConfig {
        // staic : ApplicationContextSameBeanFindTest class 안에서만 사용하도록 scope 설정
        @Bean
        public MemberRepository memberRepository1() {
            return new MemoryMemberRepository();
        }

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

    }
}

 

스프링 빈 조회 - 상속 관계

- 부모 타입으로 조회 시 자식 타입이 함께 조회된다.

- 그래서 Object 으로 조회하면 모든 스프링 빈을 다 조회하게 되는 것.

 

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.ApplicationContext;
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.AssertionsForClassTypes.assertThat;
import static org.junit.jupiter.api.Assertions.assertThrows;

public class ApplicationContextExtendsFindTest {
    ApplicationContext 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();
        }
    }
}

 

# BeanFactory 와 ApplicationContext

* BeanFactory

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

- 스프링 빈을 관리/조회

- getBean() 을 제공

 

* ApplicationContext

- BeanFactory 의 기능을 모두 상속받아서 제공

- 애플리케이션을 개발할 때에는 빈을 관리/조회하는 기능 외에 수 많은 부가 기능이 필요하다. ApplicationContext 는 BeanFactory 뿐만이 아니라 MessageSource(국제화 기능; 한국에서 접속 시 한국어로, 영어권에서 접속 시 영어로 출력), EnvironmentCapable(환경 변수; 로컬 개발, 운영 등을 구분하여 처리), ApplicationEventPublisher(이벤트를 발행하고 구독하는 모델을 지원), ResourceLoader(파일, 클래스패스, 외부 등에서 리소스를 편리하게 조회 가능) 의 기능을 상속받는다.

 

즉, ApplicationContext 는 BeanFactory 의 기능을 상속받으며 빈 관리기능 + 편리한 부가기능을 제공한다. BeanFactory 를 직접 사용할 경우는 거의 없으며, 일반적으로 여러 부가 기능이 포함된 ApplicationContext 를 사용한다. BeanFactory 나 ApplicationContext 를 스프링 컨테이너라고 한다.

 

# 자바 코드와 XML

스프링 컨테이너는 다양한 설정 형식을 지원한다. (JAVA, XML, Groovy)

* Annotation 기반 JAVA 코드 설정 사용

- new AnnotationConfigApplicationContext(AppConfig.class)

- AnnotationConfigApplicationContext 클래스를 사용하여 자바 코드로 된 설정 정보를 넘기면 된다.

 

* XML 설정 사용

- 최근에는 스프링 부트를 많이 사용하면서 XML 기반의 설정을 잘 사용하지 않음. 아직 많은 레거시 프로젝트들이 XML 이 되어있기도 하고, XML 을 사용하면 컴파일 과정 없이 bean 설정 정보를 변경할 수 있다는 장점이 있기에 가볍게 알아두는 것을 권장한다고 한다.

- GenericXmlApplicationContext 를 사용하면서 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>

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

 

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

- 스프링이 다양한 설정 형식을 지원할 수 있는 이유는 BeanDefinition 이라는 추상화 개념이 있기 떄문이다.

- Spring bean 을 만들 때에는 두 가지 방법이 있다. 직접적으로 Spring bean 을 등록하거나, factoryBean 을 이용하여 등록하거나! 일반적으로 자바 코드를 이용해서 하는 것은 factoryBean 을 이용하여 등록하는 것이다.

- 역할과 구현을 개념적으로 내눈 것!

- XML 이면 XML 읽어서 BeanDefinition 을 만들면 됨.

- JAVA 코드 이면 JAVA 코드 읽어서 BeanDefinition 을 만들면 됨.

- 스프링 컨테이너는 자바 코드인지 XML 인지 몰라도 된다. 오직 BeanDefinition 만 알면 됨!

- 이러한 BeanDefinition 을 빈 설정 메타 정보라고 한다.

- '@Bean' , '<bean>' 당 각각 하나의 메타 정보가 생성됨.

- 스프링 컨테이너는 이러한 메타 정보를 기반으로 스프링 빈을 생성함.

- AnnotationConfigApplicationContext 는 AnnotatedBeanDefinitionReader 를 사용하여 AppConfig.class 를 읽고 BeanDefinition 을 생성

- GenericXmlApplicationContext 는 XmlBeanDefinitionReader 를 사용해서 appConfig.xml 설정 정보를 읽고 BeanDefinition 을 생성

- 새로운 형식의 설정 정보가 추가되면, XxxBeanDefinitionReader 를 만들어서 BeanDefinition 을 생성하면 되는 식!

 

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("beanDefinition name = " + beanDefinitionName + " beanDefinition = " + beanDefinition);
            }
        }
    }
}

// AnnotationConfigApplicationContext
beanDefinition name = appConfig beanDefinition = Generic bean: class [hello.core.AppConfig$$EnhancerBySpringCGLIB$$e7bee251]; scope=singleton; abstract=false; lazyInit=null; autowireMode=0; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=null; factoryMethodName=null; initMethodName=null; destroyMethodName=null
beanDefinition name = memberService beanDefinition = Root bean: class [null]; scope=; abstract=false; lazyInit=null; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=appConfig; factoryMethodName=memberService; initMethodName=null; destroyMethodName=(inferred); defined in hello.core.AppConfig
beanDefinition name = memberRepository beanDefinition = Root bean: class [null]; scope=; abstract=false; lazyInit=null; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=appConfig; factoryMethodName=memberRepository; initMethodName=null; destroyMethodName=(inferred); defined in hello.core.AppConfig
beanDefinition name = orderService beanDefinition = Root bean: class [null]; scope=; abstract=false; lazyInit=null; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=appConfig; factoryMethodName=orderService; initMethodName=null; destroyMethodName=(inferred); defined in hello.core.AppConfig
beanDefinition name = discountPolicy beanDefinition = Root bean: class [null]; scope=; abstract=false; lazyInit=null; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=appConfig; factoryMethodName=discountPolicy; initMethodName=null; destroyMethodName=(inferred); defined in hello.core.AppConfig

Process finished with exit code 0

// XML
beanDefinition name = memberService beanDefinition = Generic bean: class [hello.core.member.MemberServiceImpl]; scope=; abstract=false; lazyInit=false; autowireMode=0; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=null; factoryMethodName=null; initMethodName=null; destroyMethodName=null; defined in class path resource [appConfig.xml]
beanDefinition name = memberRepository beanDefinition = Generic bean: class [hello.core.member.MemoryMemberRepository]; scope=; abstract=false; lazyInit=false; autowireMode=0; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=null; factoryMethodName=null; initMethodName=null; destroyMethodName=null; defined in class path resource [appConfig.xml]
beanDefinition name = orderService beanDefinition = Generic bean: class [hello.core.order.OrderServiceImpl]; scope=; abstract=false; lazyInit=false; autowireMode=0; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=null; factoryMethodName=null; initMethodName=null; destroyMethodName=null; defined in class path resource [appConfig.xml]
beanDefinition name = discountPolicy beanDefinition = Generic bean: class [hello.core.discount.RateDiscountPolicy]; scope=; abstract=false; lazyInit=false; autowireMode=0; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=null; factoryMethodName=null; initMethodName=null; destroyMethodName=null; defined in class path resource [appConfig.xml]

Process finished with exit code 0

- BeanClassName : 생성할 빈의 클래스 명(java 설정 처럼 팩토리 역할의 빈을 사용하는 경우에는 없음)

- factoryBeanName : 팩토리 역할의 빈을 사용한 경우 이름 (예: appConfig)

- factoryMethodName : 빈을 생성할 팩토리 메서드 지정 (예: memberService)

- Scope : 싱글톤(default)

- lazyInit : 스프링 컨테이너를 생성할 때, 빈을 생성하는 것이 아니라 실제 빈을 사용할 때 까지 최대한 생성을 지연처리 하는 지 여부

- InitMethodName : 빈을 생성하고, 의존관계를 적용한 뒤에 호출되는 초기화 메서드 명

- DestroyMethodName : 빈의 생명주기가 끝나서 제거하기 이전에 호출되는 메서드 명

- Constructor arguments, Properties : 의존관계 주입에서 사용함. (자바 설정처럼 팩토리 역할의 빈을 사용 시에는 없음)

 

 

" BeanDefinition 을 직접 생성해서 스프링 컨테이너에 등록할 수도 있지만 실무에서 그러한 경우는 거의 없다고 한다. BeanDefinition 에 대해서는 스프링이 다양한 형태의 설정 정보를 BeanDefinition 으로 추상화해서 사용하는 것을 기억하자. "

 

 

---

 

Reference

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8

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