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

유병익·2022년 10월 17일
Spring
0

스프링 핵심 원리

목록 보기
4/9
post-thumbnail

1. 스프링 컨테이너 생성

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

ApplicationContext applicationContext = 
new AnnotationConfigApplicationContext(AppConfig.class);
  • ApplicationContext를 스프링 컨테이너라 한다.
  • ApplicationContext는 Interface
  • new annotationConfigApplicationContext(AppConfig.class); → ApplicationContext의 구현체

  • 스프링 컨테이너를 생성할 때는 구성 정보를 지정해주어야 한다. (여기선 AppConfig.class)

1.1.1 스프링 빈 등록

  • 스프링 컨테이너는 파라미터로 넘어온 설정 클래스 정보를 사용해서 스프링 빈을 등록한다.
  • 빈 이름
    • 빈 이름은 메서드 이름을 사용한다.
    • 빈 이름을 직접 부여할 수 도 있다. ex) @Bean(name="memberService2")

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

다른 빈을 무시 or 덮어 씌움 -> 설정에 따라 오류 발생

1.1.2 스프링 빈 의존관계 설정

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

1.1.3 모든 빈 조회

  • 모든 빈 출력하기
    • ac.getBeanDefinitionNames() :스프링에 등록된 모든 빈 이름을 조회한다.
    • ac.getBean(): 빈 이름으로 빈 객체(인스턴스)를 조회한다.
  • 애플리케이션 빈 출력하기
    • 스프링이 내부에서 사용하는 빈은 제외하고, 내가 등록한 빈만 출력
    • 스프링이 내부에서 사용하는 빈은 getRole() 로 구분
    • ROLE_APPLICATION : 일반적으로 사용자가 정의한 빈
    • ROLE_INFRASTRUCTURE : 스프링이 내부에서 사용하는 빈
  • 스프링 컨테이너에 등록된 모든 빈 조회 Code
    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);
						 }
				 }
		 }
}

2. 스프링 빈 조회

2.1 기본

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

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

💡 조회 대상 스프링 빈이 없으면 예외 발생

2.1.1 Example

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
		 @DisplayName("빈 이름으로 조회X")
		 void findBeanByNameX() {
				 //ac.getBean("xxxxx", MemberService.class);
				 Assertions.assertThrows(NoSuchBeanDefinitionException.class, () ->
				 ac.getBean("xxxxx", MemberService.class));
		 }
}

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

2.2 동일한 타입이 둘 이상

  • 타입으로 조회시 같은 타입의 스프링 빈이 둘 이상이면 오류 발생 → 빈 이름 지정으로 해결
  • ac.getBeansOfType() 을 사용하면 해당 타입의 모든 빈을 조회할 수 있다.

2.2.1 Example

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() {
				 //DiscountPolicy 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();
				 }
		 }
}

2.3 상속 관계

  • 부모 타입으로 조회하면, 자식 타입도 함께 조회한다.
  • Object타입으로 조회하면, 모든 스프링 빈을 조회한다.

2.3.1 Example

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

3. BeanFactory & ApplicationContext

3.1 BeanFactory

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

3.2 ApplicationContext

  • BeanFactory 기능을 모두 상속
  • 빈은 관리하고 조회하는 기능은 물론이고, 수 많은 부가기능 제공
    • 메시지소스를 활용한 국제화 기능
    • 환경변수
    • 애플리케이션 이벤트
    • 편리한 리소스 조회

3.3 요약

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

ApplicationContext는 빈 관리기능 + 편리한 부가 기능을 제공한다.

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

4. 설정 형식

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

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

  • 지금까지 했던 방식
  • new AnnotationConfigApplicationContext(AppConfig.class)
  • AnnotationConfigApplicationContext 클래스에 설정 정보(AppConfig.class)전달

4.2 XML 설정 사용

  • 잘 사용하지는 않음
  • 많은 레거시 프로젝트들이 XML로 되어 있음
  • XML을 사용하면 컴파일 없이 빈 설정 정보를 변경할 수 있는 장점이 있음
  • GenericXmlApplicationContext를 사용하면서 XML설정 파일을 넘기면 된다.

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

4.2.2 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>

5. Bean Definition

  • BeanDefinition : 빈 설정 메타정보
  • 스프링 컨테이너는 BeanDefinition 을 기반으로 스프링 빈을 생성

업로드중..

  • AnnotationConfigApplicationContext는 AnnotatedBeanDefinitionReader를 사용해 AppConfig.class 를 읽고 BeanDefinition을 생성
  • GenericXmlApplicationContext는 XmlBeanDefinitionReader를 사용해서 appConfig.xml 설정
    정보를 읽고 BeanDefinition을 생성한다.
  • 새로운 형식의 설정 정보가 추가되면, XxxBeanDefinitionReader를 만들어서 BeanDefinition 을 생성하면 된다.

요약

  • BeanDefinition을 직접 생성해서 스프링 컨테이너에 등록할 수도 있다.
  • 실무에서 BeanDefinition을 직접 정의하거나 사용할 일은 거의 없다.
  • 다양한 형태의 설정 정보를 BeanDefinition으로 추상화해서 사용하는 정도만 이해하자
profile
유병익
Backend 개발자가 되고 싶은
이전 포스트

스프링 핵심 원리 이해 2

다음 포스트

싱글톤 컨테이너

0개의 댓글