[Spring] 4.스프링 컨테이너와 스프링 빈

[Spring] 4.스프링 컨테이너와 스프링 빈

 

1. 스프링 컨테이너 생성

스프링 컨테이너 생성 과정

ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);

- ApplicationContext : 스프링 컨테이너 (인터페이스)

- xml 기반으로 만들 수도 있고 Annotation 기반의 자바 설정 클래스로 만들 수도 있다.

- AppConfig 방식 -> Annoation 기반 자바 설정 클래스

- new AnnotaionConfigApplicationContext(AppConfig.class) = 인터페이스 구현체

 

* 더 정확히는 BeanFactory / ApplicationContext로 구분해서 이야기함

* BeanFactory를 직접 사용하는 경우는 거의 없음

 

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

1) 스프링 컨테이너 생성

- new AnnotaionConfigApplicationContext(AppConfig.class)

- 스프링 컨테이너를 생성할 땐 구성 정보를 저장해줘야함 (AppConfig.class)

 

2) 스프링 빈 등록

- 설정 정보(AppConfig.class) 넘겨주면 그걸 보면서 @Bean 붙은거 호출해서 등록

  [빈이름] = 메서드명, [빈객체] = 반환 객체

 

* 빈이름 직접 부여 가능 @Bean(name="memberService2")

* 주의) 빈 이름은 항상 다른 이름으로 부여해야함

 

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

 

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

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

 

* 참고) 스프링 빈을 생성하고 의존관계 주입 단계 나눠져있음

            하지만 자바코드로 스프링 빈 등록하면 생성자를 호출하면서 의존관계 주입도 한번에 처리됨

            그런데 스프링 라이프 사이클은 나눠져있음 (나중에 설명)

---

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

ㄴhello.cored.beanfind

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

---

3. 스프링 빈 조회 - 기본

 

스프링 컨테이너에서 스프링 빈을 찾는 가장 기본적인 조회 방법

- ac.getBean(빈이름, 타입)

- ac.getBean(타입)

조회 대상 스프링 빈이 없으면 예외 발생 : NoSuchBeanDefinitionException: No bean named 'xxxxx' available

 

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() {
    //ac.getBean("xxxxx", MemberService.class);
    Assertions.assertThrows(NoSuchBeanDefinitionException.class, () ->
    ac.getBean("xxxxx", MemberService.class));
  } 
}

* 참고) 구체 타입으로 조회하면 변경시 유연성이 떨어진다.

* 마지막 테스트에서 오른쪽 메서드를 실행했을때 왼쪽 Exception이 발생해야 테스트 성공

---

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

- 타입으로 조회시 같은 타입의 스프링 빈이 둘 이상이면 오류 발생

  이때 빈 이름을 지정하자

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

 

class ApplicationContextSameBeanFindTest {
  AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SameBeanConfig.class);
  
  @Test
  @DisplayName("타입으로 조회시 같은 타입이 둘 이상 있으면, 중복 오류가 발생한다") 
  void findBeanByTypeDuplicate() {
    //MemberRepository bean = ac.getBean(MemberRepository.class);
    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);
  }
  
  @Configuration
  static class SameBeanConfig {
    @Bean
    public MemberRepository memberRepository1() {
      return new MemoryMemberRepository();
    }
    
    @Bean
    public MemberRepository memberRepository2() {
      return new MemoryMemberRepository();
    }
  }
}

---

5. 스프링 빈 조회 - 상속관계

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

- 그래서 모든 자바 객체의 최곡 부모인 Object 타입으로 조회하면 모든 스프링 빈을 조회한다.

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

---

6. BeanFactory와 ApplicationContext

BeanFactory

- 스프링 컨테이너의 최상위 인터페이스

- 스프링 빈을 관리하고 조회하는 역할

- getBean()제공

- 지금까지 우리가 사용했던 대부분의 기능은 BeanFactory가 제공하는 기능

 

ApplicationContext

- BeanFactory기능을 모두 상속해서 제공

- 빈을 관리하고 검색하는 기능을 BeanFactory가 제공해주는데, 그러면 둘의 차이는?

  여러 인터페이스를 상속받아서 사용

- 애플리케이션을 개발할 땐 빈을 관리하고 조회하는 기능 + 수 많은 부가기능이 필요

- 메세지 소스를 활용한 국제화 기능 : 예를 들어 한국에서 들어오면 한국어로, 영어궈너에서 들어오면 영어로 출력

- 환경변수 : 로컬, 개발, 운영 등을 구분해서 처리

- 애플리케이션 이벤트 : 이벤트 발행 및 구독하는 모델을 편리하게 지원

- 편리한 리소스 조회 : 파일, 클래스패스, 외부 등에서 리소스를 편리하게 조회

---

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

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

  ex) 자바코드, XML, Grovvy

XML 설정 사용

- 레거시 프로젝트

- 컴파일 없이 빈 설정 정보 변경 (장점)

- GenericXmlApplication 사용하여 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>

- AppConfig와 거의 비슷

---

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

- 스프링 어떻게 다양한 설정 지원? : BeanDefinition이라는 추상화!

- 역할과 구현을 잘 나눈것

- BeanDefinition을 빈 설정 메타정보라고한다.

- @Bean, <bean> 당 각각 하나씩 메타정보가 생성됨

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

- AnnotaionConfigApplicationContext는 AnnotationBeanDefinitionreader를 사용해서 AppConfig.class를 읽고 BeanDefinition을 생성

- GenericXmlApplicationContext는 XmlBeanDefinitionReader를 사용해서 appConfig.xml 설정 정보를 읽고 BeanDefinition을 생성

- 새로운 형식의 설정 정보가 추가되면 XmlBeanDefinitionReader를 만들어서 BeanDefinition을 생성하면 됨

 

BeanDefinition 정보

- BeanClassName: 생성할 빈의 클래스 명(자바 설정 처럼 팩토리 역할의 빈을 사용하면 없음)

- factoryBeanName: 팩토리 역할의 빈을 사용할 경우 이름, 예)

- appConfig factoryMethodName: 빈을 생성할 팩토리 메서드 지정, 예) memberService

- Scope: 싱글톤(기본값)

- lazyInit: 스프링 컨테이너를 생성할 때 빈을 생성하는 것이 아니라, 실제 빈을 사용할 때 까지 최대한 생성을 지연처리 하는지 여부

- InitMethodName: 빈을 생성하고, 의존관계를 적용한 뒤에 호출되는 초기화 메서드 명

- DestroyMethodName: 빈의 생명주기가 끝나서 제거하기 직전에 호출되는 메서드 명

- Constructor arguments, Properties: 의존관계 주입에서 사용한다. (자바 설정 처럼 팩토리 역할의 빈을 사용하면 없음)

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을 직접 정의하거나 사용할 일은 거의 없다. 어려우면 그냥 넘어가면 된다^^!

- BeanDefinition에 대해서는 너무 깊이있게 이해하기 보다는, 스프링이 다양한 형태의 설정 정보를 BeanDefinition으로 추상화해서 사용하는 것 정도만 이해하면 된다.

- 가끔 스프링 코드나 스프링 관련 오픈 소스의 코드를 볼 때, BeanDefinition 이라는 것이 보일 때가 있다. 이때 이러한 메커니즘을 떠올리면 된다.