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

📌 스프링 컨테이너 생성

 

ApplicationContext applicationContext = AnnotationConfigApplicationContext(AppConfig.class);

 

• ApplicationContext : 스프링 컨테이너(인터페이스)
• 스프링 컨테이너 : XML을 기반으로 만들 수 있고, 애노테이션 기반의 자바 설정 클래스로 만들 수 있음
  • 직전에 AppConfig를 사용했던 방식이 애노테이션 기반의 자바 설정 클래스로 스프링 컨테이너를 만든 것
• 자바 설정 클래스를 기반으로 스프링 컨테이너(ApplicationContext)을 만들어보기
  new AnnotationConfigApplicationContext(AppConfig.class);
  • 이 클래스는 ApplicationContext인터페이스의 구현체임

 

 

 

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

1. 스프링 컨테이너 생성

• new AnnotationConfigApplicationContext(AppConfig.class)
• 스프링 컨테이너를 생성할 때는 구성 정보를 지정해주어야 함
  • 여기서는 AppConfig.class를 구성정보로 지정

 

2. 스프링 빈 등록

 

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

 

빈 이름

• 빈 이름은 메서드 이름을 사용
• 빈 이름을 직접 부여할 수도 있음
• @Bean(name="memberService2")

 

❗ 주의

빈 이름은 항상 다른 이름을 부여해야 함!!

같은 이름을 부여하면, 다른 빈이 무시되거나, 기존 빈을 덮어버리거나 설정에 따라 오류가 발생함

 

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

 

 

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

 

• 스프링 컨테이너는 설정 정보를 참고해서 의존관계를 주입(DI)함
• 단순히 자바 코드를 호출하는 것 같지만, 차이가 있음(싱글톤 컨테이너에서 자세히 설명)

 

정리

스프링 컨테이너를 생성하고, 설정(구성) 정보를 참고해서 스프링 빈도 등록하고, 의존 관계도 설정함

 

 

 

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

🔶 src/test/java/hello/core/beanfind

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

        }

    }

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

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

            }
        }

    }
}

• 실행하면 스프링에 등록된 모든 빈 정보를 출력할 수 있음

 

 

📌 스프링 빈 조회 - 기본

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

 

예제 코드

🔶test/.../beanfind/ApplicationContextBasicFindTest

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

 

✔ 이름으로 조회
 void findBeanByName() 함수 생성

 

✔ 이름 없이 타입으로만 조회
 void findBeanByType() 함수 생성

 

✔ 구체 타입으로 조회
 void findBeanByName2() 함수 생성

 

✔ 이름으로 조회되는 것이 없을 때
 void findBeanByNameX() 함수 생성

 

❗ 구체타입으로 조회하면 변경 시 유연성이 떨어짐

 

 

 

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

✔ 타입으로 조회시 같은 타입의 스프링 빈이 둘 이상이면 오류가 발생함
-> 빈 이름을 지정해야함

✔ ac.getBeansOfType() 사용하면 해당 타입의 모든 빈을 조회 가능

 

예제 코드

🔶test/.../beanfind/ApplicationContextSameBeanFindTest 이름의 class 생성

package hello.core.beanfind;

import hello.core.AppConfig;
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 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(){
        //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);
    }

    @Configuration
    static class SameBeanConfig{
        @Bean
        public MemberRepository memberRepository1(){
            return new MemoryMemberRepository();
        }
        @Bean
        public MemberRepository memberRepository2(){
            return new MemoryMemberRepository();
        }
    }
}

 

✔ 여기 안에서만 사용할 Config 만들어줌

 

✔ 타입으로 조회시 같은 타입이 둘 이상 있으면, 중복 오류가 발생
  void findBeanByTypeDuplicate()

 

✔ 성공시키려면?
   void findBeanByName()

 

✔ 특정 타입 모두 조회
   void findAllBeanByType()

 

 

📌 스프링 빈 조회 - 상속 관계

✔ 부모 타입으로 조회하면, 자식 타입도 함께 조회함
✔ 모든 자바 객체의 부모인 Object 타입으로 조회하면 모든 스프링 빈을 조회함

 

 

 

예제 코드

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

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

    @Test
    @DisplayName("부모 타입으로 조회시, 자식이 둘 이상 있으면 중복 오류 발생")
    void findBeanByParentTypeDuplicate(){
        //DiscountPolicy bean = ac.getBean(DiscountPolicy.class);//2개가 있기 때문에 둘 다 조회
        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();
        }
    }
}

 

✔ 여기 안에서만 사용할 Config 만들어줌

 

✔ 부모 타입으로 조회시, 자식이 둘 이상 있으면 중복오류 발생

  void findBeanByParentTypeDuplicate()

 

✔ 부모타입으로 조회시, 자식이 둘 이상 있으면 빈 이름을 지정해줌

   void findBeanByParentTypeBeanName()

 

✔ 특정 하위 타입으로 조회
   void findBeanBySubType()

 

✔ 부모 타입으로 모두 조회
   void findAllBeanByParentType()

 

✔ 부모 타입으로 모두 조회하기 - Object
   void findAllBeanByObjectType()

 

 

📌 BeanFactory와 ApplicationContext

 

⚡ BeanFactory

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

 

⚡ ApplicationContext

• BeanFactory 기능을 모두 상속받아서 제공
• 빈을 관리하고 검색하는 기능을 BeanFactory가 제공해줌
• 이 둘의 차이는?
  • 애플리케이션을 개발할 때 빈을 관리하고 조회하는 기능은 물론, 수 많은 부가 기능이 필요함

 

 

ApplicationContext가 제공하는 부가기능

 

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

• 한국에서 들어오면 한국어로, 영어권에서 들어오면 영어로 출력

✔ 환경 변수

• 로컬, 개발, 운영 등을 구분해서 처리

✔ 애플리케이션 이벤트

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

✔ 편리한 리소스 조회

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

 

 

정리

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

 

 

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

• 스프링 컨테이너는 다양한 형식의 설정 정보를 받아드릴 수 있게 유연하게 설계되어 있음
  • 자바 코드, XML, Groovy 등등

 

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

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

 

⚡ XML 설정 사용

• 최근에는 스프링 부트를 많이 사용하면서 XML기반의 설정은 잘 사용하지 않음
  • 아직 많은 레거시 프로젝트들이 XML로 되어있고, 또 XML을 사용하면 컴파일 없이 빈 설정 정보를 변경할 수 있는 장점도 있음
• GenericXmlApplicationContext을 사용하면서 xml 설정파일을 넘기면 됨

 

 

XmlAppConfig.java

 

🔶 test/.../hello/core/xml/XmlAppContext

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.ApplicationContext;
import org.springframework.context.support.GenericXmlApplicationContext;

import static org.assertj.core.api.Assertions.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);
    }
}

 

 

appConfig.xml

🔶src/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" />
    </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 설정 정보를 비교해보면 거의 비슷함
✔ xml 기반으로 설정하는 것은 최근에 잘 사용하지 않으므로 이정도로 마무리하고, 필요하면 스프링 공식 레퍼런스 문서를 확인!!

 

 

📌 스프링 빈 설정 메타 정보 - BeanDefinition

 

✔ 스프링의 다양한 설정 형식들의 중심에는 BeanDefinition이라는 추상화가 있음
✔ 역할과 구현을 개념적으로 나눈 것!

• XML을 읽어서 BeanDefinition을 만들면 됨
• 자바 코드를 읽어서 BeanDefinition을 만들면 됨
• 스프링 컨테이너는 자바코드인지, XML인지 몰라도 됨. BeanDefinition만 알면 됨

✔ BeanDefinition : 빈 설정 메타 정보

• @Bean, <bean> 당 각각 하나씩 메타 정보가 생성됨

✔ 스프링 컨테이너는 이 메타정보를 기반으로 스프링빈을 생성함

 

코드 레벨을 이용하여 조금 더 깊이있게!

 

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

 

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

 

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

 

 

⚡ BeanDefinition 살펴보기

BeanDefinition 정보

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

 

BeanDefinitionTest.java

🔶test/.../hello/core/beandefinition/BeanDefinitionTest

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;

public class BeanDefinitionTest {
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

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

 

✔ 빈 설정 메타정보 확인
   void findApplicationBean()

 

 

정리

• BeanDefinition을 직접 생성해서 스프링 컨테이너에 등록할 수도 있음
  • 하지만 실무에서 BeanDefinition을 직접 정의하거나 사용할 일은 거의 없음
• BeanDefinition에 대해서는 너무 깊게 이해하기 보다는, 스프링이 다양한 형태의 설정정보를 BeanDefinition으로 추상화해서 사용하는 것 정도만 이해하면 됨
• 가끔 스프링 코드나 스프링 관련 오픈소스의 코드를 볼 때, BeanDefinition이라는 것이 보일 때가 있음

 

 

출처 : <인프런 스프링 핵심원리 - 기본편_김영한>을 수강하고 참고하여 작성한 글입니다.

 

 

 

---

 

PREV

[스프링 핵심 원리] 3. 객체 지향 원리 적용

 

NEXT

[스프링 핵심 원리] 5. 싱글톤 컨테이너