[스프링 기본] 04. 스프링 컨테이너와 스프링 빈

🖥️ 스프링 핵심 원리 - 기본편 (김영한, 인프런)

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

04-1. 스프링 컨테이너 생성

ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);

 

ApplicationContext를 스프링 컨테이너라 한다.

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

위의 코드에서 ApplicationContext는 인터페이스이고, AnnotationConfigApplicationContext는 해당 인터페이스의 구현체이다.

 

(참고) 더 정확히는 스프링 컨테이너를 부를 때 BeanFactory와 ApplicationContext로 구분해서 이야기한다. BeanFactory를 직접 사용하는 경우는 거의 없으므로 일반적으로 ApplicationContext를 스프링 컨테이너라 한다.

 

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

1. 스프링 컨테이너 생성

 

이미지 출처 : 강의자료

 

new AnnotationConfigApplicationContext(AppConfig.class)

 

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

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

 

2. 스프링 빈 등록

 

이미지 출처 : 강의자료

 

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

빈 이름은 메서드 이름을 사용한다.

다음과 같이 빈 이름을 직접 부여할 수도 있다.

 

@Bean(name="memberService2")

 

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

 

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

 

이미지 출처 : 강의자료

 

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

 

이미지 출처 : 강의자료

 

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

이것은 단순히 자바 코드를 호출하는 것과는 차이가 있는데 나중에 싱글톤 컨테이너에서 알아보자.

 

(참고) 스프링은 스프링 빈을 생성하고, 의존관계를 주입하는 단계가 나누어져 있다. 그런데 위와 같이 자바 코드로 스프링 빈을 등록하면 생성자를 호출하면서 의존관계 주입도 한번에 처리된다. 자세한 내용은 의존관계 자동 주입에서 다시 알아보자.

 

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

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

 

test/java/hello/core/findbean/ApplicationContextInfoTest.java

package hello.core.findbean;

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 findAllBeans() {
        String[] beanDefinitionNames = ac.getBeanDefinitionNames();
        for (String beanDefinitionName : beanDefinitionNames) {
            Object bean = ac.getBean(beanDefinitionName);
            System.out.println("name = " + beanDefinitionName + ", object = " + bean);
        }
    }

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

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

 

ac.getBeanDefinitionNames() : 스프링에 등록된 모든 빈 이름을 조회한다.

ac.getBean() : 빈 이름으로 빈 객체(인스턴스)를 조회한다.

 

for문 자동 생성 단축키 : iter + Tab

변수 출력 단축키 : soutv + Enter

메서드 출력 단축키 : soutm + Enter

 

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

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

    1. ac.getBean(빈이름, 타입)

    2. ac.getBean(타입)

 

이때, 조회 대상 스프링 빈이 없으면 예외가 발생한다.

NoSuchBeanDefinitionException: No bean named 'xxxxx' available`

 

test/java/hello/core/findbean/ApplicationContextBasicFindTest.java

package hello.core.findbean;

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.*;
import static org.junit.jupiter.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() {
//        MemberService memberService = ac.getBean("xxxxx", MemberService.class);
        assertThrows(NoSuchBeanDefinitionException.class, () -> ac.getBean("xxxxx", MemberService.class));
    }
}

 

(참고) 구체 타입으로 조회하면 역할이 아닌 구현에 의존하기 때문에 변경 시 유연성이 떨어진다.

 

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

타입으로 조회시 같은 타입의 스프링 빈이 둘 이상이면 오류가 발생한다.

NoUniqueBeanDefinitionException: No qualifying bean of type 'hello.core.member.MemberRepository' available: expected single matching bean but found 2: memberRepository1,memberRepository2

 

이때는 빈 이름을 지정하자.

 

test/java/hello/core/findbean/ApplicationContextSameBeanFIndTest.java

package hello.core.findbean;

import hello.core.member.MemberRepository;
import hello.core.member.MemoryMemberRepository;
import org.assertj.core.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 javax.lang.model.SourceVersion;
import java.util.Map;

import static org.assertj.core.api.Assertions.*;
import static org.junit.jupiter.api.Assertions.*;

public class ApplicationContextSameBeanFIndTest {

    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SameBeanConfig.class);

    @Test
    @DisplayName("타입으로 조회시 같은 타입이 둘 이상 존재하면 중복 오류가 발생한다")
    void findBeanByTypeDuplicate() {
//        Object bean = ac.getBean(MemberRepository.class);
//        assertThat(bean).isInstanceOf(MemberRepository.class);
        assertThrows(NoUniqueBeanDefinitionException.class, () -> ac.getBean(MemberRepository.class));
    }

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

    @Test
    @DisplayName("특정 타입의 빈을 모두 조회하기")
    void findAllBeansByType() {
        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
        MemberRepository memberRepository1() {
            return new MemoryMemberRepository();
        }

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

 

ac.getBeansOfType() : 해당 타입의 모든 빈을 조회한다.

 

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

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

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

 

test/java/hello/core/findbean/ApplicationContextExtendsFindTest.java

package hello.core.findbean;

import hello.core.discount.DiscountPolicy;
import hello.core.discount.FixDiscountPolicy;
import hello.core.discount.RateDiscountPolicy;
import org.assertj.core.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.*;

public class ApplicationContextExtendsFindTest {

    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(ExtendsConfig.class);

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

    @Test
    @DisplayName("부모 타입으로 조회시 자식이 둘 이상 존재하면 빈 이름을 지정하면 된다")
    void findBeanByParentTypeAndName() {
        DiscountPolicy fixDiscountPolicy = ac.getBean("fixDiscountPolicy", DiscountPolicy.class);
        assertThat(fixDiscountPolicy).isInstanceOf(FixDiscountPolicy.class);
    }

    @Test
    @DisplayName("특정 하위 타입으로 조회")
    void findBeanBySubType() {
        RateDiscountPolicy rateDiscountPolicy = ac.getBean(RateDiscountPolicy.class);
        assertThat(rateDiscountPolicy).isInstanceOf(RateDiscountPolicy.class);
    }

    @Test
    @DisplayName("부모 타입으로 모두 조회하기")
    void findAllBeansByParentType() {
        Map<String, DiscountPolicy> beansOfType = ac.getBeansOfType(DiscountPolicy.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);
    }

    @Test
    @DisplayName("부모 타입으로 모두 조회하기 - Object")
    void findAllBeansByObjectType() {
        Map<String, Object> beansOfType = ac.getBeansOfType(Object.class);
        for (String key : beansOfType.keySet()) {
            System.out.println("key = " + key + ", value = " + beansOfType.get(key));
        }
        System.out.println("beansOfType = " + beansOfType);
    }

    @Configuration
    static class ExtendsConfig {

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

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

 

04-6. BeanFactory와 ApplicationContext

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

 

이미지 출처 : 강의자료

 

BeanFactory

    - 스프링 컨테이너의 최상위 인터페이스다.

    - 스프링 빈을 관리하고 조회하는 역할을 담당한다.

    - getBean()을 제공한다.

    - 지금까지 우리가 사용했던 대부분의 기능은 BeanFactory가 제공하는 기능이다.

 

ApplicationContext

    - BeanFactory의 기능을 모두 상속받아서 제공한다.

    - 애플리케이션을 개발할 때에는 빈을 관리하고 조회하는 기능 외에도 수 많은 부가기능이 필요한데, ApplicationContext가 그런 부가기능을 제공한다.

 

ApplicationContext가 제공하는 부가기능

 

이미지 출처 : 강의자료

 

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

    - 예를 들어, 한국에서 들어오면 한국어로, 영어권에서 들어오면 영어로 출력

 

2. 환경변수

    - 로컬, 개발, 운영 환경 등을 구분해서 처리

 

3. 애플리케이션 이벤트

    - 이벤트를 발행하고 구독하는 모델을 편리하게 지원

 

4. 편리한 리소스 조회

    - 파일, 클래스패스, 외부 등에서 리소스를 편리하게 조회

 

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

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

    - 자바코드, XML, Groovy 등등

 

이미지 출처 : 강의자료

 

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

지금까지 실습했던 방식이다.

AnnotationConfigApplicationContext 클래스를 사용하면서 자바 코드로 된 설정 정보를 넘기면 된다.

new AnnotationConfigApplicationContext(AppConfig.class);

 

XML 설정 사용

최근에는 스프링 부트를 많이 사용하면서 XML 기반의 설정은 잘 사용하지 않는다.

하지만 아직 많은 레거시 프로젝트들이 XML로 되어 있고, 또 XML을 사용하면 컴파일 없이 빈 설정 정보를 변경할 수 있는 장점도 있으므로 한번 간단하게 배워보도록 하겠다.

GenericXmlApplicationContext를 사용하면서 xml 설정 파일을 넘기면 된다.

new GenericXmlApplicationContext("appConfig.xml");

 

테스트 클래스

test/java/hello/core/xml/XmlAppContext.java

package hello.core.xml;

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

import static org.assertj.core.api.Assertions.*;

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 기반의 스프링 빈 설정 정보

main/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"></constructor-arg>
    </bean>

    <bean id="memberRepository" class="hello.core.member.MemoryMemberRepository"></bean>

    <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"></bean>
</beans>

 

(참고) 스프링 공식 레퍼런스 문서

https://spring.io/projects/spring-framework

Spring Framework

 

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

스프링이 다양한 설정 형식을 지원할 수 있는 이유 중 하나는 BeanDefinition이라는 추상화다.

쉽게 이야기해서 역할과 구현을 개념적으로 나눈 것이다.

스프링 컨테이너는 설정 정보가 자바 코드인지 XML인지 몰라도 되며 오직 BeanDefinition만 알면 된다.

이러한 BeanDefinition을 빈 설정 메타정보라 한다.

@Bean, <bean> 당 각각 하나씩 메타정보가 생성되는데 스프링 컨테이너는 이 메타정보를 기반으로 스프링 빈을 생성한다.

 

이미지 출처 : 강의자료

 

이미지 출처 : 강의자료

 

AnnotationConfigApplicationContext는 AnnotatedBeanDefinitionReader를 사용해서 AppConfig.class를 읽고 BeanDefinition을 생성한다.

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

 

BeanDefinition 살펴보기

BeanDefinition 정보

    - BeanClassName: 생성할 빈의 클래스 명(자바 코드로 설정할 경우 팩토리 역할의 빈을 사용하므로 BeanClassName 정보는 없음)

    - factoryBeanName: 팩토리 역할의 빈을 사용할 경우 이름, 예) appConfig
    - factoryMethodName: 빈을 생성할 팩토리 메서드 지정, 예) memberService
    - Scope: 싱글톤(기본값)
    - lazyInit: 스프링 컨테이너를 생성할 때 바로 빈을 생성하는 것이 아니라, 실제 빈을 사용할 때까지 최대한 생성을 지연 처리하는지 여부
    - InitMethodName: 빈을 생성하고, 의존관계를 적용한 뒤에 호출되는 초기화 메서드 명

    - DestroyMethodName: 빈의 생명주기가 끝나서 제거하기 직전에 호출되는 메서드 명
    - Constructor arguments, Properties: 의존관계 주입에서 사용한다. (자바 코드로 설정할 경우 팩토리 역할의 빈을 사용하므로 해당 정보는 없음)

 

테스트 클래스

test/java/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 {

    @Test
    @DisplayName("빈 설정 메타정보 확인")
    void findApplicationBean() {

//        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
        GenericXmlApplicationContext ac = new GenericXmlApplicationContext("appConfig.xml");

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

    }
}

 

자바 코드를 사용할 경우 테스트 결과

beanDefinitionName = appConfig, beanDefinitionGeneric bean: class [hello.core.AppConfig$$EnhancerBySpringCGLIB$$1ac4a1de]; scope=singleton; abstract=false; lazyInit=null; autowireMode=0; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=null; factoryMethodName=null; initMethodName=null; destroyMethodName=null
beanDefinitionName = memberService, beanDefinitionRoot bean: class [null]; scope=; abstract=false; lazyInit=null; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=appConfig; factoryMethodName=memberService; initMethodName=null; destroyMethodName=(inferred); defined in hello.core.AppConfig
beanDefinitionName = orderService, beanDefinitionRoot bean: class [null]; scope=; abstract=false; lazyInit=null; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=appConfig; factoryMethodName=orderService; initMethodName=null; destroyMethodName=(inferred); defined in hello.core.AppConfig
beanDefinitionName = memberRepository, beanDefinitionRoot bean: class [null]; scope=; abstract=false; lazyInit=null; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=appConfig; factoryMethodName=memberRepository; initMethodName=null; destroyMethodName=(inferred); defined in hello.core.AppConfig
beanDefinitionName = discountPolicy, beanDefinitionRoot bean: class [null]; scope=; abstract=false; lazyInit=null; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=appConfig; factoryMethodName=discountPolicy; initMethodName=null; destroyMethodName=(inferred); defined in hello.core.AppConfig

 

XML을 사용할 경우 테스트 결과

beanDefinitionName = memberService, beanDefinitionGeneric bean: class [hello.core.member.MemberServiceImpl]; scope=; abstract=false; lazyInit=false; autowireMode=0; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=null; factoryMethodName=null; initMethodName=null; destroyMethodName=null; defined in class path resource [appConfig.xml]
beanDefinitionName = memberRepository, beanDefinitionGeneric bean: class [hello.core.member.MemoryMemberRepository]; scope=; abstract=false; lazyInit=false; autowireMode=0; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=null; factoryMethodName=null; initMethodName=null; destroyMethodName=null; defined in class path resource [appConfig.xml]
beanDefinitionName = orderService, beanDefinitionGeneric bean: class [hello.core.order.OrderServiceImpl]; scope=; abstract=false; lazyInit=false; autowireMode=0; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=null; factoryMethodName=null; initMethodName=null; destroyMethodName=null; defined in class path resource [appConfig.xml]
beanDefinitionName = discountPolicy, beanDefinitionGeneric bean: class [hello.core.discount.RateDiscountPolicy]; scope=; abstract=false; lazyInit=false; autowireMode=0; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=null; factoryMethodName=null; initMethodName=null; destroyMethodName=null; defined in class path resource [appConfig.xml]