스프링 컨테이너와 스프링 빈 (스프링 컨테이너 생성+과정, 스프링 빈 조회, BeanDefinition)
스프링 핵심 원리 이해 ② - 2 (SOLID 적용 정리, IoC, DI, Spring 전환)
스프링 핵심 원리 이해 ② - 2 (SOLID 적용 정리, IoC, DI, Spring 전환)
스프링 핵심 원리 이해 ② - 1 (객체 지향 원리 적용, AppConfig) 스프링 핵심 원리 이해 ② - 1 (객체 지향 원리 적용, AppConfig) 스프링 핵심 원리 이해 ① - 2 (주문, 할인 도메인 설계, 테스트 ) 스프링
soohykeee.tistory.com
앞서 우리는 프로젝트를 스프링으로 전환하면서, 스프링 컨테이너 IoC, DI 를 공부했다. 이번에는 스프링 컨테이너가 생성되는 과정을 알아보겠다.
스프링 컨테이너 생성
ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);- ApplicationContext를 스프링 컨테이너라고 한다
- ApplicationContext는 인터페이스이다.
- AnnotationConfigApplicationContext는 해당 인터페이스의 구현체이다.
- 스프링 컨테이너는 XML 기반, 어노테이션 기반의 자바 설정 클래스로 만들 수 있다. 위의 방식은 2방식 중에 어노테이션 기반의 자바 설정 클래스로 만든 것이다.
더 자세히 얘기하자면, 스프링 컨테이너를 부를 때 BeanFactory, ApplicationContext로 구분해서 얘기한다. 하지만 일반적으로 BeanFactory를 직접 사용하는 경우는 드물기에 일반적으로 ApplicationContext를 스프링 컨테이너라 한다.
스프링 컨테이너 생성 과정
- 스프링 컨테이너 생성
- 스프링 빈 등록
- 스프링 빈 의존관계 설정 준비
- 스프링 빈 의존관계 설정 완료
스프링 컨테이너의 생성 과정은 간다하게 보면 위의 과정을 따른다. 해당 과정을 자세히 보면 다음과 같다.
new AnnotationConfigApplicationContext(AppConfig.class) 를 실행하면 AppConfig.class를 구성 정보로 활용하여 스프링 컨테이너가 생성이 되고, 스프링 빈 저장소가 생성이 된다.
스프링 컨테이너는 파라미터로 넘어온 설정 클래스 정보를 사용해서 스프링빈을 등록한다. @Bean 어노테이션이 붙은 것들을 저장소에 저장하는 것이다.
일반적으로 여기서 빈 이름은 메서드 이름을 사용한다. 빈 이름을 다음과 같이 직접 부여할수도 있지만 추천하진 않는다. @Bean(name="memberService2")
주의사항 : 빈 이름은 항상 다른 이름을 부여해야 한다. 만약 동일한 빈 이름이 존재한다면, 다른 빈이 무시되거나, 기존의 빈을 덮어버려 설정에 오류가 발생할 수 있다.
스프링 컨테이너는 설정 정보를 참고해서 의존관계를 주입(DI) 한다. 단순히 자바 코드를 호출하는 것 같지만, 차이가 있다. 해당 차이는 뒤에 설명할 것이다.
참고
: 스프링 빈을 생성하고 의존관계를 주입하는 단계를 나누어 설명하였지만, 실제로 자바 코드로 스프링 빈을 등록하면 두 단계가 한번에 처리된다. 설명을 위해 나누어 설명한 것이다.
정리
: 스프링 컨테이너를 생성하고, 설정(구성) 정보를 참고해서 스프링 빈도 등록하고, 의존관계도 설정했다.
컨테이너에 등록된 모든 빈 조회
위의 설명했듯이 정말로 빈이 모두 컨테이너에 저장이 되었는지 확인해보기 위해서 테스트 코드를 작성해줄 것이다.
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);
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 : 스프링 내부에서 사용하는 빈
스프링 빈 조회 - 기본
package com.example.core.beanfind;
import com.example.core.AppConfig;
import com.example.core.member.MemberService;
import com.example.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.assertThat;
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() {
// MemberService xxxxx = ac.getBean("xxxxx", MemberService.class);
// 등록되지 않은 빈 이름이기에 exception이 발생되어야한다.
Assertions.assertThrows(NoSuchBeanDefinitionException.class, () -> ac.getBean("xxxxx", MemberService.class));
}
}
이름없이 타입으로만 조회하면, 해당 타입으로 생성된 빈이 여러개일 경우 문제가 될 수 있다. 또한 구체타입으로 조회하는 것도 바람직한 방법이 아니기에, ac.getBean(빈이름, 타입) 으로 스프링 빈을 찾는 방법이 가장 바람직하다.
또한, 생성되지 않은 빈 이름으로 조회시에 NoSuchBeanDefinitionException이 발생한다. 실패 테스트 또한 테스트에 필수로 해봐야 하기 때문에 예외가 발생하는지 테스트 코드를 작성한 것이다.
스프링 빈 조회 - 동일한 타입이 둘 이상
앞서 말했듯이 타입으로 조회 시 같은 타입의 스프링빈이 둘 이상이면 오류가 발생한다. 이럴때는 빈 이름을 지정해야한다.
package com.example.core.beanfind;
import com.example.core.AppConfig;
import com.example.core.member.MemberRepository;
import com.example.core.member.MemoryMemberRepository;
import org.junit.jupiter.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.AssertionsForClassTypes.assertThat;
public class ApplicationContextSameBeanFindTest {
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SameBeanConfig.class);
@Configuration
static class SameBeanConfig {
@Bean
public MemberRepository memberRepository1() {
return new MemoryMemberRepository();
}
@Bean
public MemberRepository memberRepository2() {
return new MemoryMemberRepository();
}
}
@Test
@DisplayName("타입으로 조회 시 같은 타입이 둘 이상 있으면, 중복 오류 발생")
void findBeanByTypeDuplicate() {
// MemberRepository memberRepository = ac.getBean(MemberRepository.class);
Assertions.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);
}
}
스프링 빈 조회 - 상속 관계
부모 타입으로 조회하면, 자식 타입도 함께 조회된다. 따라서 모든 자바의 객체의 최고 부모인 Object 타입으로 조회하면, 모든 스프링 빈을 조회한다.
package com.example.core.beanfind;
import com.example.core.discount.DiscountPolicy;
import com.example.core.discount.FixDiscountPolicy;
import com.example.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);
@Configuration
static class TestConfig {
@Bean
public DiscountPolicy rateDiscountPolicy() {
return new RateDiscountPolicy();
}
@Bean
public DiscountPolicy fixDiscountPolicy() {
return new FixDiscountPolicy();
}
}
@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));
}
}
}
다양한 설정 형식 지원 - 자바 코드, XML
앞서 AppConfig는 어노테이션 기반 자바 코드 설정으로 했다. 하지만 다른 방식인 XML을 사용하는 법도 있다고 언급했었다. 이번에는 XML 기반의 설정을 해볼것이다.
XML 설정
최근 스프링 부트를 많이 사용하면서 XML 기반의 설정은 잘 사용하지 않는 추세이다. 하지만 아직 많은 레거시 프로젝트들이 XML로 설정되어 있고, 또한 XML 설정을 사용하면 컴파일 없이 빈 설정 정보를 변경할 수 있다는 장점도 있기에 알아두는 것이 좋다. 다음은 XML설정을 사용하는 코드이다.
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 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="com.example.core.member.MemberServiceImpl">
<constructor-arg name="memberRepository" ref="memberRepository"/>
</bean>
<bean id="memberRepository" class="com.example.core.member.MemoryMemberRepository"/>
<bean id="orderService" class="com.example.core.order.OrderServiceImpl">
<constructor-arg name="memberRepository" ref="memberRepository" />
<constructor-arg name="discountPolicy" ref="discountPolicy"/>
</bean>
<bean id="discountPolicy" class="com.example.core.discount.RateDiscountPolicy"/>
</beans>
위의 appConfig.xml 파일을 자세히 보면, 기존에 만들었던 AppConfig.class 파일과 형식만 다를 뿐 동일하다. 위처럼 코드를 작성한 후에, 작성한 Test파일을 실행하면 테스트가 성공적으로 되는것을 확인할 수 있다.
xml 기반 설정은 잘 사용하지 않기에 이정도로만 알아두고, 더 자세히 알아보고 싶으면 스프링 공식 레퍼런스 문서를 통해 확인해보면 된다.
https://spring.io/projects/spring-framework
Spring | Home
Cloud Your code, any cloud—we’ve got you covered. Connect and scale your services, whatever your platform.
spring.io
스프링 빈 설정 메타 정보 - BeanDefinition
위처럼 스프링이 다양한 설정 형식을 지원하는 이유는 BeanDefinition 인터페이스가 있기 때문이다. 스프링 컨테이너는 자바 코드, XML 어떤것이 들어오든 오직 BeanDefinition만 알면 된다. BeanDefinition은 빈 설정 메타정보라고 한다. 스프링 컨테이너는 이 메타정보를 기반으로 스프링 빈을 생성한다.
- 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 : 의존관계 주입에서 사용한다. (자바 설정 처럼 팩토리 역할의 빈을 사용하면 없음)
정리
BeanDefinition을 직접 생성해서 스프링 컨테이너에 등록할 수 도 있다. 하지만 실무에서 BeanDefinition을 직접 정의하거나 사용할 일은 거의 없다. BeanDefinition에 대해서는 너무 깊이있게 이해하기 보다는, 스프링이 다양한 형태의 설정 정보를 BeanDefinition으로 추상화해서 사용하는 것 정도만 이해하면 된다. 가끔 스프링 코드나 스프링 관련 오픈 소스의 코드를 볼 때, BeanDefinition 이라는 것이 보일 때가 있다. 이때 이러한 메커니즘을 떠올리면 된다