코딩딩/Java

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

전낙타 2023. 8. 18. 09:07

 

스프링 컨테이너 생성

 

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

 

// 스프링 컨테이너에 AppConfig를 등록한다.
        ApplicationContext applicationContext =
 new AnnotationConfigApplicationContext(AppConfig.class);

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

ApplicationContext는 인터페이스이고 해당 코드를 보면 알 수 있듯 다형성이 적용되어 있다.

스프링 컨테이너는 XML을 기반으로 만들 수 있고, 에노테이션 기반의 자바 설정 클래스로도 만들 수 있다. (요즘엔 XML은 잘 사용하지 않는 추세다)

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

new AnnotationConfigApplicationContext(AppConfig.class);

이 클래스는 ApplicationContext 인터페이스의 구현체이다.

해당 클래스를 통해 스프링 컨테이너를 생성하고 AppConfig.class를 구성 정보로 스프링 빈 저장소를 만든다.

 

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

Bean 이름은 메소드 이름을 사용한다.

Bean 이름을 직접 부여할 수 도 있다. ex) @Bean(name = “memberService1”)

Bean 이름이 중복되면 큰일난다.

 

스프링 컨테이너에 등록된 모든 빈 조회

 

스프링 컨테이너에 등록된 Bean을 직접 조회해보자.

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() {
        // 스프링 컨테이너에 등록된 bean에 대한 정보를 String 배열로 가져온다.
        String[] beanDefinitionNames = ac.getBeanDefinitionNames();
        // 해당 빈을 String 상태로 반복문 돌리기
        for (String beanDefinitionName : beanDefinitionNames) {
            // bean의 이름을 가지고 Spring에 등록된 Bean Object를 리턴한다.
            Object bean = ac.getBean(beanDefinitionName);
            // 해당 bean의 이름과 객체를 출력한다.
            System.out.println("name = " + beanDefinitionName + " object = " + bean);
        }
    }

    @Test
    @DisplayName("애플리케이션 빈 출력하기")
    void findApplicationBean() {
        String[] beanDefinitionNames = ac.getBeanDefinitionNames();
        for (String beanDefinitionName : beanDefinitionNames) {
            BeanDefinition beanDefinition = ac.getBeanDefinition(beanDefinitionName);
            // 스프링 컨테이너에 등록된 모든 bean을 출력하는 것이 아닌 내가 직접 입력한 bean만 출력한다
            // 내가 입력한 bean만 출력하는 코드는 BeanDefinition.ROLE_APPLICATION
            if (beanDefinition.getRole() == BeanDefinition.ROLE_APPLICATION) {
                Object bean = ac.getBean(beanDefinitionName);
                System.out.println("name = " + beanDefinitionName + " object = " + bean);
            }
        }
    }
}

 

 

스프링 빈 조회 - 기본

 

각종 타입으로 스프링 컨테이너에 등록된 bean을 조회해보자.

package hello.core.beanfind;

import hello.core.AppConfig;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
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() {
        // bean의 이름으로도 조회가 가능하다.
        MemberService memberService = ac.getBean("memberService", MemberService.class);
        // 등록된 Bean이 MemberServiceImpl의 구현체기 때문에 테스트가 성공한다.
        assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
    }
    @Test
    @DisplayName("이름 없이 타입으로 조회")
    void findBeanByType() {
        // bean의 타입으로도 조회가 가능하다.
        MemberService memberService = ac.getBean(MemberService.class);
        // 등록된 Bean이 MemberServiceImpl의 구현체기 때문에 테스트가 성공한다.
        assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
    }

    @Test
    @DisplayName("구체 타입으로 조회")
    void findBeanByName2() {
        // 자바의 다형성으로 인해 구현체로도 조회가 가능하다.
        MemberService memberService = ac.getBean("memberService", MemberServiceImpl.class);
        // 등록된 Bean이 MemberServiceImpl의 구현체기 때문에 테스트가 성공한다.
        assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
    }
		@Test
	  @DisplayName("빈 이름으로 조회 X")
    void findBeanByNameX(){
        // ac.getBean("xxxx", MemberService.class);
        assertThrows(NoSuchBeanDefinitionException.class,
                () -> ac.getBean("xxxx", MemberService.class));
    }
}

 

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

 

타입으로 조회시 같은 타입 스프링 빈이 둘 이상이면 빈 이름을 지정해 혼선을 방지할 수 있다.

 

package hello.core.beanfind;

import hello.core.member.MemberRepository;
import hello.core.member.MemoryMemberRepository;
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.*;

public class ApplicationContextSameBeanFindTest {

    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SameBeanConfig.class);

    @Test
    @DisplayName("타입으로 조회시 같은 타입이 둘 이상 있으면 중복 오류가 발생한다.")
    void findBeanTypeDuplicate(){
//        MemberRepository bean = ac.getBean(MemberRepository.class);
        // 타입만 지정했음으로 sameBeanConfig에 등록된 2개의 Bean이 충돌해 예외가 터질수밖에 없다.
        // No qualifying bean of type 'hello.core.member.MemberRepository' available: expected single matching bean but found 2: memberRepository1,memberRepository2
        assertThrows(NoUniqueBeanDefinitionException.class,
                () -> ac.getBean(MemberRepository.class));
    }

    @Test
    @DisplayName("타입으로 조회시 같은 타입이 둘 이상 있으면 빈 이름을 지정하면 된다.")
    void findBeanByName() {
        // getBean 단계에서 빈의 이름을 매개변수로 전달하면 된다.
        MemberRepository memberRepository = ac.getBean("memberRepository1", MemberRepository.class);
        assertThat(memberRepository).isInstanceOf(MemberRepository.class);
    }

    @Test
    @DisplayName("특정 타입을 모두 조회하기.")
    void findAllBeanByType() {
        // MemberRepository의 타입을 가지고 있는 bean의 개수가 2개라서 Map 형태로 리턴하게 된다.
        Map<String, MemberRepository> beansOfType = ac.getBeansOfType(MemberRepository.class);
        // for문으로 해당 타입을 모두 조회해보자.
        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
    @Configuration
    static class SameBeanConfig {
        @Bean
        public MemberRepository memberRepository1() {
            return new MemoryMemberRepository();
        }

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

    }
}

 

스프링 빈 조회 - 상속관계

 

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

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

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

public class ApplicationContextExtendsFindTest {

    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);

    @Test
    @DisplayName("부모 타입으로 조회시, 자식이 둘 이상 있으면 중복 오류가 발생한다.")
    void findBeanByParentTypeDuplicate(){
        // DiscountPolicy의 구현체인 rateDiscountPolicy와 fixDiscountPolicy가 둘다 조회되서 오류가 발생한다.
//        DiscountPolicy bean = ac.getBean(DiscountPolicy.class);
        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();
        }
    }
}

 

BeanFactory와 ApplicationContext

 

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

 

BeanFactory

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

 

ApplicationContext가 제공하는 부가기능

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

 

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

 

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

 

 

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

 

지금까지 했던것.

 

XML 설정 사용

 

XML을 사용하면 컴파일 없이 빈 설정 정보를 변경할 수 있는 장점이 있다.

 

우선 appConfig.xml 을 resources에 생성해준다.

<?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 config를 바탕으로 테스트를 진행해보자.

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

 

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

 

스프링은 BeanDefinition 이라는 추상화를 통해 다양한 설정 형식을 지원한다.

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