[ 김영한 스프링 핵심 원리 - 기본편 #4 ] 스프링 컨테이너와 스프링 빈

김수호·2023년 8월 10일
김영한 스프링 핵심 원리 - 기본편
0
post-thumbnail

이번 섹션에서는 스프링 컨테이너와 스프링 빈에 대해서 알아보자.

목차는 다음과 같다.

1) 스프링 컨테이너 생성
2) 컨테이너에 등록된 모든 빈 조회
3) 스프링 빈 조회 - 기본
4) 스프링 빈 조회 - 동일한 타입이 둘 이상
5) 스프링 빈 조회 - 상속 관계
6) BeanFactory와 ApplicationContext
7) 다양한 설정 형식 지원 - 자바 코드, XML
8) 스프링 빈 설정 메타 정보 - BeanDefinition

1) 스프링 컨테이너 생성

먼저 스프링 컨테이너가 어떤식으로 생성되는지 알아보자.

  • 스프링 컨테이너 생성
    • ApplicationContext 를 스프링 컨테이너라 한다.
    • ApplicationContext 는 인터페이스이다. (ApplicationContext 를 구현한 것 중 하나가 AnnotationConfigApplicationContext 이다.)
    • 스프링 컨테이너는 XML을 기반으로 만들 수 있고, 애노테이션 기반의 자바 설정 클래스로 만들 수 있다.
    • 직전에 AppConfig 를 사용했던 방식이 애노테이션 기반의 자바 설정 클래스로 스프링 컨테이너를 만든 것 이다.
    • 자바 설정 클래스를 기반으로 스프링 컨테이너( ApplicationContext )를 만들어보자.
      • new AnnotationConfigApplicationContext(AppConfig.class);
    • 참고
      • 더 정확히는 스프링 컨테이너를 부를 때 BeanFactory , ApplicationContext 로 구분해서 이야기 한다. 이 부분은 뒤에서 설명하겠다. BeanFactory 를 직접 사용하는 경우는 거의 없으므로 일반적으로 ApplicationContext 를 스프링 컨테이너라 한다.
  • 스프링 컨테이너의 생성 과정
    • ① 스프링 컨테이너 생성
      • new AnnotationConfigApplicationContext(AppConfig.class);
      • 스프링 컨테이너를 생성할 때는 구성 정보를 지정해주어야 한다. (여기서는 AppConfig.class를 구성 정보로 지정했다.)
    • ② 스프링 빈 등록
      • 다음에는 아래와 같이 스프링 컨테이너가 본인을 생성하면서 파라미터로 넘어온 설정 클래스 정보를 확인하여 스프링 빈 저장소에 스프링 빈을 등록한다.
        • AppConfig의 @Bean이 붙은 것을 전부 호출해서, 메서드 이름을 빈 이름으로, 리턴되어 반환되는 객체를 빈 객체로 등록한다.
        • 빈 이름
          • 빈 이름은 메서드 이름을 사용한다.
          • 빈 이름은 직접 부여할 수도 있다. (ex. @Bean(name="memberService2"))
          • 주의
            • 빈 이름은 항상 다른 이름을 부여해야 한다. 같은 이름을 부여하면, 다른 빈이 무시되거나, 기존 빈을 덮어버리거나 설정에 따라 오류가 발생한다.
    • ③ 스프링 빈 의존관계 설정 - 준비
      • 스프링 빈을 등록한 다음에는, 의존관계 설정을 준비한다.
        • (참고) 간단하게 표현하기 위해 스프링 빈을 녹색 원으로 표현했다.
    • ④ 스프링 빈 의존관계 설정 - 완료
      • 스프링 컨테이너는 설정 정보를 참고해서 의존관계를 주입(DI)한다.
      • 단순히 자바 코드를 호출하는 것 같지만, 차이가 있다. 이 차이는 뒤에 싱글톤 컨테이너에서 설명한다.

☝️ 참고

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

✔️ 정리

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

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

이번에는 스프링 컨테이너에 실제 스프링 빈들이 잘 등록 되어 있는지 확인해보자.

  • test > java > hello > core 아래 beanfind 패키지를 생성하고, 내부에 ApplicationContextInfoTest 파일을 생성하자.
    • 정상적으로 실행되어 등록된 빈들이 조회됨을 확인하였다.
    • 참고
      • 모든 빈 출력하기
        • 실행하면 스프링에 등록된 모든 빈 정보를 출력할 수 있다.
        • ac.getBeanDefinitionNames() : 스프링에 등록된 모든 빈 이름을 조회한다.
        • ac.getBean() : 빈 이름으로 빈 객체(인스턴스)를 조회한다.
      • 애플리케이션 빈 출력하기
        • 스프링이 내부에서 사용하는 빈은 제외하고, 내가 등록한 빈만 출력해보자.
        • 스프링이 내부에서 사용하는 빈은 getRole() 로 구분할 수 있다
          • ROLE_APPLICATION : 일반적으로 사용자가 정의한 빈
          • ROLE_INFRASTRUCTURE : 스프링이 내부에서 사용하는 빈

3) 스프링 빈 조회 - 기본

이번에는 스프링 컨테이너에서 스프링 빈을 조회하는 가장 기본적인 방법에 대해 알아보자.

  • ac.getBean(빈이름)
  • ac.getBean(타입)
  • ac.getBean(빈이름, 타입)
  • 조회 대상 스프링 빈이 없으면 예외 발생 ( NoSuchBeanDefinitionException: No bean named 'xxxxx' available )
  • test > java > hello > core > beanfind 패키지 아래 ApplicationContextBasicFindTest 클래스를 생성하자.
    • 정상적으로 실행된 것을 볼 수 있다.
    • (참고) 구체 타입으로 조회하면 변경시 유연성이 떨어진다.

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

이번에는 스프링 빈을 조회할 때, 동일한 타입이 둘 이상인 경우에는 어떻게 하는지 알아보자.

  • 타입으로 조회시 같은 타입의 스프링 빈이 둘 이상이면 오류가 발생한다. 이때는 빈 이름을 지정하자.
  • ac.getBeanOfType()을 사용하면 해당 타입의 모든 빈을 조회할 수 있다.
  • test > java > hello > core > beanfind 패키지 아래 ApplicationContextSameBeanFindTest 클래스를 생성하자.
    • 정상적으로 실행된 것을 확인할 수 있다.
    • (참고) 같은 타입의 빈을 테스트하기 위해 SameBeanConfig를 만들었다.

5) 스프링 빈 조회 - 상속 관계

이번에는 상속관계에서의 스프링 빈 조회에 대해 알아보자.

  • 부모 타입으로 조회하면, 자식 타입도 함께 조회된다.
  • 그래서 모든 자바 객체의 최고 부모인 Object타입으로 조회하면, 모든 스프링 빈을 조회한다.
    • 위 그림과 같이 부모-자식 관계로 되어있을 때,
      • 1번 타입으로 조회시: 전체 다 조회됨.
      • 2번 타입으로 조회시: 2,4,5 조회됨.
      • 3번 타입으로 조회시: 3,5,7 조회됨.
      • 4번 타입으로 조회시: 4 조회됨.
      • 5번 타입으로 조회시: 5 조회됨.
      • 6번 타입으로 조회시: 6 조회됨.
      • 7번 타입으로 조회시: 7 조회됨.

  • test > java > hello > core > beanfind 패키지 아래 ApplicationContextExtendsFindTest 클래스를 생성하자.

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

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

}

    • 정상적으로 실행된 것을 확인할 수 있다.

 

✔️ 이렇게 해서 목차 2) ~ 4)까지는 스프링 빈을 조회하는 방법에 대해서 알아보았다. 다른 몇가지 기능들이 더 있지만, 거의 잘 사용하지 않는다. 이 정도만 알아도 무관하다. 더 알아야할 내용이 있다면 필요할 때 그때그때 찾아보도록 하자.

6) BeanFactory와 ApplicationContext

이번에는 BeanFactory와 ApplicationContext에 대해서 알아보자.

✔️ BeanFactory

  • 스프링 컨테이너의 최상위 인터페이스다.
  • 스프링 빈을 관리하고 조회하는 역할을 담당한다.
  • getBean() 을 제공한다.
  • 지금까지 우리가 사용했던 대부분의 기능은 BeanFactory가 제공하는 기능이다.

✔️ ApplicationContext

  • BeanFactory 기능을 모두 상속받아서 제공한다. (BeanFactory에 부가 기능을 더한 것)
  • 빈을 관리하고 검색하는 기능을 BeanFactory가 제공해주는데, 그러면 둘의 차이가 뭘까?
  • 애플리케이션을 개발할 때는 빈을 관리하고 조회하는 기능은 물론이고, 수 많은 부가기능이 필요하다.

✔️ ApplicationContext가 제공하는 부가 기능

  • MessageSource: 메시지소스를 활용한 국제화 기능
    • 예를 들어서 한국에서 들어오면 한국어로, 영어권에서 들어오면 영어로 출력
  • EnvironmentCapable: 환경변수
    • 로컬, 개발, 운영 등을 구분해서 처리
  • ApplicationEventPublisher: 애플리케이션 이벤트
    • 이벤트를 발행하고 구독하는 모델을 편리하게 지원
  • ResourceLoader: 편리한 리소스 조회
    • 파일, 클래스패스, 외부 등에서 리소스를 편리하게 조회

✔️ 정리

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

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

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

  • 그림을 보면 제일 상위에 BeanFactory가 있고, 그 아래 ApplicationContext가 있다. 그리고 이 ApplicationContext를 구현한 것 중 하나가 우리가 이전에 사용했던 AnnotationConfigApplicationContext가 있다. (AnnotationConfig를 설정 정보로 사용하는 ApplicationContext) 그리고 또 GenericXmlApplicationContext라는게 있다. (자바 코드가 아닌 XML이라는 문서를 설정 정보로 사용하는 ApplicationContext) 그리고 임의로 자체적으로 구현해서 만들수도 있다. (XxxApplicationContext)

 

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

  • 지금까지 했던 것이다.
  • new AnnotationConfigApplicationContext(AppConfig.class);
  • AnnotationConfigApplicationContext 클래스를 사용하면서 자바 코드로된 설정 정보를 넘기면 된다

✔️ XML 설정사용

  • 최근에는 스프링 부트를 많이 사용하면서 XML기반의 설정은 잘 사용하지 않는다. 아직 많은 레거시 프로젝트들이 XML로 되어 있고, 또 XML을 사용하면 컴파일 없이 빈 설정 정보를 변경할 수 있는 장점도 있으므로 한번쯤 배워두는 것도 괜찮다.
  • GenericXmlApplicationContext 를 사용하면서 xml 설정 파일을 넘기면 된다.

👉 XML 설정을 코드로 작성해보자.

  • src > main > resources > appConfig.xml 을 생성한다.
    • 위와 같이 작성한다. 잘 보면 이전에 자바 코드로 설정할때와 형식만 다르지 같은것을 볼 수 있다.
  • test > java > hello > core > xml 패키지를 생성하고, 내부에 XmlAppContext 클래스를 생성하자.
    • 정상적으로 수행된 것을 볼 수 있다. ( GenericXmlApplicationContext를 만들고, 설정 정보만 클래스 파일에서 XML로만 변경되었을 뿐 그 외에는 똑같다. )
    • (참고) new GenericXmlApplicationContext(appConfig.xml); : 이렇게 정의해두면 classpath에 있는 appConfig.xml을 읽는다. (src/main/resources/)
    • (참고) 로그를 보면 Creating shared instance of singleton bean ... 등이 나오는데 싱글톤과 관련해서는 다음 섹션에서 설명한다.

✔️ 정리

  • xml 기반의 appConfig.xml 스프링 설정 정보와 자바 코드로 된 AppConfig.java 설정 정보를 비교해보면 거의 비슷하다는 것을 알 수 있다.
  • xml 기반으로 설정하는 것은 최근에 잘 사용하지 않으므로 이정도로 마무리 하고, 필요하면 스프링 공식 레퍼런스 문서를 확인하자.

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

이번에는 스프링 빈 설정 메타 정보 - BeanDefinition에 대해서 알아보자.

  • 스프링은 어떻게 이런 다양한 설정 형식을 지원하는 것일까? 🤔
    : 그 중심에는 BeanDefinition 이라는 추상화가 있다. (빈 정보에 대한 것 자체를 추상화 시킨 것)
  • 쉽게 이야기해서 역할과 구현을 개념적으로 나눈 것이다!
    • XML을 읽어서 BeanDefinition을 만들면 된다.
    • 자바 코드를 읽어서 BeanDefinition을 만들면 된다.
    • 스프링 컨테이너는 자바 코드인지, XML인지 몰라도 된다. 오직 BeanDefinition만 알면 된다. (이것을 기반으로 스프링 빈을 생성한다.)
  • BeanDefinition 을 빈 설정 메타정보라 한다.
    • @Bean , <bean>당 각각 하나씩 메타 정보가 생성된다
  • 스프링 컨테이너는 이 메타 정보를 기반으로 스프링 빈을 생성한다.
    • 스프링 컨테이너 자체는 BeanDefinition(인터페이스임)에만 의존한다. (구성 정보가 클래스로 설정된 정보인지 XML로 설정된 정보인지 임의로 설정된 정보인지 상관하지 않음. -> 추상화에만 의존하도록 설계한 것.)

 

코드 레벨로 조금 더 깊이 있게 들어가보자.

  • AnnotationConfigApplicationContext 는 AnnotatedBeanDefinitionReader 를 사용해서 AppConfig.class 를 읽고 BeanDefinition 을 생성한다. (AnnotatedBeanDefinitionReader 는 설정 정보를 읽어서 빈 메타 정보를 생성한다.)

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

  • 새로운 형식의 설정 정보가 추가되면, XxxBeanDefinitionReader를 만들어서 BeanDefinition 을 생성 하면 된다.

 

BeanDefinition 정보

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

☝️ 코드를 통해 확인해보자.

  • test > java > hello > core > beandefinition 패키지를 생성하고, 내부에 BeanDefinitionTest 클래스를 생성한다.
    • 정상적으로 실행되어 BeanDefinition 정보가 나오는 것을 확인할 수 있다.
    • (참고) 로그를 보면, scope에 아무것도 할당이 안된것을 볼수있다. 할당이 안된경우 싱글톤을 의미한다.

✔️ 정리

  • BeanDefinition을 직접 생성해서 스프링 컨테이너에 등록할 수도 있다. 하지만 실무에서 BeanDefinition을 직접 정의하거나 사용할 일은 거의 없다. 어려우면 그냥 넘어가면 된다.

  • BeanDefinition에 대해서는 너무 깊이있게 이해하기 보다는, 스프링이 다양한 형태의 설정 정보를 BeanDefinition으로 추상화해서 사용하는 것 정도만 이해하면 된다.

  • 가끔 스프링 코드나 스프링 관련 오픈 소스의 코드를 볼 때, BeanDefinition 이라는 것이 보일 때가 있다. 이때 이러한 메커니즘을 떠올리면 된다.

강의를 듣고 정리한 글입니다. 코드와 그림 등의 출처는 김영한 강사님께 있습니다.

profile
김수호
현실에서 한 발자국
이전 포스트

[ 김영한 스프링 핵심 원리 - 기본편 #3 ] 스프링 핵심 원리 이해2 - 객체 지향 원리 적용

다음 포스트

[ 김영한 스프링 핵심 원리 - 기본편 #5 ] 싱글톤 컨테이너

0개의 댓글