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

LeeKyoungChang·2021년 12월 22일

spring, jpa 강의를 보고 정리한 내용입니다.

목록 보기

4/107

📒 1. 스프링 컨테이너 생성

스프링 컨테이너가 생성되는 과정을 알아보자!

// 스프링 컨테이너 생성
ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);

스프링 컨테이너는 new AnnotationConfigApplicationContext으로 객체를 생성하면서, AppConfig를 파라미터로 넘기고, 반환 값으로 applicaitonContext를 가지게 된다.

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

직전에 AppConfig를 사용했던 방식이 애노테이션 기반의 자바 설정 클래스로 스프링 컨테이너를 만든 것이다.

ApplicationContext 를 스프링 컨테이너라고 하고 이는 인터페이스다!
→ 다향성이 적용
(ApplicationContext를 구현한 것 중 하나가 AnnotationConfigApplicaitonContext이다.)

1. 스프링 컨테이너 생성

new AnnotationConfigApplicationContext(AppConfig.class)

스프링 컨테이너를 생성할 때는 구성 정보를 지정해주어야 한다.

여기서는 AppConfig.class를 구성 정보로 지정했다.

2. 스프링 빈 등록

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

빈 이름
빈 이름은 메서드 이름을 사용한다.
빈 이름을 직접 부여할 수도 있다.

@Bean(name="memberService2")

주의 사항
빈 이름은 항상 다른 이름을 부여해야 한다. 같은 이름을 부여하면, 다른 빈이 무시되거나, 기존 빈을 덮어버리거나 설정에 따라 오류가 발생한다.

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

4. 스프링 빈 의존관계 설정 - 완료

스프링 컨테이너는 설정 정보를 참고해서 의존관계를 주입(DI)한다.

단순히 자바 코드를 호출하는 것 같지만, 차이가 있다. (차이는 싱글톤 컨테이너에서 설명)

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

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

스프링 컨테이너에 실제 스프링 빈들이 잘 등록 되었는지 확인해보자❗️

test/../hello.core/beanfind/ApplicationContextInfoTest.java

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;

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

실행 결과
스크린샷 2021-12-22 오전 11 16 15

밑의 5줄은 실제 등록한 것들 이다.
이외 줄들은 스프링이 내부적으로 스프링을 자체적으로 확장하기 위한 것이다.

실제 등록한 것만 출력하고 싶을 때
애플리케이션 빈만 출력하는 코드

    @Test
    @DisplayName("애플리케이션 빈 출력하기")
    void findApplicationBean(){
        String[] beanDefinitionNames = ac.getBeanDefinitionNames();
        for (String beanDefinitionName : beanDefinitionNames){
            
            // Bean 하나하나에 대한 metadata 정보들
            BeanDefinition beanDefinition = ac.getBeanDefinition(beanDefinitionName);

            // "스프링 내부의 빈이 아닌 내가 개발기 위해 등록한 빈" 인 경우에만 출력하도록 한다.
            if (beanDefinition.getRole() == BeanDefinition.ROLE_APPLICATION){
                Object bean = ac.getBean(beanDefinitionName);
                System.out.println("name = " + beanDefinitionName + " object = " + bean);
            }
        }
    }

실행 결과
등록한 빈 5개만 조회
스크린샷 2021-12-22 오전 11 16 34

(1) 모든 빈 출력하기

ac.getBeanDefinitionNames() : 스프링에 등록된 모든 빈 이름을 조회한다.
ac.getBean() : 빈 이름으로 빈 객체(인스턴스)를 조회한다.

(2) 애플리케이션 빈 출력하기 (=직접 등록한 빈)

스프링 내부에서 사용하는 빈은 getRole() 로 구분할 수 있다.
ROLE_APPLICATION : 일반적으로 사용자가 정의한 빈
ROLE_INFRASTRUCTURE : 스프링이 내부에서 사용하는 빈

📒 3. 스프링 빈 조회 - 기본

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

ac.getBean(빈이름, 타입)
ac.getBean(타입)
NoSuchBeanDefinitionException: No bean named 'xxxx' available : 조회 대상 스프링 빈이 없으면 예외 발생

test/../hello.core/beanfind/ApplicationContextBasicFindTest.java

package hello.core.beanfind;

import hello.core.AppConfig;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
import org.assertj.core.api.Assertions;
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.*;

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(){
        // 역할과 구현을 분리하고 역할에 의존해야 하는데 이 코드는 구현에 의존하기 때문에
        // 구체적으로 적는 것은 좋지 않다.
        MemberServiceImpl memberService = ac.getBean("memberService",MemberServiceImpl.class);
        assertThat(memberService).isInstanceOf(MemberServiceImpl.class);

    }

    // 항상 실패 테스트도 고려해야 한다.
    @Test
    @DisplayName("빈 이름으로 조회 X")
    void findBeanByNameX(){
        // ac.getBean("xxxxx", MemberService.class);

        // assertThrows는 org.junit.jupiter.api.Assertions.assertThrows를 import 해야 한다.
        // NoSuchBeanDefinitionException.class 는 무조건 이 예외가 터져야 한다는 뜻. 이 예외가 터져야 테스트가 성공했다는 의미
        org.junit.jupiter.api.Assertions.assertThrows(NoSuchBeanDefinitionException.class, () -> ac.getBean("xxxxx", MemberService.class));
    }

}

실행 결과
스크린샷 2021-12-22 오후 12 01 16

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

❗️타입으로 조회할 때 스프링 빈이 두 개이상이면 오류가 발생한다❗️
➡️ 이럴 때는 빈 이름을 지정하면 된다.
➡️ ac.getBeansOfType() 을 사용해 해당 타입의 모든 빈을 조회해보자!

test/../hello.core/beanfind/ApplicationContextSameBeanFindTest.java

package hello.core.beanfind;

import hello.core.member.Member;
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.*;
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));
    }

    // 이 코드 안에서만 쓸 Config를 만듦
    @Configuration
    static class SameBeanConfig{
        // 객체 타입이 같고 이름만 다른 빈을 만들 수 있다.

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

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

    }
}

기존 AppConfig에는 중복타입의 빈 등록이 없다. 하지만 테스트를 위해 프로덕션 코드를 수정하는건 지양해야 하기에 테스트 클래스 내에 테스트용 구성정보 객체인 SameBeanConfig 클래스를 만들어준다.
실행 결과, NoUniqueBeanDefinitionException이 발생

동일한 타입의 빈이 여러개 등록되어 있다면, 또는 에러 없이 이 빈들을 다 꺼내고 싶을 때

지정해서 꺼내는건 이름을 지정해서 조회하는 방법
모두 조회하는 방법

를 사용해보자❗️



    @Test
    @DisplayName("타입으로 조회시 같은 타입이 둘 이상 있으면, 빈 이름을 지정하면 된다.")
    void findBeanByName(){
        // name : "memberRepository1" -> 빈 이름을 지정
        MemberRepository memberRepository = ac.getBean("memberRepository1", MemberRepository.class);
        assertThat(memberRepository).isInstanceOf(MemberRepository.class);
    }

    @Test
    @DisplayName("특정 타입을 모두 조회하기")
    void findAllBeanByType(){
        // getBeanOfType : Map으로 나옴
        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);
        // (간단하게) 등록된 타입이 2인지 확인
        assertThat(beansOfType.size()).isEqualTo(2);
    }

실행 결과
스크린샷 2021-12-22 오후 12 53 59

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

(1) 부모 타입으로 조회하면, 자식 타입도 함께 조회된다.

할인정책 타입 DiscountPolicy 인터페이스로 빈을 조회해도 구현체들이 모두 조회
getBean 메서드를 통해 이름과 타입, 타입으로 빈을 조회

(2) 모든 자바 객체의 최고 부모인 Object 타입으로 조회하면, 모든 스프링 빈을 조회한다.

test/../hello.core/beanfind/ApplicationExtendsFindTest.java

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

class ApplicationContextExtendsFindTest {

    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);

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

    @Test
    @DisplayName("부모 타입으로 조회시, 자식이 둘 이상 있으면, 빈 이름을 지정하면 된다.")
    void findBeanParentTypeBeanName(){
        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 findBeanByParentType(){
        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 케이스를 만들 때는 출력문을 만들면 안된다. (print x)
    }

    @Test
    @DisplayName("부모 타입으로 모두 조회하기 - Object")
    // Object로 조회하면 (스프링 내부적으로 쓰는 빈 까지) 전부 다 조회된다.
    void findAllBeanObjectType(){
        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();
        }
    }

}

실행 결과
입력한 내용들이 출력된다.
스크린샷 2021-12-22 오후 2 02 53

📒 6. BeanFactory와 ApplicationContext

(1) BeamFactory

스프링 컨테이너의 최상위 인터페이스로 스프링 빈을 조회 및 관리하는 역할을 한다.

지금까지 사용한 getBean 메서드들이 모두 BeanFactory가 제공하는 기능이다.

(2) ApplicationContext

BeanFactory의 기능에 추가적인 기능을 덧붙혀 제공하는 인터페이스

EnvironmentCapable, ListableBeanFactory, MessageSoure등 많은 인터페이스들을 다중상속받고 있다.

ApplicationContext는 BeanFactory의 기능뿐 아니라 다양한 부가기능을 같이 제공한다.

ApplicationContext가 제공하는 부가기능

(1) MessageSource
: 메세지 소스를 활용한 국제화기능 즉, 국가별로 그 나라에 맞는 언어로 나오도록 하는 기능
(2) EnvironmentCapable
: 로컬, 개발, 운영 등을 구분해서 처리할 수 있게 하는 기능
(3) ApplicationEventPublisher
: 이벤트를 발행하고 구독하는 모델을 편리하게 지원하는 기능
(4) ResourceLoader
: 파일 클래스패스, 외부 등에서 리소스를 편리하게 조회하게 지원하는 기능

정리

ApplicationContext는 BeanFactory의 기능을 상속받는다.

ApplicationContext는 빈 관리기능 + 기타 기능(MessageSource, EnvironmentCapable 등)을 제공한다.

BeanFactory를 직접 사용하기보다는 다 합쳐진 ApplicationContext를 사용한다.

BeanFactory나 Application Context를 스프링 컨테이너라고 한다.

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

지금까지 스프링 컨테이너를 설정한 방식은 자바 코드를 작성해서 설정하였다.
스프링 컨테이너는 JAVA뿐 아니라 XML이나 Groovy등 다양한 방식으로 스프링 컨테이너를 생성할 수 있다.

이전까지는 JAVA 코드를 이용해 설정정보를 등록해줬다면, 이제 간단하게 XML을 사용해 설정정보를 등록하자.
아직 많은 레거시 프로젝트들이 XML로 되어 있고, XML을 사용하면 컴파일 없이 빈 설정 정보를 변경할 수 있는 장점이 있다.
GenericXmlApplicationContext를 사용하면서 xml 설정 파일을 넘기면 된다.

test/../xml/XmlAppContext.java

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.support.GenericXmlApplicationContext;

public class XmlAppContext {

    @Test
    void xmlAppContext(){
        GenericXmlApplicationContext ac = new GenericXmlApplicationContext("appConfig.xml");

        // Bean 조회
        MemberService memberService = ac.getBean("memberService", MemberService.class);
        Assertions.assertThat(memberService).isInstanceOf(MemberService.class);
    }

}

resources/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>

실행 결과
스크린샷 2021-12-22 오후 4 54 03

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

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

스프링 컨테이너를 생성할 때 JAVA, XML, Groovy 등 다양한 방식의 설정 형식을 모두 지원하는데, 어떻게 가능한 것일까?
BeanDefinition을 이용하면 가능하다❗️
우리가 만든 XML, JAVA 등으로 설정 정보를 전달하면 해당 코드를 읽어와서 BeanDefinition을 만든다.
그렇기에 스프링 컨테이너는 이것이 JAVA 코드인지, XML인지 알 필요없이 전달된 BeanDefinition만 알면 된다!
즉, DIP(의존성 역전 원칙) 원칙을 지킴으로써 얻는 이점이라 할 수 있다.

BeanDefinition
빈 메타 설정정보로 JAVA에서는 @Bean , XML에서는 <bean>이 부여된 정보별로 메타 정보를 생성한다.
그리고 스프링 컨테이너는 이 메타정보를 기반으로 스프링 빈을 생성한다.

이렇게 각각의 다른 설정정보를 어떻게 BeanDefinition 으로 만드는 것일까? 그림을 보면 이와 같다.
스크린샷 2021-12-22 오후 5 27 30
각각의 설정정보 클래스에 맞는 BeanDefinitionReader를 사용해 해당 설정정보를 읽어서 빈 메타정보인 BeanDefinition을 생성해 전달한다.
만약 여기에 없는 (예시로 JSON, TXT 등) 형식의 설정 정보를 추가하고 싶다면 해당 형식을 읽을 수 있는 XxxBeanDefomotopmReader를 만들어서 BeanDefinition을 생성하면 된다.

test/../hello.core/beandefinition/BeanDefinitionTest.java

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 {

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

        }
    }
}

실행 결과
스크린샷 2021-12-22 오후 5 38 38

실행 결과로 나오는 부분이 AppConfig.class 에서 작성된 @Bean 들의 BeanDefinition 이다.
각각 필드에 대한 설명은 다음과 같다.

BeanClassName : 생성할 빈의 클래스명
factoryBeanName : 팩토리 역할의 빈을 선택할 경우 이름 (ex : appConfig)
factoryMethodName : 빈을 생성할 팩토리 메서드 지정 (ex : memberService)
Scope : 싱글톤(기본값)
lazylnit : 스프링 컨테이너를 생성할 때 빈을 생성하는 것이 아닌 빈을 실제 사용할 때 생성하는 지연 로딩
InitMethodName : 빈을 생성하고, 의존관계를 적용한 뒤에 호출되는 초기화 메서드 명
DestroyMethodName : 빈의 생명주기가 끝나서 제거하기 직전 호출되는 메서드 명
Constructor argument, Properties : 의존관계 주입에서 사용한다. (JAVA 설정처럼 팩토리 역할의 빈을 사용하면 없어진다.)