섹션4. 스프링 컨테이너와 빈

wnajsldkf·2022년 12월 28일
Spring
0

스프링 핵심 원리-기본편

목록 보기
5/9

김영한 선생님의 스프링 핵심 원리 - 기본편 강의를 듣고 정리하였습니다.

스프링 컨테이너 생성

스프링 컨테이너는 스프링에서 자바 객체들을 관리하는 공간을 말한다. 자바 객체를 스프링에서 빈(Bean)이라고 하는데, 스프링 컨테이너는 빈의 생성부터 소멸까지 관리한다. 

ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);
  • ApplicationContext는 스프링 컨테이너 인터페이스이다. 스프링 컨테이너는 XML을 기반 혹은 애노테이션 기반의 자바 설정 클래스로 만들 수 있다.
    • AppConfig.class를 사용한 방식은 애노테이션 기반의 자바 설정 클래스이다.
  • new AnnotationConfigApplicationContext(AppConfig.class);는 ApplicationContext 인터페이스의 구현체이다.

스프링에서 컨테이너는 BeanFactory와 ApplicationContext로 구분해서 말한다. BeanFactory를 직접 사용하는 경우는 거의 없고, 일반적으로 ApplicationContext를 스프링 컨테이너 방식을 사용한다.

  • BeanFactory: 빈을 생성하고 관계를 설정하는 IoC의 기본 기능에 초점을 둔다.
  • ApplicationContext: 별도의 정보를 참고해서 빈의 생성, 관계 설정 등의 제어를 관리하는데 초점을 준다.
  • Spring 공식 문서에서는 두 컨테이너 중 특별한 이유가 없다면, ApplicationContext를 사용해야 한다고 한다. BeanFactory의 모든 기능을 포함하고 있기 때문이다.
    Ref: https://beststar-1.tistory.com/39

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

  1. 스프링 컨테이너 생성

    1. 스프링 컨테이너 생성(AppConfig.class)
      빈 이름, 빈 객체로 구성된 스프링 빈 저장소를 생성한다.
    2. 구성 정보를 활용한다.
    • new AnnotationConfigApplicationContext(AppConfig.class) 로 스프링 컨테이너를 생성할 때 구성 정보를 지정해준다.
      • 이 코드는 AppConfig.class를 구성 정보로 지정한다.

  2. 스프링 빈 등록
    @Bean이 붙은 것을 모두 호출하여 빈 이름으로 지정하고, 반환하는 것을 빈 객체로 등록한다.

    @Bean
public MemberService memberService() {
	return new MemberServiceImpl(memberRepository());
}

/*
빈 이름: memberService
빈 객체: MemberServiceImpl@x01
*/
    • 스프링 컨테이너는 파라미터로 넘어온 설정 클래스 정보를 사용해서 스프링 빈을 등록한다.
    • 빈 이름 설정
      • 빈 이름은 메서드 이름을 사용한다.
      • 빈 이름을 직접 부여할 수도 있다. (ex. @Bean(name="memberService2");)
      • 빈 이름은 항상 다른 이름으로 부여해야 한다. 같은 이름을 부여하면, 다른 빈이 무시되거나 기본 빈을 덮어버리는 등, 설정에 따라 오류가 발생한다.

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

  1. 스프링 빈 의존관계 설정(완료)
    • 스프링 컨테이너는 설정 정보를 참고해서 의존관계를 주입(DI)한다.
    • 단순 자바 코드를 호출하는 것과 차이가 있으며, 싱글톤 컨테이너에서 더 알아보자.

스프링 컨테이너를 설정하고, 설정(구성) 정보를 참고해서 스프링 빈 등록 및 의존 관계를 설정하였다. 다음은 스프링 컨테이너에서 데이터를 조회하자.

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

모든 빈 출력하기

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

  • ac.getBeanDefinitionNamese(): 스프링에 등록된 모든 빈 이름을 조회한다.
  • ac.getBean(): 빈 이름으로 빈 객체(인스턴스)를 조회한다.
@Test
@DisplayName("모든 빈 출력하기")
void findAllBean(){
     String[] beanDefinitionNames = ac.getBeanDefinitionNames();
     for (String beanDefinitionName : beanDefinitionNames) {
         Object bean = ac.getBean(beanDefinitionName);
         System.out.println("name = " + beanDefinitionName + "object = " + bean);
     }
}

/*
결과: 사용자가 정의한 빈과 내부에서 사용하는 빈이 모두 출력된다.
name = org.springframework.context.annotation.internalConfigurationAnnotationProcessorobject = org.springframework.context.annotation.ConfigurationClassPostProcessor@25e2ab5a
name = org.springframework.context.annotation.internalAutowiredAnnotationProcessorobject = org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor@35e5d0e5
name = org.springframework.context.annotation.internalCommonAnnotationProcessorobject = org.springframework.context.annotation.CommonAnnotationBeanPostProcessor@73173f63
name = org.springframework.context.event.internalEventListenerProcessorobject = org.springframework.context.event.EventListenerMethodProcessor@55562aa9
name = org.springframework.context.event.internalEventListenerFactoryobject = org.springframework.context.event.DefaultEventListenerFactory@655ef322
name = appConfigobject = hello.core.AppConfig$$EnhancerBySpringCGLIB$$4b252183@7e276594
name = memberServiceobject = hello.core.member.MemberServiceImpl@3401a114
name = memberRepositoryobject = hello.core.member.MemoryMemberRepository@5066d65f
name = orderServiceobject = hello.core.order.OrderServiceImpl@4233e892
name = discountPolicyobject = hello.core.discount.RateDiscountPolicy@77d2e85
*/

애플리케이션 빈 출력하기

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

  • ROLE_APPLICATION: 일반적으로 사용자가 정의한 빈
  • ROLE_INFRASTRUCTURE: 스프링이 내부에서 사용하는 빈
	@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);
            }
        }
    }
    
    /* 결과: 사용자가 직접 등록한 bean만 출력된다.
    name = appConfigobject = hello.core.AppConfig$$EnhancerBySpringCGLIB$$4b252183@25e2ab5a
    name = memberServiceobject = hello.core.member.MemberServiceImpl@35e5d0e5
    name = memberRepositoryobject = hello.core.member.MemoryMemberRepository@73173f63
    name = orderServiceobject = hello.core.order.OrderServiceImpl@55562aa9
    name = discountPolicyobject = hello.core.discount.RateDiscountPolicy@655ef322
    */

스프링 빈 조회 - 기본

빈이름, 타입으로 검색할 수 있다.
ex. ac.getBean(빈이름, 타입), ac.getBean(타입)

  • 해당 Bean이 없으면 예외가 발생한다. NoSuchBeanDefinitionException: No bean named ‘xxxxx’ available
  • 구현체(구체타입)으로 조회하는 것은 유연성이 저하된다.
	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 findBeanByType2() {
        MemberServiceImpl memberService = ac.getBean(MemberServiceImpl.class);
        assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
    }

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

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

  • 타입 조회 시, 같은 타입의 스프링 빈이 둘 이상이면 오류가 발생한다. 따라서 빈 이름을 지정하여 조회한다.
  • ac.getBeansOfType()을 사용하면 해당 타입의 모든 빈을 조회할 수 있다.
	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);
    }
    
    /* 조회 결과
    key = memberRepository1 value = hello.core.member.MemoryMemberRepository@3a1dd365
    key = memberRepository2 value = hello.core.member.MemoryMemberRepository@395b56bb
    beansOfType = {memberRepository1=hello.core.member.MemoryMemberRepository@3a1dd365, memberRepository2=hello.core.member.MemoryMemberRepository@395b56bb}
    */

	// 임의의 Configuration 파일을 생성한다.
    @Configuration
    static class SameBeanConfig {
        @Bean
        public MemberRepository memberRepository1() {
            return new MemoryMemberRepository();
        }

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

스프링 빈 조회 - 상속 관계

  • 부모 타입으로 조회하면, 자식 타입도 자동으로 조회한다.
  • 모든 자바 객체의 최고 부모인 Object 타입으로 조회하면, 모든 스프링빈이 조회된다.
	@Test
    @DisplayName("부모 타입으로 조회 시, 자식이 둘 이상 있으면 중복 오류가 발생한다.")
    void findBeanByParentTypeDuplicated() {
        DiscountPolicy bean = ac.getBean(DiscountPolicy.class);
        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()을 제공한다.
    - ac.getBean(빈이름, 타입), ac.getBean(타입)

ApplicationContext

  • BeanFactory 기능을 모두 상속받아 제공한다.
  • 빈을 관리하고 검색하는 기능을 BeanFactory가 제공해준다.
  • 애플리케이션을 개발할 때 빈 관리 및 조회 가능하고, 부가기능이 필요하다.
  • 메시지소스를 활용한 국제화 기능
    • 한국에서 들어오면 한국어로, 영어권에서 들어오면 영어로 출력
  • 환경변수
    • 로컬, 개발, 운영등을 구분해서 처리
  • 애플리케이션 이벤트
    • 이벤트를 발행하고 구독하는 모델을 편리하게 지원
  • 편리한 리소스 조회
    • 파일, 클래스패스, 외부 등에서 리소스를 편리하게 조회

Summary

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

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

다양한 형식의 설정 정보를 받아들일 수 있게 설계되어 있다.(자바코드, XML, Groovy 등)

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

  • new AnnotationConfigApplicationContext(AppConfig.class)는 AnnotationConfigApplicationContext 클래스를 사용하면서 자바 코드로된 설정 코드를 넘긴다.

XML 설정 사용

최근에는 잘 사용하지 않지만, 아직 많은 레거시는 XML로 되어 있고 XML을 사용하면 컴파일 없이 빈 설정 정보를 변경할 수 있는 장점도 있어 배워보는 것도 괜찮다.

  • GenericXmlApplicationContext를 사용하면서 xml 설정 파일을 넘기면 된다.
    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>

XML 기반의 appConfig.xml 스프링 설정 정보와 자바 코드의 AppConfig.java 설정 정보를 비교하면 빈과 1:1로 매칭되는 것을 알 수 있다.

XmlAppContext

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

스프링 빈 설정 메타 정보 - Bean Definition

스프링은 BeanDefinition이라는 추상화 인터페이스로 다양한 설정 형식을 지원한다.

  • 역할과 구현을 개념적으로 나눈다.
    • XML을 읽어서 BeanDefinition을 만든다.
    • 자바 코드를 읽어서 BeanDefinition을 만든다.
    • 스프링 컨테이너는 자바 코드인지, XML인지 알 수 없다. 오직 BeanDefinition만 알면 된다.
  • BeanDefinition을 빈 설정 메타 정보라 한다.
    • @Bean, <bean>당 각각 메타 정보가 생성된다.
  • 스프링 컨테이너는 메타 정보를 기반으로 스프링 빈을 생성한다.

    스프링 컨테이너는 BeanDefinition이라는 추상화된 인터페이스에만 의존한다. 추상화된 인터페이스를 AppConfig.class, appConfig.xml, appConfig.xxx 등이 구체화한다.

코드레벨에서 깊게 들어가보면,

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

BeanDefinition 살펴보기

BeanDefinition 정보

  • BeanClassName: 생성한 빈의 클래스명
    • 자바 설정처럼 팩토리 역할의 빈을 사용하면 설정할 필요 없음
  • factoryBeanName: 팩토리 역할의 빈을 사용할 경우(ex. appConfig)
  • factoryMethodName: 빈을 생성할 팩토리 메서드 지정(ex. 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 {
    // Annotation 기반으로 설정하는 경우
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
	// XML 설정을 사용하는 경우
    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);
            }
        }
    }
}

summary

  • BeanDefinition을 직접 생성해서 스프링 컨테이너에 등록할 수 있다. 실무에서는 BeanDefinition을 직접 정의하거나 사용할 일이 거의 없다.
  • 스프링은 다양한 형태의 설정 정보를 BeanDefinition으로 추상화해서 사용한다.
    • 직접 Spring Bean을 등록하거나, Factory Bean으로 등록하는 방법이있다.
profile
wnajsldkf
https://mywnajsldkf.tistory.com -> 이사 중
이전 포스트

섹션3. 스프링 핵심 원리 이해2 - 객체 지향 원리 적용

다음 포스트

섹션5. 싱글톤 컨테이너

0개의 댓글