카테고리 없음

4. 스프링 컨테이너와 스프링 빈 (-ing)

wlalsu_u 2023. 5. 20. 16:33

4.1 스프링 컨테이너 생성

 

 

스프링 컨테이너가 생성되는 과정은 다음과 같다.

 

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

 

 

 

- ApplicationContext 를 스프링 컨테이너

 

- ApplicationContext 는 인터페이스

 

- AnnotationConfigApplicationContext는 구현체

 

 

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

(최근 XML 방식은 거의 사용되지 않는다.)

 

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

 

자바 설정 클래스를 기반으로 스프링 컨테이너( ApplicationContext )를 만들어보자.

new AnnotationConfigApplicationContext(AppConfig.class);

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

 

 

[ 참고 ]
더 정확히는 스프링 컨테이너를 부를 때 BeanFactory , ApplicationContext 로 구분해서 이야기한다.
BeanFactory 를 직접 사용하는 경우는 거의 없기 때문에,
일반적으로 ApplicationContext = 스프링 컨테이너

 

 

 

 

 

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

 

 

 

1. new AnnotationConfigApplicationContext(AppConfig.class)

2. 스프링 컨테이너를 생성할 때는 구성 정보를 지정해주어야 한다. (AppConfig.class를 파라미터로 넘긴 이유)

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

 

 

 

 

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

 

@Bean 붙은거를 모두 찾아본다.

4개를 모두 스프링빈에 등록

 

 

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

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

@Bean(name="memberService2") >

 

 

 

[ 주의 ]
빈 이름은 항상 다른 이름을 부여해야 한다.
같은 이름을 부여하면, 다른 빈이 무시되거나 기존 빈을 덮어버리거나 설정에 따라 오류가 발생
(최근 스프링 부트는 경고를 주면서 튕겨나갈 수 있음)

 

 

스프링 빈을 동그라미로 표현

 

 

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

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

 

orderService는 2개 의존 (동적인 의존관계를 설정)

 

 

[ 참고 ]

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

 

 

[ 정리 ]

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

 

 


 

 

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

 

 

 

@Bean 을 사용했을 때,

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

 

 

package hello.core.beanfind;
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 static org.assertj.core.api.Assertions.assertThat;
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 ROLE_APPLICATION: 직접 등록한 애플리케이션 빈
 //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_INFRASTRUCTURE : 스프링이 내부에서 사용하는 빈

 

 

 

 


 

4.3 스프링 빈 조회 - 기본

 

 

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

 

 

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

 

조회 대상 스프링 빈이 없으면 예외 발생
NoSuchBeanDefinitionException: No bean named 'xxxxx' available

 

 

package hello.core.beanfind;
import hello.core.AppConfig;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
import org.junit.jupiter.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.*;
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
 @Test
 @DisplayName("빈 이름으로 조회X")
 void findBeanByNameX() {
 //ac.getBean("xxxxx", MemberService.class);
 Assertions.assertThrows(NoSuchBeanDefinitionException.class, () -> ac.getBean("xxxxx", MemberService.class));
 }
}

 

 

구현체에 의존하지 않고, 인터페이스에만 의존해야 하므로

구체 타입으로 조회하면 변경시 유연성이 떨어진다.

 

 


 

 

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

 

 

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

 

-> 빈 이름을 지정해야 한다!

 

 

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.assertThat;
import static org.junit.jupiter.api.Assertions.assertThrows;
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);
 }
 
 // test에서만 사용할 Config 작성
 @Configuration
 static class SameBeanConfig {
 @Bean
 public MemberRepository memberRepository1() {
 return new MemoryMemberRepository();
 }
 @Bean
 public MemberRepository memberRepository2() {
 return new MemoryMemberRepository();
 }
 }
}

 

 

SameBeanConfig

- 동일한 타입인 memberRepository 1 과 2 가 모두 Bean에 등록 

 

 

 

 

ac.getBeansOfType()

 

- 해당 타입의 모든 빈 조회 가능

 

- Map(key, value) 형태로 출력

 

 


 

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

 

 

스프링빈이 상속관계일때, 부모 타입으로 조회하면 자식 타입도 조회된다

 

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

 

 

 

package hello.core.beanfind;
import hello.core.discount.DiscountPolicy;
import hello.core.discount.FixDiscountPolicy;
import hello.core.discount.RateDiscountPolicy;
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.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.assertThrows;
class ApplicationContextExtendsFindTest {

 AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
 
 @Test
 @DisplayName("부모 타입으로 조회시, 자식이 둘 이상 있으면, 중복 오류가 발생한다")
 void findBeanByParentTypeDuplicate() {
 //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();
 }
 }
}

 

 

 


 

4.6  BeanFactory 와 ApplicationContext

 

 

 

BeanFactory

 

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

- 스프링 빈을 관리하고 조회하는 역할을 모두 담당

- getBean() 을 제공

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

 

 

ApplicationContext

 

- BeanFactory 기능을 모두 상속받아 제공

 

 

 

그렇다면,  BeanFactory 와의 차이점이 무엇일까?

 

애플리케이션을 개발할 때는 빈을 관리하고 조회하는 기능뿐만 아니라,
수많은 부가 기능이 필요!

 

 

 

 

 

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

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

 

 

EnvironmentCapable : 환경변수

개발환경 (로컬, 개발, 운영) 별로, 어떤 데이터베이스를 연결해야 할지 구분해서 처리

 

 

ApplicationEventPublisher : 애플리케이션 이벤트

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

 

 

ResourceLoader : 편리한 리소스 조회

파일, 클래스패스 등을 외부에서 끌어와서 쓸 때, 리소스를 편리하게 조회

 

 

 

[ 정리 ]

1. ApplicationContext는 BeanFactory의 기능을 상속받음
2. ApplicationContext는 빈 관리기능 + 편리한 부가 기능을 제공
3. BeanFactory를 직접 사용할 일은 거의 없음. ApplicationContext를 사용
4. BeanFactory나 ApplicationContext를 스프링 컨테이너라고 부름

 

 


 

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

 

 

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

(자바 코드, XML, Groovy 등)

 

 

 

 

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

 

- new AnnotationConfigApplicationContext(AppConfig.class)

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

 

 

XML 설정 사용

 

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

아직 많은 레거시 프로젝트 들이 XML로 되어 있고, 또 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.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 기반의 스프링 빈 설정 정보

<?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 설정 정보' 는 거의 비슷하다!

 

 

 

[스프링 공식 레퍼런스 문서]

 

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

 

Spring Framework

The Spring Framework provides a comprehensive programming and configuration model for modern Java-based enterprise applications - on any kind of deployment platform. A key element of Spring is infrastructural support at the application level: Spring focuse

spring.io

 

 


 

 

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

 

 

스프링은 어떻게 이런 다양한 설정 형식을 지원하는 것일까?

그 중심에는 BeanDefinition 이라는 추상화가 있다.

 

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

XML을 읽어서 BeanDefinition을 만들면 된다.

자바 코드를 읽어서 BeanDefinition을 만들면 된다.

스프링 컨테이너는 자바 코드인지, XML인지 몰라도 된다. 오직 BeanDefinition만 알면 된다.

 

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

@Bean , 당 각각 하나씩 메타 정보가 생성된다.

 

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

 

스프링 컨테이너는 추상화에만 의존

 

 

 

 

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

 

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

 

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

 

 

 

 

BeanDefinition 정보

 

BeanClassName: 생성할 빈의 클래스 명(자바 설정 처럼 팩토리 역할의 빈을 사용하면 없음)

factoryBeanName: 팩토리 역할의 빈을 사용할 경우 이름, 예) appConfig

factoryMethodName: 빈을 생성할 팩토리 메서드 지정, 예) memberService

Scope: 싱글톤(기본값)

lazyInit: 스프링 컨테이너를 생성할 때 빈을 생성하는 것이 아니라, 실제 빈을 사용할 때 까지 최대한 생성을 지연처리 하는지 여부

InitMethodName: 빈을 생성하고, 의존관계를 적용한 뒤에 호출되는 초기화 메서드 명

DestroyMethodName: 빈의 생명주기가 끝나서 제거하기 직전에 호출되는 메서드 명

Constructor arguments, Properties: 의존관계 주입에서 사용한다. (자바 설정 처럼 팩토리 역할의 빈을 사용하면 없음)

 

 

package hello.core.beandefinition;
import hello.core.AppConfig;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.beans.MutablePropertyValues;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.config.ConstructorArgumentValues;
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);
 }
 }
 }
}

 

 

 

[ 정리 ]

- BeanDefinition을 직접 생성해서 스프링 컨테이너에 등록할 수 도 있다. (실무에서 거의 사용 X)
- BeanDefinition에 대해 너무 깊이있게 이해 보다, 스프링이 다양한 형태의 설정 정보를 BeanDefinition으로 추상화해서 사용하는 것 정도만 이해하면 된다.