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

[cyzlcyzl]

스프링 컨테이너 생성

• ApplicationContext를 스프링 컨테이너라고 하며 인터페이스이다.

• XML 기반 / 애노테이션 기반의 자바 설정 클래스로 만들 수 있다.

  • 이전 예제에서 AppConfig 설정 파일을 만들어줬던 게 애노테이션 기반의 자바 설정 파일임

• AnnotationConfigApplicationContext가 ApplicationContext의 구현체다.

  new AnnotationConfigApplicationContext(AppConfig.class);

스프링 생성 과정

1. 스프링 컨테이너 생성

• AppConfig.class를 구성 정보로 지정

2. 스프링 빈 등록

• 스프링 컨테이너는 설정 클래스 정보를 사용해서 빈을 등록한다.
• 빈 이름은 디폴트 값으로 메소드 명을 사용하며, 직접 부여할 수도 있다.
• 빈 이름은 항상 서로 다른 이름을 부여해야 한다.

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

• 스프링 컨테이너는 설정 정보를 참고해서 의존 관계를 주입한다.
• 단순히 자바 코드를 호출하는 것과는 차이가 있음

💡참고 스프링 빈 등록과 의존관계 설정을 나눠서 설명했지만, 자바 코드로 스프링 빈을 등록할 때는 생성자 호출과 의존관게 주입이 한번에 처리된다.

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

스프링 컨테이너 정보 가져오기

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

• ac.getBeanDefinitionNames(): 스프링에 등록된 모든 이름 조회
• ac.getBean(): 빈 이름으로 빈 객체(인스턴스) 조회

애플리케이션 빈 출력하기

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

• getRole() 메서드로 빈 구분
• ROLE_APPLICATION: 사용자가 정의한 빈
• ROLE_INFRASTRUCTURE: 스프링 내부에서 사용하는 빈

💡tip iter 단축키 활용하면 for-each 구문 빠르게 만들 수 있음

스프링 빈 조회 - 기본

① ac.getBean(빈이름, 타입)
② ac.getBean(타입)

빈 이름으로 조회하기

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

구체 타입으로 조회하기

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

• MemberServiceImpl.class 구체 타입에 의존하고 있기 때문에 좋은 코드는 아니다.

존재하지 않는 빈 이름으로 조회했을 때

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

• NoSuchBeanDefinitionException: No bean named 'xxxxx' available 조회 대상 빈이 없으면 해당 에러 발생

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

당연하지만 빈 이름을 지정해주면 된다.

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

• 타입으로 조회했는데 같은 타입이 둘 이상 있으면 NoUniqueBeanDefinitionException 에러가 발생한다.

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

• 같은 타입이 둘 이상 있으면 getBean("빈 이름", 타입) 으로 조회해주면 된다.

@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 타입으로 조회하면 모든 스프링 빈이 함께 조회됨

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

• 부모 타입으로 조회하면 자식 타입이 함께 조회되고 그 자식이 둘 이상이면 NoUniqueBeanDefinitionException 에러 발생
• 자식이 둘 이상이면 마찬가지로 빈 이름을 지정해주면 된다.

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

• getBeansOfType() 메서드를 활용해 부모 타입으로 모두 조회할 수 있다.
• 자바 모든 객체의 최상위 부모 클래스인 Object로 조회하면 모든 스프링 빈을 확인할 수 있다.

BeanFactory와 ApplicationContext

BeanFactory

• 스프링 컨테이너의 최상위 인터페이스
• 스프링 빈을 관리하고 조회
• getBean() 제공
• 빈을 조회할 수 있는 대부분의 기능은 BeanFactory가 제공하는 기능임

ApplicationContext

• BeanFactory 기능을 모두 상속 받아서 제공
• 빈을 관리하고 검색하는 기능은 BeanFactory에서 제공 받는 것
• ApplicationContext는 빈을 관리하고 조회할 수 있는 기능 외에 수 많은 부가 기능을 갖고 있다.

• MessageSource: 국가에 따른 출력 언어 설정
• EnvironmentCapable: 환경 변수로 로컬/개발/운영 등을 구분해서 처리
• ApplicationEventPublisher: 이벤트를 발생하고 구독하는 모델을 편리하게 지원
• ResourceLoader: 파일, 클래스패스, 외부 등에서 리소스를 편리하게 조회

BeanFactory를 직접 사용할 일은 거의 없으며 부가 기능이 포함된 ApplicationContext를 사용하며 이 둘을 스프링 컨테이너라 한다.

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

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

• 지금까지의 예제에서 AppConfig 파일을 작성한 것이 바로 애노테이션 기반의 자바 설정 파일
• AnnotationConfigApplicationContext 클래스를 사용하면서 자바 코드로 된 설정 정보를 넘겨줌

XML 설정 사용

• GenericXmlApplicationContext를 사용하면서 xml 설정 파일을 넘겨줌

@Test
void xmlAppContext() {
    ApplicationContext ac = new
            GenericXmlApplicationContext("appConfig.xml");

    MemberService memberService = ac.getBean("memberService",
            MemberService.class);
    assertThat(memberService).isInstanceOf(MemberService.class);
}

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>

(참고) xml 문서에서 setter를 활용한 빈 등록

setter 활용

<bean class="sample04.Student" id="st2">
   <property name="no" value="10"/> <!-- setNo() call -->
   <property name="addr" value="seoul"/>
   <property name="phone" value="111-222"/>
   <property name="name" value="James"/>
</bean>

xml 기반의 설정 파일은 최근에 거의 사용하지 않지만 xml을 사용하면 컴파일 없이 빈 설정 정보를 변경할 수 있다.

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

스프링이 자바 코드 형식이든 XML 형식이든 다양한 설정 형식을 지원할 수 있는 것은 BeanDefinition이라는 추상화가 있다.

• XML을 읽어서 BeanDefinition을 만들면 된다.
• 자바 코드를 읽어서 BeanDefinition을 만들면 된다.
• 스프링 컨테이너는 XML인지 자바 코드인지 몰라도 되고 BeanDefinition만 알면 된다.
• BeanDefinition을 빈 설정 메타정보라고 한다.
  • @Bean, <bean>당 하나씩 메타 정보가 생성된다.

⬇️
한마디로 역할과 구현을 개념적으로 나눈 것

- 코드 레벨

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

BeanDefinition

• BeanClassName: 생성할 빈의 클래스 명 (자바 설정처럼 팩토리 역할의 빈을 사용하면 없음)
• factoryBeanName: 팩토리 역할의 빈을 사용하는 경우 ex) appConfig
• factoryMethodName: 빈을 생성할 팩토리 메서드 지정 ex) memberService
• Scope: 싱글톤
• lazyInit: 스프링 컨테이너 생성 시점에 빈을 생성하는 것이 아니라, 사용 때가지 생성을 지연 처리 하느지 여부
• InitMethodName: 빈을 생성하고 의존관계를 적용한 뒤에 호출되는 초기화 메서드 명
• DestroyMethodName: 빈의 생명주기가 끝나서 제거하기 직전에 호출되는 메서드 명
• Constructor arguments, Properties: 의존관계 주입에서 사용 (자바 설정처럼 팩토리 역할의 빈을 사용하면 없음)

@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을 직접 생성해서 스프링 컨테이너 등록할 수도 있다. (실무에서 사용할 일 거의 없음)
• 스프링이 다양한 형태의 설정 정보를 (자바 코드, xml..) BeanDefinition으로 추상화해서 사용하는 것으로 이해하면 됨