-
Spring Container & BeanJava/Spring 2024. 12. 12. 21:11
스프링의 핵심 개념인 컨테이너와 빈에 대해 정리하였습니다.
< 컨테이너(Container)와 빈(Bean) >
컨테이너(Container) : 빈들의 생성, 관리, 의존성 설정 등을 담당하는 객체입니다.
빈(Bean) : 애플리케이션에서 필요한 기능을 수행하는 구성 요소로, 컨테이너에 의해 관리되는 자바 객체입니다.
컨테이너는 IoC(제어의 역전)에 따라 객체의 생성, 초기화, 소멸 등 생명주기를 관리하며, 의존성 주입(Dependency Injection)을 통해 필요한 의존 객체를 자동으로 연결합니다. 이에 따라 개발자는 필요한 빈을 선언하기만 하면 되고, 객체의 생성과 관리 등은 컨테이너가 담당하게 됩니다.
Ex) 스프링 컨테이너 생성
//스프링 컨테이너 생성 ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);
- ApplicationContext : 인터페이스, 스프링 컨테이너
- new AnnotationConfigApplicationContext(AppConfig.class) : ApplicationContext 인터페이스의 구현체
< 참고 1 >
스프링 컨테이너는 BeanFactory, ApplicationContext로 구분됩니다. 그러나 BeanFactory를 직접 사용하는 경우는 거의 없으므로 일반적으로 ApplicationContext를 스프링 컨테이너라고 합니다.
< 참고 2 >
XML 기반으로도 스프링 컨테이너를 만들 수 있고, 위의 경우처럼 어노테이션 기반의 자바 설정 클래스로도 스프링 컨테이너를 만들 수 있습니다.
< 스프링 컨테이너의 생성 과정 >
[ 1. 스프링 컨테이너 생성 ]
new AnnotationConfigApplicationContext(AppConfig.class)
: 스프링 컨테이너를 생성할 때는 구성 정보를 지정해주어야 합니다. 여기서는 AppConfig.class를 구성 정보로 지정하였습니다.
[ 2. 스프링 빈 등록 ]
: 스프링 컨테이너는 파라미터로 넘어온 구성 정보를 사용해서 스프링 빈을 등록합니다.
[ 빈(Bean) 이름 ]
- 빈 이름은 메서드 이름을 사용하지만, 직접 부여할 수도 있습니다.
@Bean(name="memberService2")
- 빈 이름은 항상 다른 이름을 부여해야 합니다. 같은 이름을 부여하면 다른 빈이 무시되거나, 기존 빈을 덮어버리는 등 오류가 발생할 수 있습니다.
[ 3. 스프링 빈 의존관계 설정 - 준비 ]
[ 4. 스프링 빈 의존관계 설정 - 완료 ]
: 스프링 컨테이너는 설정 정보를 참고해서 의존관계를 주입(DI)합니다.
+. 스프링은 빈을 생성하고, 의존관계를 주입하는 단계가 나누어져 있습니다. 그런데 이렇게 자바 코드로 스프링 빈을 등록하면 생성자를 호출하면서 의존관계 주입도 한번에 처리됩니다. 여기서는 이해를 돕기 위해 개념적으로 나누어 설명했습니다.
< 스프링 빈 조회 방법 >
Ex) 컨테이너에 등록된 모든 빈 조회
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 ROLE_APPLICATION : 직접 등록한 애플리케이션 빈 //Role ROLE_INFRASTRUCTURE : 스프링이 내부에서 사용하는 빈 if(beanDefinition.getRole() == BeanDefinition.ROLE_APPLICATION){ Object bean = ac.getBean(beanDefinitionName); System.out.println("name = " + beanDefinitionName + ", object = " + bean); } } } }
모든 빈 출력 : 스프링에 등록된 모든 빈 정보를 출력합니다.
- getBeanDefinitionNames() : 스프링에 등록된 모든 빈 이름을 조회한다.
- getBean() : 빈 이름으로 빈 객체(인스턴스)를 조회한다.
애플리케이션 빈 출력 : 스프링에 등록된 모든 빈 중 내가 등록한 빈만 출력합니다.
- getRole()
: ROLE_APPLICATION : 사용자가 정의한 빈
: ROLE_INFRASTRUCTURE : 스프링 자체에서 사용하는 빈
스프링 빈 조회 - 기본
1. 빈 이름과 빈 객체 타입을 이용해서 조회
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class); @Test @DisplayName("빈 이름으로 조회") void findByName() { MemberService memberService = ac.getBean("memberService", MemberService.class); assertThat(memberService).isInstanceOf(MemberServiceImpl.class); }
: getBean()에 두 개의 인자(빈 이름, 빈 객체 타입)를 전달해서 빈을 조회합니다.
2. 빈 객체 타입을 이용해서 조회
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class); @Test @DisplayName("이름 없이 타입으로 조회") void findByType(){ MemberService memberService = ac.getBean(MemberService.class); assertThat(memberService).isInstanceOf(MemberServiceImpl.class); }
: getBean()에 빈 이름 없이 빈 객체의 Type만을 전달해서 빈을 조회할 수 있습니다.
그러나 같은 타입의 빈이 여러 개인 경우 문제가 발생할 수 있다는 단점이 있습니다.3. 추상이 아닌 구체 타입으로 조회
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class); @Test @DisplayName("구체 타입으로 조회") void findByName2(){ MemberService memberService = ac.getBean("memberService", MemberServiceImpl.class); assertThat(memberService).isInstanceOf(MemberServiceImpl.class); }
: 구체화된 타입으로도 조회할 수 있지만, 변경시 유연성이 떨어진다는 단점이 있습니다.
스프링 빈 조회 - 동일한 타입이 둘 이상인 경우
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SameBeanConfig.class); @Test @DisplayName("타입으로 빈 조회시 같은 타입이 둘 이상 있으면, 중복 오류가 발생한다") void findBeanByTypeDuplicate() { assertThrows(NoUniqueBeanDefinitionException.class, () -> ac.getBean(MemberRepository.class)); }
: 빈 객체 타입만으로 빈 조회시 같은 타입이 둘 이상 있으면, 중복 오류가 발생합니다.
1. 빈 이름과 빈 객체 타입을 이용해서 조회
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SameBeanConfig.class); @Test @DisplayName("타입으로 조회시 같은 타입이 둘 이상 있으면, 빈 이름을 지정해서 조회한다") void findBeanByName() { MemberRepository memberRepository = ac.getBean("memberRepository1", MemberRepository.class); assertThat(memberRepository).isInstanceOf(MemberRepository.class); }
: getBean()을 이용하여 빈을 조회합니다.
2. 해당 타입의 모든 빈을 조회
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.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); }
: 같은 타입을 갖는 모든 빈을 조회합니다.
스프링 빈 조회 - 상속 관계에 있는 빈
: 부모 타입으로 조회하면, 자식 타입도 함께 조회합니다.
즉, 부모 클래스로 빈을 조회할 때 그 부모를 상속받은 모든 자식 클래스의 빈도 함께 조회된다는 뜻입니다.import ... public class ApplicationContextExtendsFindTest { AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class); @Test @DisplayName("부모 타입으로 조회시, 자식이 둘 이상 있으면, 중복 오류가 발생한다.") void findByParentTypeDuplicate(){ // assertThrows를 이용한 에러 발생 검증 테스트 구현 assertThrows(NoUniqueBeanDefinitionException.class, () -> ac.getBean(DiscountPolicy.class) ); } @Test @DisplayName("부모 타입으로 조회시, 자식이 둘 이상 있으면, 빈 이름을 지정하자.") void findByParentTypeBeanName(){ DiscountPolicy fixDiscountPolicy = ac.getBean("fixDiscountPolicy", DiscountPolicy.class); assertThat(fixDiscountPolicy).isInstanceOf(FixDiscountPolicy.class); } @Test @DisplayName("특정 하위 타입으로 조회") void findBeanBySubType(){ // 이건 별로 좋은 방법이 아니다. 구체에 의존하기 때문이다. RateDiscountPolicy rateDiscountPolicy = ac.getBean(RateDiscountPolicy.class); // FixDiscountPolicy fixDiscountPolicy = ac.getBean(FixDiscountPolicy.class); assertThat(rateDiscountPolicy).isInstanceOf(RateDiscountPolicy.class); } @Test @DisplayName("부모 타입으로 모두 조회") void findAllBeanByParentType(){ Map<String, DiscountPolicy> beansOfType = ac.getBeansOfType(DiscountPolicy.class); // beansOfType의 size가 2이면, 성공하는 테스트로 구현하자. assertThat(beansOfType.size()).isEqualTo(2); // 지금은 공부용으로 출력하도록 짜는 것이지, 실무에서는 출력하지 않는 것이 원칙이다. // 시스템 규모가 커지면, 일일이 보고있을 수 없기 때문이다. for (String key : beansOfType.keySet()) { System.out.println("key = " + key+ " value = " + beansOfType.get(key)); } } @Test @DisplayName("부모 타입으로 모두 조회하기 - Object type") void findAllBeanByObjectType(){ Map<String, Object> beansOfType = ac.getBeansOfType(Object.class); for (String key : beansOfType.keySet()) { System.out.println("key = " + key+ " value = " + beansOfType.get(key)); } // spring에 있는 내부적인 bean까지 전부 튀어나온다. } @Configuration static class TestConfig{ @Bean public DiscountPolicy rateDiscountPolicy(){ return new RateDiscountPolicy(); } @Bean public DiscountPolicy fixDiscountPolicy(){ return new FixDiscountPolicy(); } } }
< BeanFactory와 ApplicationContext >
BeanFactory
- 스프링 컨테이너의 최상위 인터페이스
- 스프링 빈을 관리하고 조회하는 역할
- getBean() 및 대부분의 필요 기능 제공
ApplicationContext
- BeanFactory 기능을 모두 상속받아서 제공
- 단순하게 Bean을 관리하는 것을 떠나서, 애플리케이션을 개발하기 위해 공통적으로 필요한 많은 부가 기능을 제공하기 위해 ApplicationContext를 사용
ApplicationContext에서 제공하는 부가 기능 :
- 메세지 소스를 활용한 국제화 기능
: 예를 들어 한국에서 들어오면 한국어로, 영어권에서 들어오면 영어로 출력하는 부가 기능을 제공 - 환경 변수
: 환경(로컬, 개발, 운영 등)별로 구분해서 처리 - 애플리케이션 이벤트
: 이벤트를 발행하고 구독하는 모델을 편리하게 지원 - 편리한 리소스 조회
: 파일, 클래스 패스, 외부 등에서 리소스를 편리하게 조회
[ 정리 ]
- BeanFactory를 직접 사용할 일은 거의 없습니다. 부가 기능이 포함된 ApplicationContext를 대신 사용합니다.
- BeanFactory와 ApplicationContext를 스프링 컨테이너라고 부릅니다.
< 다양한 설정 형식 지원 - JAVA, XML >
스프링 컨테이너는 Java, XML, Grooby 등 다양한 형식의 설정 정보를 받아들일 수 있도록 유연하게 설계되어 있습니다.
Annotation 기반 자바 코드 설정 사용
- 앞서 계속해서 사용해온 방식입니다. (@Configuration, @Bean 등의 Annotation을 사용)
- new AnnotationConfigApplicationContext(AppConfg.class)와 같은 코드로 설정합니다.
- AnnotationConfigApplicationContext 클래스를 사용하면서, 자바 코드로 된 설정 정보를 넘기면 된다.
Ex)
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration public class AppConfig { @Bean public MemberService memberService() { return new MemberServiceImpl(memberRepository()); } @Bean public static MemoryMemberRepository memberRepository() { return new MemoryMemberRepository(); } @Bean public OrderService orderService() { return new OrderServiceImpl(memberRepository(), discountPolicy()); } @Bean public DiscountPolicy discountPolicy() { return new RateDiscountPolicy(); } }
XML 설정 사용
- 최근에는 스프링 부트를 많이 사용하면서, XML 기반의 설정은 잘 사용하지 않습니다. 하지만, 아직 많은 legacy project들이 XML 기반으로 되어 있고, 또 XML을 사용하면 컴파일 없이 빈 설정 정보를 변경할 수 있는 장점도 있습니다.
- GenericXmlApplicationContext를 사용하면서 xml 설정 파일을 넘기면 됩니다.
Ex)
<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>
< BeanDefinition - 스프링 빈 설정 메타 정보 >
스프링에서 다양한 방식으로 빈 설정 정보를 세팅할 수 있는 이유는 `BeanDefinition`이라는 추상화 덕분입니다.
`BeanDefinition`은 빈 설정의 메타정보를 담고 있으며, 스프링 컨테이너는 이 정보를 통해 스프링 빈을 생성합니다.
이 덕분에 스프링 컨테이너는 자바 코드 기반 설정인지, XML 기반 설정인지에 관계없이 오직 `BeanDefinition`만으로 빈을 관리할 수 있습니다.BeanDefinition - AnnotationConfigApplicationContext는 AnnotatedBeanDefinitionReader를 사용해 AppConfig.class(인자로 들어옴)를 읽고, BeanDefinition을 생성합니다.
- GenericXmlApplicationContext는 XmlBeanDefinitionReader를 사용해 appConfig.xml 설정 정보를 읽어 BeanDefinition을 생성합니다.
- 새로운 형식의 설정 정보가 추가되면, XxxBeanDefinitionReader를 만들어 BeanDefinition을 생성하도록 직접 구현할 수도 있습니다.
Ex : BeanDefinition이 갖고 있는 다양한 빈에 대한 정보 조회
@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); } } }
해당 글에 포함된 코드나 그림은 김영한님이 제공해주신 자료를 바탕으로 작성되었습니다.
스프링 핵심 원리 - 기본편 강의 | 김영한 - 인프런
스프링 핵심 원리 - 기본편 강의 | 김영한 - 인프런
김영한 | 스프링 입문자가 예제를 만들어가면서 스프링의 핵심 원리를 이해하고, 스프링 기본기를 확실히 다질 수 있습니다., 스프링 핵심 원리를 이해하고, 성장하는 백엔드 개발자가 되어보
www.inflearn.com
'Java > Spring' 카테고리의 다른 글
Component Scan (3) 2024.12.20 Singleton Container (0) 2024.12.18 Object-Oriented Design and Spring (46) 2024.11.19 Custom Queries with JPA (5) 2024.10.15 Add a Database with JPA (8) 2024.10.14