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

[seyxxn]

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

스프링 컨테이너 생성

• 스프링 컨테이너를 생성하는 부분

ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);

• ApplicationContext -> 스프링 컨테이너이며, 인터페이스이다.

• XML을 기반으로 생성할 수도 있고, Annotation 기반의 자바 설정 클래스로도 생성할 수 있다.

  • 이전에 계속 사용한 방법은 후자에 속한다.

• new AnnotationConfigApplicationContext는 구현체이다.

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

1. 우선 스프링 컨테이너가 생성된다.
   • new 하여 스프링 컨테이너를 생성하고, 이때 인자로 AppConfig.class를 넘겨주는데 이것은 구성 정보를 넘겨주기 위함이다. (정보를 넘겨야 함)
2. 스프링 컨테이너와 스프링 빈 저장소의 생성
   • 1번의 과정을 거치면, 스프링 컨테이너가 만들어지고 컨테이너 내에는 빈 저장소가 만들어진다.
3. 구성 정보를 활용하여 스프링 빈 저장소의 내용을 채운다.
   • 구성 정보를 넘겨주는 AppConfig.class를 통해 스프링 컨테이너가 본인을 생성하면서 스프링 빈 정보를 하나씩 등록한다.

• 스프링 빈을 등록하는 과정

• @Bean 어노테이션으로 등록된 것들을 가지고 스프링 빈으로 등록한다.

• 보통 메서드 이름을 빈 이름으로 가지고, new 하여 반환되는 객체를 빈 객체로 가진다.

  • 빈 이름은 임의로 다르게 부여할 수 있다.
  • @Bean(name="memberService2") 와 같이 사용할 수 있다.

• 스프링 빈 의존 관계 설명

• 빈을 등록하면 이러한 그림이 그려진다.

• 스프링 컨테이너는 위에서 등록한 빈을 가지고, 설정 정보를 참고하여 **의존 관계를 주입(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 ApplicagionContextInfoTest {

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

    @Test
    @DisplayName("애플리케이션 빈 출력하기")
    void findApplicationBean(){
        String[] beanDefinitionNames = ac.getBeanDefinitionNames();
        for (String beanDefinitionName : beanDefinitionNames) {
            BeanDefinition beanDefinition = ac.getBeanDefinition(beanDefinitionName);

            // Role ROLE_APPLICATON : 직접 등록한 애플리케이션 빈
            // Role ROLE_INFRASTRUCTURE : 스프링이 내부에서 사용하는 빈
            if (beanDefinition.getRole() == BeanDefinition.ROLE_APPLICATION) {
                Object bean = ac.getBean(beanDefinitionName);
                System.out.println("name = " + beanDefinitionName + "object = " + bean);;
            }
        }
    }
}

모든 빈 출력하기

• 스프링에 등록된 모든 빈 정보를 출력하기 위해 만든 테스트 코드
• ac.getBeanDefinitionNames() : 스프링에 등록된 모든 빈 이름을 조회
• ac.getBean() : 빈 이름으로 빈 객체(인스턴스)를 조회한다.

애플리케이션 빈 출력하기

• 스프링이 내부에서 사용하는 빈은 제외하고, 내가 직접 코드로 등록한 빈들만 출력해보고자하는 테스트 코드
• 스프링이 내부에서 사용하는 빈은 getRole()로 구분할 수 있다.
  • ROLE_APPLICATION : 일반적으로 사용자가 정의한 빈
  • ROLE_INERASTRUCTURE : 스프링이 내부에서 사용하는 빈

스프링 빈 조회 - 기본

스프링 컨테이너에서 스프링 빈을 찾는 기본적인 조회 방법에는 2가지가 존재한다.

• ac.getBean(빈이름, 타입)
• ac.getBean(타입)
• 조회 대상인 스프링 빈이 없으면 예외를 발생시킨다.
  • NoSuchBeanDefinitionException : No bean named '검색한스프링빈이름' available

// import문 생략 ..

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);
        // -> memberService가 MemberServiceImpl의 인스턴스이면 성공함
    }

    @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 xxxxx = ac.getBean("xxxxx", MemberService.class);
        // -> 이렇게만 작성하면 오류 발생. 이런 이름을 가진 빈이 존재하지 않음
        assertThrows(NoSuchBeanDefinitionException.class,
                () -> ac.getBean("xxxxx", MemberService.class));
        // 오른쪽을 실행하면, 왼쪽의 예외가 터져야 한다. 안터지면 오류를 발생시킴
    }
}

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

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

// import문 생략 ...

public class ApplicationContextSameBeanFindTest {
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SameBeanConfig.class);

    @Test
    @DisplayName("타입으로 조회 시 같은 타입이 둘 이상 있으면, 중복 오류가 발생한다")
    void findBeanByTypeDuplicate() {
        // MemberRepository bean = ac.getBean(MemberRepository.class);
        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); // 2개 여야한다.
    }

    // 임시로 같은 타입의 빈을 존재하도록 함
    @Configuration
    static class SameBeanConfig {

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

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

스프링 빈 조회 - 상속 관계 (중요)

• 빈을 조회할때 상속관계인 경우, 부모타입으로 조회하면 자식 빈들이 모두 조회된다.
• 모든 자바 객체의 부모인 Object 타입으로 조회하면 모든 스프링빈을 조회한다.

// import 문 생략 ...

public class ApplicationContextExtendsFindTest {
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);

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

    @Test
    @DisplayName("부모 타입으로 조회 시, 자식이 둘 이상 있으면, 빈 이름을 지정하면 된다")
    void findByParentTypeBeanName() {
        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));
        }
    }
    // 스프링에 있는 것 까지 모두 출력이 됨. 내부적으로 쓰는 것 까지 모두 출력이 됨.
    // Object가 상위 자바의 가장 상위 객체이기 때문

    @Configuration
    static class TestConfig {

        @Bean
        public DiscountPolicy rateDiscountPolicy() {
            return new RateDiscountPolicy();
        }

        @Bean
        public DiscountPolicy fixDiscountPolicy() {
            return new FixDiscountPolicy();
        }
    }
}

BeanFactory와 ApplicationContext

BeanFactory

• 스프링 컨테이너의 최상위 인터페이스
• 스프링 빈을 관리하고 조회하는 역할을 담당
• getBean()을 제공함
• BeanFacory를 상속받은 ApplicationContext(인터페이스) 존재, 그리고 그 밑에 AnnotationConfigApplicationContext(구현 클래스) 존재

ApplicationContext

• BeanFactory 기능을 모두 상속받아 제공
• 빈을 관리하고 검색하는 기능을 제공하는 BeanFactory와의 차이점 ?
  • 더욱 많은 부가기능을 제공함
    

정리

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

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

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

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

XML 설정 사용

• 최근에는 잘 사용하지 않는 방법
• GenericXmlApplicationContext를 사용하면서 xml 설정 파일을 넘기는 방법

XmlAppConfig 사용 자바 코드

package hello.core.xml;

import hello.core.member.MemberService;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.GenericXmlApplicationContext;

import static org.assertj.core.api.AssertionsForClassTypes.assertThat;

public class XmlAppContext {

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

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을 빈 설정 메타정보라 한다.
  • @Bean, <bean>당 각각 하나씩 메타 정보가 생성된다.

[YuDeokRin]

언제나 ..첫번째로 올리시는.. 대단하십니다