섹션 4. 스프링 컨테이너와 스프링 빈

Zion Yu·2021년 3월 8일

스프링 핵심 원리 - 기본편

목록 보기

5/10

본 시리즈는 우아한형제들 개발 팀장이신 김영한님의 스프링 핵심 원리 - 기본편 강의를 들으며 개인적으로 정리한 내용을 담고 있습니다. 제가 들은 강의는 인프런에 등록되어 있습니다. 모든 다이어그램을 포함한 사진의 출처는 위 강의의 강의록임을 밝힙니다. 개인적으로 정리한 내용이기 때문에 글 내용에 오류가 있을 수 있으며 이에 대한 피드백은 댓글로 부탁드립니다.

이번 섹션에서 다룰 내용

스프링 컨테이너에 대한 기초적인 내용
스프링 컨테이너를 쓰면 뭐가 좋은가?: 이후에도 계속 나오는듯..

스프링 컨테이너 생성

ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);

ApplicationContext를 스프링 컨테이너라고 한다.
내부적으로 ApplicationContext는 인터페이스이며 구현 클래스에 따라 여러 방식으로 스프링 컨테이너를 만들 수 있다.

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

스프링 컨테이너 생성
스프링 빈 등록
- 빈 이름은 메소드 이름을 사용한다.
- 빈 이름을 직접 부여할 수도 있다.
- 주의: 빈의 이름은 항상 서로 다른 이름을 부여한다. 같은 이름을 부여하면 오류의 소지가 있다.
스프링 빈 의존관계 설정 - 준비
스프링 빈 의존관계 설정 - 완료
- 스프링 컨테이너는 설정 정보를 참고하여 DI를 수행한다.
- 단순히 자바 코드(생성자)를 호출하는 것 이상의 일을 한다.

스프링 빈 조회

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

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

public class ApplicationContextInfoTest {
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
    
    @Test
    @DisplayName("모든 빈 출력하기")
    void findAllBeans() {
        String[] beanDefinitionNames = ac.getBeanDefinitionNames();
        for (String beanDefinitionName : beanDefinitionNames) {
            Object bean = ac.getBean(beanDefinitionName);
            System.out.println("beanDefinitionName = " + beanDefinitionName + " object" + bean);
        }
    }

    @Test
    @DisplayName("애플리케이션 빈 출력하기")
    void findApplicationBean() {
        String[] beanDefinitionNames = ac.getBeanDefinitionNames();
        for (String beanDefinitionName : beanDefinitionNames) {
            BeanDefinition beanDefinition = ac.getBeanDefinition(beanDefinitionName);
            //app에서 등록한 빈만 조회
            if (beanDefinition.getRole() == BeanDefinition.ROLE_APPLICATION) {
                Object bean = ac.getBean(beanDefinitionName);
                System.out.println("beanDefinitionName = " + beanDefinitionName + " object" + bean);
            }
        }
    }
}

모든 빈 출력하기
- ac.getBeanDefinitionNames(): 스프링에 등록된 모든 빈 이름 조회
- ac.getBean(): 빈 이름으로 인스턴스 조회
app에서 등록한 빈 출력하기
- 스프링이 내부에서 사용하는 빈은 제외하고 app에서 등록하는 빈만 보는 법
- 스프링이 내부에서 사용하는지 아닌지는 getRule()로 구분 가능
  - ROLE_APPLICATION: 일반적으로 사용자가 정의한 빈
  - ROLE_INFRASTRUCTURE: 스프링이 내부에서 사용하는 빈

스프링 빈 조회 - 기본

ac.getBean(빈 이름, 타입)
ac.getBean(타입)
타입 자리에 구현 클래스를 써도 되지만 권장하지 않는다.
찾는 빈의 이름이 없다면 NoSuchBeanDefinitionException이 발생한다.

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 findBeanByName2() {
        MemberService memberService = ac.getBean("memberService", MemberServiceImpl.class);
        assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
    }
    @Test
    @DisplayName("이름 없이 타입으로만 조회")
    void findBeanByType() {
        MemberService memberService = ac.getBean(MemberService.class);
        assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
    }
    @Test
    @DisplayName("빈 이름으로 조회 X")
    void findBeanByNameX() {
//        MemberService xxxx = ac.getBean("xxxx", MemberService.class);
        assertThrows(NoSuchBeanDefinitionException.class,
                () -> ac.getBean("xxxxx", MemberService.class));
    }
}

assertThrows는 JUnit의 Assertions에 들어있는 메소드이므로 따로 import 해줘야 한다!

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

타입으로만 빈을 찾을 때 같은 타입의 스프링 빈이 두 개 이상이면 NoUniqueBeanDefinitionException이 발생한다. 이럴 땐 빈 이름을 지정해서 조회하면 된다.
ac.getBeansOfType()을 사용하면 해당 타입의 모든 빈을 조회할 수 있다.

public class ApplicationContextSameBeanFindTest {
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SameBeanConfig.class);
    @Test
    @DisplayName("타입으로 조회 시 같은 타입이 둘 이상 있으면, 중복 오류가 발생한다.")
    void findBeanByTypeDuplication() {
//        MemberRepository bean = ac.getBean(MemberRepository.class);
        assertThrows(NoUniqueBeanDefinitionException.class,
                () -> ac.getBean(MemberRepository.class));
    }
    @Test
    @DisplayName("타입으로 조회 시 같은 타입이 둘 이상 있으면, 빈 이름을 지정하면 된다.")
    void findBeanByName() {
        MemberRepository bean = ac.getBean("memberRepository1", MemberRepository.class);
        assertThat(bean).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();
        }
    }
}

스프링 빈 조회 - 상속 관계

부모 타입을 조회하면, 자식 타입도 함께 조회된다.
그래서 모든 Java 객체의 부모인 Object로 조회하면 모든 스프링 빈이 조회된다.

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

사실 이렇게 직접 빈을 조회할 일은 별로 없다.
부모 타입을 불렀을 때 자식까지 딸려나오는 것 정도를 이해하면 좋다.

BeanFactory와 ApplicationContext

BeanFactory

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

ApplicationContext

BeanFactory 기능을 모두 상속받아서 제공한다.
그 외 여러가지 부가 기능을 제공한다.
- MessageSource를 활용한 국제화 기능
  - 한국에서 들어오면 한국어로, 영어권에서 들어오면 영어로 출력
- 환경변수 EnvironmentCapable
  - 로컬, 개발, 운영 등을 구분해서 처리
- 애플리케이션 이벤트 ApplicationEventPublisher
  - 이벤트를 발행하고 구독하는 모델을 편리하게 지원
- 편리한 리소스 조회 ResourceLoader
  - 파일, 클래스패스, 외부 등에서 리소스를 편리하게 조회

정리

ApplicationContext는 BeanFactory의 기능을 상속받는다. ApplicationContext는 빈 관리 기능에 더해 편리한 부가 기능을 제공한다.
BeanFactory를 직접 사용할 일은 거의 없고 대개 ApplicationContext를 사용한다.
BeanFactory나 ApplicationContext를 스프링 컨테이너라고 한다.

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

스프링 컨테이너는 다양한 형식으로 설정 정보를 받을 수 있다.
여태까지 설정 정보를 Java 코드로 했지만 XML이나 Groovy로 할 수도 있다.

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

지금까지 사용한 방식

XML 설정 사용

최근에는 스프링 부트를 많이 사용하면서 XML 기반의 설정을 잘 사용하지 않는다. 하지만 XML 설정을 사용하는 legacy 프로젝트가 많다.

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="hello.core.member.MemberServiceImpl">
        <constructor-arg name="memberRepository" ref="memberRepository" />
    </bean>

    <bean id="memberRepository" class="hello.core.member.MemoryMemberRepository" />

    <bean id="discountPolicy" class="hello.core.discount.RateDiscountPolicy" />
    <bean id="orderService" class="hello.core.order.OrderServiceImpl">
        <constructor-arg name="memberRepository" ref="memberRepository" />
        <constructor-arg name="discountPolicy" ref="discountPolicy" />
    </bean>

</beans>

XML 기반의 appConfig.xml 설정 정보와 자바 코드로 된 AppConfig.java 설정 정보를 보면 상당히 유사하다.

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

스프링은 어떻게 다양한 설정 형식(Java, XML, Groovy 등)을 지원하는 것인가?
- BeanDefinition이라는 추상화 덕분!
여태까지 계속 강조했던 역할과 구현의 구분 덕분에 가능하다.
- XML을 읽어서 BeanDefinition을 만들면 된다.
- Java 파일을 읽어서 BeanDefinition을 만들면 된다.
BeanDefinition을 빈 설정 메타정보라고 한다. 스프링 컨테이너는 이 메타정보를 기반으로 스프링 빈을 생성한다.

실제 코드 레벨에선 다음과 같은 모습을 하고 있다.
- 설정 파일이 어떤 형식으로 들어왔냐에 따라 메타 정보를 생성할 xxxBeanDefinitionReader가 결정된다.
- 사용자가 새로운 BeanDefinitionReader를 추가해서 설정을 하게 만들 수도 있다.

BeanDefinition 살펴보기

BeanClassName: 생성할 빈의 클래스명(Java 코드 설정에서는 null)
factoryBeanName: 팩토리 역할의 빈을 사용할 경우 이름, (e.g. appConfig)
factoryMethodName: 빈을 생성할 팩토리 메소드 지정, (e.g. memberService)
Scope: 싱글톤(기본값)
lazyInit: 실제 빈을 사용할 때까지 생성을 지연처리하는지 여부
InitMethodName: 빈을 생성하고, 의존관계를 적용한 뒤에 호출되는 초기화 메소드명
DestroyMethodName: 빈의 생명주기가 끝나서 제거하기 직전에 호출되는 메소드명
Constructor argument, Properties: 의존관계 주입에서 사용(Java 코드 설정에서는 없음)

app에서 등록한 모든 빈의 BeanDefinition을 출력하는 코드

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을 직접 생성해서 스프링 컨테이너에 등록할 수 있다. 그러나 실무에서 이렇게 하는 일은 거의 없다.
스프링의 다양한 형태의 설정 정보를 BeanDefinition으로 추상화해서 사용한다는 것 정도 이해하면 된다.
스프링 빈을 만들 때 두 가지 방법이 있다.
- 직접적으로 스프링 빈 등록 (XML) - BeanDefinition에 클래스 이름이 기록된다.
- 팩토리 메소드를 이용해서 빈을 등록 (일반적인 Java 코드) - BeanDefinition에 팩토리 메소드명이 기록된다.

스프링 빈이라는 건 결국 객체이고 BeanDefinition은 스프링 빈을 만들 때 필요한 메타정보!

사용한 단축키

iter 입력하고 tab: for each문 작성

Zion Yu

이전 포스트

섹션 3. 스프링 핵심 원리 이해2 - 객체 지향 원리 적용

다음 포스트

섹션 4. 스프링 컨테이너와 스프링 빈

스프링 핵심 원리 - 기본편

이번 섹션에서 다룰 내용

스프링 컨테이너 생성

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

스프링 빈 조회

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

스프링 빈 조회 - 기본

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

스프링 빈 조회 - 상속 관계

BeanFactory와 ApplicationContext

BeanFactory

ApplicationContext

정리

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

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

XML 설정 사용

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

BeanDefinition 살펴보기

정리

사용한 단축키

섹션 3. 스프링 핵심 원리 이해2 - 객체 지향 원리 적용

섹션 5. 싱글톤 컨테이너

0개의 댓글