Spring/Spring 핵심 원리

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

진이최고다 2023. 8. 15. 22:02

이전 예제

스프링 핵심원리 기본편 - 회원,주문 도메인 설계

스프링 컨테이너 생성

스프링 컨테이너가 생성되는 과정

ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);
  • ApplicationContext : 스프링 컨테이너의 인터페이스로, 애플리케이션의 빈 설정과 라이프사이클을 관리한다.
  • 스프링 컨테이너는 XML을 기반으로 만들 수 있고, 애노테이션 기반의 자바 설정 클래스로 만들 수 있다.
  • AnnotationConfigApplicationContext : "ApplicationContext" 인터페이스의 구현체 중 하나로, 애노테이션 기반의 자바 설정 클래스를 처리한다.

 

BeamFactory와 ApplicationContext

스프링에서는 스프링 컨테이너를 나타내는 두 가지 주요 인터페이스로 대부분 "ApplicationContext" 를 일반적으로 스프링 컨테이너라 말하며, Beanfactory 는 기본적인 빈 설정 기능만을 제공하는 반면, ApplicationContext 는 더 많은 고급 기능을 제공한다.

 

스프링 컨테이너의 생성 과정

스프링 컨테이너 생성

  • new AnnotationConfigApplicationContext(AppConfig.class)
  • 스프링 컨테이너를 생성할 때는 구성 정보를 지정해주어야 한다.
스프링 빈 등록

AppConfig.class

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

 

빈 이름

  • 빈 이름은 메서드 이름을 사용한다, 빈 이름을 직접 부여할 수 있지만, 디폴트값으로 사용한다.
  • @Bean(name="memberService")
빈 이름은 항상 다른 이름을 부여해야 하며, 같은 이름을 부여하면 다른 빈이 무시되거나 기본 빈을 덮어버리거나 설정에 따라 오류가 발생한다.

 

스프링 빈 의존관계

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

 

스프링은 빈을 생성하고, 의존관계를 주입하는 단계가 나누어져 있다. 그런데 자바 코드로 스프링 빈을 등록하면 생성자를 호출하면서 의존관계 주입도 한번에 처리된다.  이후 "의존관계 자동 주입" 에서는 빈의 생성과 의존관계 주입은 두 개의 독립된 단계로 작동한다."

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

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

모든 빈 출력하기

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

애플리케이션 빈 출력하기

  • 스프링이 내부에서 사용하는 빈은 제외하고, 등록한 빈만 출력할 수 있다.
  • 스프링이 내부에서 사용하는 빈은 getRole()로 구분할 수 있다.

스프링 빈 조회 

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

  • ac.getBean(빈이름, 타입)
  • ac.getBean(타입)
  • 조회 대상 스프링 빈이 없으면 예외 발생 : NoSuchBeanDefinitionException : No bean named 'xxxxx' available
더보기 
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.assertThat;

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 FindBeanByName2() {
        MemberService memberService = ac.getBean("memberService", MemberServiceImpl.class);
        assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
    }

    @Test
    @DisplayName("빈 이름으로 조회X")
    void FindBeanByNameX() {
//        MemberService memberService = ac.getBean("xxxxx", MemberService.class);
        org.junit.jupiter.api.Assertions.assertThrows(NoSuchBeanDefinitionException.class,
                () -> ac.getBean("xxxxx", MemberService.class));
    }
}

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

타입으로 조회시 같은 타입의 스프링 빈이 둘 이상이면 오류가 발생한다. 이때는 빈 이름을 지정해줘야 한다.ac.getBeansOfType() 을 사용하면 해당 타입의 모든 빈을 조회할 수 있다.

더보기 
package hello.core.beanfind;

import hello.core.member.MemberRepository;
import hello.core.member.MemoryMemberRepository;
import org.junit.jupiter.api.Assertions;
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.assertThat;
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 {

        @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.Assertions;
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.assertThat;

public class ApplicationContextExtendsFindTest {

    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);

    @Test
    @DisplayName("부모 타입으로 조회, 자식이 둘 이상 존재시, 중복 오류가 발생")
    void findBeanByPolicyTypeDuplicate(){
        Assertions.assertThrows(NoUniqueBeanDefinitionException.class,
                () -> ac.getBean(DiscountPolicy.class));
    }

    @Test
    @DisplayName("부모 타입으로 조회, 자식이 둘 이상 존재시, 빈 이름을 지정하면 된다.")
    void findBeanByPolicyTypeBeanName(){
        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("부모 타입으로 모두 조회하기")
    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 기능을 모두 상속받아서 제공한다.
  • BeanFactory가 기본적인 빈 관리 및 조회 기능만 제공한다면, ApplicationContext는 훨씬 다양한 부가기능들을 상속받는다.

ApplicationContext가 제공하는 부가기능

MessageSource 메시지소스를 활용한 국제화기능

  • 사용자의 로케일 정보에 따라 적절한 언어의 메시지를 제공한다.
  • 예를 들어, 한 사용자가 웹사이트를 방문할 때 한국어로 메시지를 받고, 다른 사용자는 영어로 메시지를 받을 수 있다.

EnvironmentCapable 환경 변수

  • 스프링에서는 "Environment" 와 "PropertySource" 를 활용하여 애플리케이션의 실행환경에 따른 설정 정보를 분리하고 관리할 수 있다. 
  • 예를 들어, 개발 환경에서는 H2 데이터베이스를, 실제 운영 환경에서는 Oracle 데이터베이스를 사용할 수 있게 설정을 다르게 줄 수 있다.

ApplicationEventPublisher 애플리케이션 이벤트

  • 스프링의 이벤트 발행 - 구독 모델은 컴포넌트 결합을 통해 이벤트를 발행하고 해당 이벤트를 구독하는 컴포넌트에게 알림을 주는 방식이다.

ResourceLoader 리소스 조회

  • 스프링은 "Resource" 추상화를 통해 다양한 리소스 타입에 독립적으로 접근할 수 있게 지원한다. 
  • 예를 들어, "ClassPathResource"를 통해 클래스패스 안의 파일을, "FileSystemResourse"를 통해 파일 시스템의 파일을 읽을 수 있다. 이러한 리소스 접근 방식은 설정 파일 또는 외부 리소스에 독립적으로 액세스할 때 유용하다.

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

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

  • 자바 코드, XML, Groovy 등

XML 설정사용

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

  • GenericXmlApplicationContext 를 사용해 xml 설정 파일을 넘기면 된다.
더보기

테스트 코드

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

xml 기반의 스프링 빈 설정 - src/main/resource/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>

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

스프링에서 다양한 설정 형식을 지원하는 핵심은 "BeanDefinition" 이라는 추상화에 있다.

이는 역할과 구현을 개념적으로 분리해놓은 것으로, 스프링의 설정 메타 정보를 의미한다.

 

BeanDefinition은 설정 정보와 추상화로서

XML 파일이든 자바 코드든 관계 없이 해당 정보를 기반으로 각각의 빈 설정 메타 정보를 생성한다.

즉, 결과적으로 BeanDefinition이 생성되면 스프링 컨테이너는 그것만 보고 스프링 빈을 생성한다.

따라서 스프링 컨테이너는 설정이 자바 코드 기반 인지, XML 기반인지를 알 필요가 없다.

BeanDefinition 정보

더보기 
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;

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("beanDefinition =" + beanDefinitionName +
                " beanDefinition = " + beanDefinition);
            }
        }
    }
}
beanDefinition =appConfig beanDefinition = Generic bean: class [hello.core.AppConfig$$SpringCGLIB$$0]; scope=singleton; abstract=false; lazyInit=null; autowireMode=0; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=null; factoryMethodName=null; initMethodNames=null; destroyMethodNames=null
beanDefinition =memberService beanDefinition = Root bean: class [null]; scope=; abstract=false; lazyInit=null; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=appConfig; factoryMethodName=memberService; initMethodNames=null; destroyMethodNames=[(inferred)]; defined in hello.core.AppConfig
beanDefinition =MemberRepository beanDefinition = Root bean: class [null]; scope=; abstract=false; lazyInit=null; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=appConfig; factoryMethodName=MemberRepository; initMethodNames=null; destroyMethodNames=[(inferred)]; defined in hello.core.AppConfig
beanDefinition =orderService beanDefinition = Root bean: class [null]; scope=; abstract=false; lazyInit=null; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=appConfig; factoryMethodName=orderService; initMethodNames=null; destroyMethodNames=[(inferred)]; defined in hello.core.AppConfig
beanDefinition =discountPolicy beanDefinition = Root bean: class [null]; scope=; abstract=false; lazyInit=null; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=appConfig; factoryMethodName=discountPolicy; initMethodNames=null; destroyMethodNames=[(inferred)]; defined in hello.core.AppConfig
  • BeanClassName : 생성할 빈의 클래스 명(자바 설정처럼 팩토리 역할의 빈을 사용하면 존재하지않음)
  • factoryBeanName : 팩토리 역할의 빈을 사용할 경우 이름, ex) appConfig
  • factoryMethodName : 빈을 생성할 팩토리 메서드 지정, ex) memberService
  • Scope : 싱글톤(기본값)
  • lazylnit : 스프링 컨테이너를 생성할 때 빈을 생성하는 것이 아니라, 실제 빈을 사용할 떄 까지 최대한 생성을 지연 처리하는지 여부
  • InitMethodName : 빈을 생성하고, 의존관계를 적용한 뒤, 호출되는 초기화 메서드 명
  • DestoryMethodName : 빈의 생명주기가 끝나서 제거하기 직전 호출되는 메서드 명
  • Constructor arguments, Properties : 의존관계 주입에서 사용한다. (자바 설정 처럼 팩토리 역할의 빈을 사용하면 존재하지 않음)
BeanDefinition을 직접 생성해서 스프링 컨테이너에 등록할 수 있지만, 실무에서 직접 정의하거나 사용하는 일은 없다.  스프링 관련 오픈 소스의 코드를 볼때, BeanDefinition 이라는 것이 보일 때 이러한 메커니즘을 참고하자.

 

 

 

출처 : 인프런 - 🔗 스프링 핵심원리 - 기본편by 우아한형제 김영한님