[스프링 핵심 원리 - 기본편] 4. 스프링 컨테이너와 스프링 빈

본 게시글은 김영한 강사님의 [스프링 핵심 원리 - 기본편]을 수강하며 작성한 글입니다.

 

스프링 컨테이너 생성

---

스프링 컨테이너 생성

ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);

• ApplicationContext는 스프링 컨테이너이다.
• 이는 인터페이스인데, 이를 구현한 클래스가 AnnotationConfigApplicationContext이다.
• 스프링 컨테이너는 XML로도, 애노테이션 기반의 자바 설정 클래스로도 만들 수 있다.

💡 더 정확히는 스프링 컨테이너를 부를 때 BeanFactory, ApplicationContext로 구분한다. 뒤에서 더 자세히 배우겠지만, BeanFactory를 직접 사용하는 경우는 거의 없으므로 일반적으로 ApplicationContext를 스프링 컨테이너라 한다.

 

스프링 컨테이너 생성 과정

1. 스프링 컨테이너 생성

new AnnotationConfigApplicationContext(AppConfig.class)

스프링 컨테이너를 생성할 때는 구성 정보를 지정해 넘겨주어야 한다.

또한 스프링 컨테이너 내에는 빈(Bean) 저장소가 있다. 빈 저장소는 빈 이름을 Key로 가지고, 빈 객체를 값으로 가지는 저장소이다.

 

 

2. 스프링 빈 등록

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

💡 빈(Bean) 이름
- 빈 이름은 기본적으로 메소드 이름을 사용하나, @Bean(name="memberSerivce2")와 같이 직접 지정할 수도 있다.
- 빈 이름은 항상 다른 이름을 부여해야 한다. 같은 이름을 부여하면 다른 빈이 무시되거나, 기존 빈을 덮어버리는 오류가 발생할 수 있다.

 

 

3. 스프링 빈 의존관계 설정 - 준비

 

4. 스프링 빈 의존관계 설정 - 완료

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

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

 

스프링 컨테이너를 생성하고, 설정 정보를 참고해서 스프링 빈을 등록하고, 의존관계도 설정했다.

이제 스프링 컨테이너에서 데이터를 조회해보자.

 

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

---

스프링 컨테이너에 등록한 스프링 빈들이 잘 등록되었는지 확인한다.

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(): 빈 이름으로 빈 객체(인스턴스)를 조회한다.

• 애플리케이션 빈 출력하기
  • ac.getBeanDefinition(): 빈 이름으로 빈의 메타데이터를 조회한다.
  • getRole(): 빈의 메타데이터에서 역할을 조회한다.
    • ROLE_APPLICATION: 직접 등록한 애플리케이션 빈
    • ROLE_INFRASTRUCTURE: 스프링이 내부에서 사용하는 빈

 

스프링 빈 조회 - 기본

---

스프링 빈 기본 조회 방법

1. ac.getBean(빈 이름, 타입): 빈 이름 & 타입으로 빈 조회
2. ac.getBean(타입): 타입으로만 빈 조회

조회 대상 스프링 빈이 없으면 NoSuchBeanDefinitionException 예외가 발생한다.

 

1) findBeanByName() - 빈 이름 & 타입으로 빈 조회

@Test
@DisplayName("빈 이름으로 조회")
void findBeanByName() {
    MemberService memberService = ac.getBean("memberService", MemberService.class);
    assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
}

 

2) findBeanByType() - 타입만으로 빈 조회

@Test
@DisplayName("이름 없이 타입으로만 조회")
void findBeanByType() {
    MemberService memberService = ac.getBean(MemberService.class);
    assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
}

 

3) findBeanByName2() - 빈 이름 & 구체 타입으로 빈 조회

@Test
@DisplayName("구체 타입으로 조회")
void findBeanByName2() {
    MemberServiceImpl memberService = ac.getBean("memberService", MemberServiceImpl.class);
    assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
}

구체 타입으로 조회하면 변경시 유연성이 떨어지므로 좋은 방법이 아니다.

 

4) findBeanByNameX() - 빈 이름 & 타입으로 빈 조회되지 않는 경우

@Test
@DisplayName("빈 이름으로 조회X")
void findBeanByNameX() {
    assertThrows(NoSuchBeanDefinitionException.class,
            () -> ac.getBean("xxxxx", MemberService.class));
}

assertions.assertThrows()를 사용하여 조회한 빈이 없을 때 NoSuchBeanDefinitionException 예외를 발생시키는지 검증한다.

 

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

---

같은 타입의 스프링 빈이 둘 이상이면 NoUniqueBeanDefinitionException 예외가 발생한다. 이때는 빈 이름을 지정하자.

참고로 ac.getBeansOfType()을 사용하면 해당 타입의 모든 빈을 조회할 수 있다.

 

1) SameBeanConfig - 설정 정보 클래스

AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SameBeanConfig.class);

@Configuration
static class SameBeanConfig {
    @Bean
    public MemberRepository memberRepository1() {
        return new MemoryMemberRepository();
    }

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

이 테스트 클래스 내에서만 사용하기 위해 만든 Config 클래스이기 때문에 static으로 선언하였다.

빈의 이름은 다르지만 타입이 MemberRepository인 빈 2개를 등록한다.

 

2) findBeanByTypeDuplicate() - getBean(타입)으로 조회 시 같은 타입이 2개 이상이면 중복 오류 발생

@Test
@DisplayName("타입으로 조회 시 같은 타입이 둘 이상 있으면, 중복 오류가 발생한다.")
void findBeanByTypeDuplicate() {
    assertThrows(NoUniqueBeanDefinitionException.class,
            () -> ac.getBean(MemberRepository.class));
}

assertions.assertThrows()를 사용하여 같은 타입의 빈이 둘 이상 존재할 때 NoUniqueBeanDefinitionException 예외를 발생시키는지 검증한다.

 

3) findBeanByName() - 같은 타입이 2개 이상이어도 getBean(빈 이름, 타입)으로 조회하면 성공

@Test
@DisplayName("타입으로 조회 시 같은 타입이 둘 이상 있으면, 빈 이름을 지정하며 된다.")
void findBeanByName() {
    MemberRepository memberRepository = ac.getBean("memberRepository1", MemberRepository.class);
    assertThat(memberRepository).isInstanceOf(MemberRepository.class);
}

 

4) findAllBeanByType() - 특정 타입을 가진 모든 빈 조회

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

ac.getBeansOfType()를 사용하면 해당 타입의 모든 빈을 조회할 수 있다.

 

스프링 빈 조회 - 상속 관계

---

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

그렇기 때문에 모든 자바 객체의 부모인 Object로 조회하면, 모든 스프링 빈을 조회할 수 있게 된다.

 

1) TestConfig - 설정 정보 클래스

@Configuration
static class TestConfig {
    @Bean
    public DiscountPolicy rateDiscountPolicy() {
        return new RateDiscountPolicy();
    }

    @Bean
    public DiscountPolicy fixDiscountPolicy() {
        return new FixDiscountPolicy();
    }
}

부모 타입이 DiscountPolicy인 빈 2개(rateDiscountPolicy, fixDiscountPolicy)를 등록한다.

 

2) findBeanByParentTypeDuplicate() - getBean(부모 타입)으로 조회 시, 자식이 둘 이상이면 중복 오류

@Test
@DisplayName("부모 타입으로 조회 시 자식이 둘 이상 있으면, 중복 오류가 발생한다.")
void findBeanByParentTypeDuplicate() {
    assertThrows(NoUniqueBeanDefinitionException.class,
            () -> ac.getBean(DiscountPolicy.class));
}

 

3) findBeanByParentTypeBeanName() - 자식이 2개 이상이어도 getBean(이름, 부모 타입)으로 조회하면 성공

@Test
@DisplayName("부모 타입으로 조회 시 자식이 둘 이상 있으면, 빈 이름을 지정하면 된다.")
void findBeanByParentTypeBeanName() {
    DiscountPolicy rateDiscountPolicy = ac.getBean("rateDiscountPolicy", DiscountPolicy.class);
    assertThat(rateDiscountPolicy).isInstanceOf(RateDiscountPolicy.class);
}

 

4) findBeanBySubType() - getBean(타입) 특정 하위 타입으로 조회

@Test
@DisplayName("특정 하위 타입으로 조회")
void findBeanBySubType() {
    RateDiscountPolicy bean = ac.getBean(RateDiscountPolicy.class);
    assertThat(bean).isInstanceOf(RateDiscountPolicy.class);
}

특정 하위 타입으로 조회하는 것은 좋지 않은 방식이다.

 

5) findAllBeanByParentType() - getBeansOfType(부모 타입)으로 (부모 타입+하위 타입) 빈 조회

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

 

6) findAllBeanByObjectType() - getBeansOfType(Object)로 모든 빈 조회

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

 

BeanFactory와 ApplicationContext

---

BeanFactory

스프링 컨테이너의 최상위 인터페이스로, 스프링 빈을 관리하고 조회하는 역할을 담당한다.

getBean()을 제공하는 역할을 하며, 우리가 사용했던 대부분의 기능은 BeanFactory가 제공하는 기능이다.

 

ApplicationContext

BeanFactory의 기능을 모두 상속받아서 제공하는 인터페이스다. 빈을 관리하고 조회하는 기능 외에도 다양한 부가 기능을 제공한다.

1. 메시지소스를 활용한 국제화 기능(MessageSource): 한국에서 들어오면 한국어로, 영어권에서 들어오면 영어로 출력
2. 환경변수(EnvironmentCapable): 로컬 환경(내 PC), 개발(테스트) 환경, 운영 환경 등을 구분해서 처리
3. 애플리케이션 이벤트(ApplicationEventPublisher): 이벤트를 발행하고 구독하는 모델을 편리하게 지원
4. 편리한 리소스 조회(ResourceLoader): 파일, 클래스패스, 외부 등에서 리소스를 편리하게 조회

 

정리하자면,

ApplicationContext는 BeanFactory의 기능을 모두 상속받아 빈 관리기능 + 편리한 부가기능을 제공한다. 또한 BeanFactory를 직접 사용할 일은 거의 없으며, 부가기능이 포함된 ApplicationContext를 사용한다.

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

 

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

---

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

 

애노테이션 기반 자바 코드 설정 사용: @Configuration, @Bean

지금까지 해왔던 것으로 주로 이 방식을 사용한다.

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

new AnnotationConfigApplicationContext(AppConfig.class)

 

XML 설정 사용

최근에는 스프링 부트 사용으로 XML 기반의 설정은 잘 사용하지 않지만, 컴파일 없이 빈 설정 정보를 변경할 수 있는 장점도 있으므로 한번쯤 배워두는 것도 좋다.

GenericXmlApplicationContext 클래스를 사용하면서 xml 설정 파일을 넘기면 된다.

• XmlAppConfig 사용 자바 코드

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 기반의 스프링 빈 설정 정보(src/main/resources/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>

 

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

---

스프링이 다양한 설정 형식을 지원할 수 있는 이유는 바로 BeanDefinition이라는 추상화 때문이다.

설정 정보의 역할과 구현을 개념적으로 분리한 것으로 설정 정보를 추상화시켰다. 따라서 스프링 컨테이너는 BeanDefinition만 알면 되고, 자바 코드인지 XML인지 몰라도 된다.

BeanDefinition은 빈 설정 메타정보로, @Bean, <Bean> 당 하나의 메타정보가 생성된다.

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

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

 

BeanDefinition 살펴보기

• BeanDefinition 정보

• 빈 설정 메타 정보(BeanDefinition)를 확인하는 테스트 코드

//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으로 추상화하여 사용한다는 것 정도만 이해하면 된다.