[Spring] 기본편 04. 스프링 컨테이너와 스프링 빈

54575 단어 SpringSpring

이 글은 스프링 [핵심원리 - 기본편]을 듣고 정리한 내용입니다.

📌 스프링 컨테이너 생성

  • 스프링 컨테이너가 생성되는 과정은 코드로 이렇다.
 ApplicationContext applicationContext =
                            new
    AnnotationConfigApplicationContext(AppConfig.class);
  • AppicationContext스프링 컨테이너 라고 한다.
  • ApplicationContext는 인터페이스 이다.
  • 스프링 컨테이너는 XML기반으로 만들수도 있고, 어노테이션 기반의 자바 설정 클래스로 만들 수도 있다.
    (요즘엔 거의 어노테이션 방식임)
  • 위 코드에서 new AnnotationConfigApplicationContext(AppConfig.class) 이 클래스는 ApplicationContext의 구현체이다
  • 더 정확히는 스프링 컨테이너를 BeanFactory, ApplicationContext로 구분하지만 우선 일반적으로 ApplicationContext를 스프링 컨테이너 라고 한다.

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

  • 생성과정 : new AnnotationConfigApplicationContext(AppConfig.class)

  • 스프링 컨테이너를 생성할 때는 구성정보를 지정해주어야 하는데 AppConfig.class를 구성 정보롤 지정하였다.

  • 빈 이름은 메서드 이름을 사용한다. (주의 : 빈 이름이 겹치면 안됨 .오류발생!)

  • 빈 이름을 직접 부여 할 수도 있다
    ex) @Bean(name="memberService2")

  • 화살표는 의존관계를 나타내는 것이다. 방향 : 의존 하는쪽 -> 의존 받는쪽
    ex) 그림에서 맨위의 인자에 해당하는 memberRepository()는 아래쪽의 memberRepository()메서드에 의존한다.

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

  • 스프링 빈을 생성하고, 의존관계를 주입하는 단계가 나누어져 있다. 자세한 내용은 뒤에서.

  • 이제 스프링 컨테이너에서 데이터 조회 해볼예정


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

  • 스프링 컨테이너에 어떤 스프링 빈들이 등록되어 있는지 조회해보자
  • test 패키지 안에 beanfind 패키지 안에 AnnotationContextInfoTest. class 작성
 class ApplicationContextInfoTest {

    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

    @Test
    @DisplayName("모든 빈 출력하기")
     void findAllBean(){
        String[] beanDefinitionNames = ac.getBeanDefinitionNames();
        //List나 배열이 있으면 'iter'입력 후 tab누르면 for문 자동완성 됨.
        for (String beanDefinitionName : beanDefinitionNames) {
            Object bean = ac.getBean(beanDefinitionName);
            System.out.println("name= "+ beanDefinitionName+" object = "+bean);
        }
    }

    @Test
    @DisplayName("애플리케이션 빈 출력하기")
     void findApplicationBean(){
        String[] beanDefinitionNames = ac.getBeanDefinitionNames();
        //List나 배열이 있으면 'iter'입력 후 tab누르면 for문 자동완성 됨.
        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.getBeanDefinitioNames() : 스프링에 등록된 모든 빈 이름 조회
  • ac.getBean() : 빈 이름으로 객체(인스턴스) 조회
  • 두번째 테스트코드는 스프링이 내부에서 사용하는 빈은 제외하고, 내가 직접 등록한 빈만 출력하는 코드이다.
  • 스프링 빈은 getRole()로 구분할 수 있는데
    • ROLE_APPLICATION : 일반적으로 사용자가 정의한 빈
    • ROLE_INFRASTRUCTURE : 스프링이 내부에서 사용하는 빈

📌 스프링 빈 조회

🌱 스프링 빈 조회 - 기본적인 방법

  • 스프링 컨테이너에서 스프링 빈을 찾는 가장 기본적인 조회 방법이다.
  • ac.getBean(빈이름,타입)
  • ac.getBean(타입)
    ( 이름,타입으로 조회 할 수도있고, 타입으로만 조회 할 수도 있다.)
  • 조회하려는 스프링 빈이 없으면 예외 발생
    - NoSuchBeanDefinition : No bean named 'xxxx' available

public class ApplicationContextBasicFindTest {
    AnnotationConfigApplicationContext ac = new
            AnnotationConfigApplicationContext(AppConfig.class);

    @Test
    @DisplayName("빈 이름으로 조회")
    void findBeanByName(){
        MemberService memberService = ac.getBean("memberService",MemberService.class);
//        System.out.println("memberService = " + memberService);
//        System.out.println("memberService.getClass() = "+ memberService.getClass());

        assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
        // memberService가 MemberServiceImpl의 인스턴스이면 성공
    }

    @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("xxxx",MemberService.class);
        // 예외가 터지면 성공, 안터지면 실패
        assertThrows(NoSuchBeanDefinitionException.class,
                () -> ac.getBean("xxxx",MemberService.class));

    }

}
  • 마지막에 작성한 테스트처럼, 테스트는 항상 실패 테스트를 만들어야 한다.!
  • 참고 : 세번째 테스트처럼 구체 타입으로 조회 하면 변경시 유연성이 떨어진다.

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

  • 타입으로 조회 시 같은 타입의 스프링 빈이 둘 이상이면 오류가 발생한다. 이때는 이름도 지정한다. (이름, 타입 둘다 지정 해야함)
  • 테스트를 하기 위해 기존 AppConfig를 쓰지 않고, 테스트 하려는 상황에 해당하는 SameBeanConfig를 생성하여 스프링 컨테이너를 만들었다.
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SameBeanConfig.class);
package hello.core.beanfind;

public 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();
        }
    }
}
  • 특정 타입 모두 조회하기 에서 ac.getBeansOfType를 하고 command+option+v로 변수를 리턴받으면 Map<String, MemberRepository>형이 리턴된다.
  • key, value 출력을 통해 살펴보면 빈 이름과 그에 해당하는 클래스가 출력된다.

🌱 스프링 빈 조회 - 상속관계 (중요)

  • 부모 타입으로 조회하면, 자식 타입도 함께 조회된다.
  • Object 타입으로 조회하면, 스프링 내에 존재하는 모든 스프링 빈이 조회된다.
    (Object는 모든 자바 객체의 최고 부모이기 때문에)
class ApplicationContextExtendsFindTest {
    org.springframework.context.annotation.AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);

    @Test
    @DisplayName("부모 타입으로 조회 시, 자식이 둘 이상 있으면 중복 오류가 발생한다.")
    void findBeanByParentTypeDuplicate(){
        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);
        //스프링 내부적으로 존재하는 빈들이 전부 출력된다.
        //자바 객체는 모두 Object 객체를 상속하기 때문에.
        for (String s : beansOfType.keySet()) {
            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();
        }
    }
}
  • 실제 개발할때는, applicationContext에서 빈을 조회할 일은 거의 없다.
  • 하지만 기본 기능이기도 하고, 가끔 사용할 일이 있어서 알고 있기.
  • 중요한것은, 부모타입으로 조회할 때 자식이 어디까지 조회되는지 알고 있어야 나중에 자동 의존관계 주입에서 문제없이 이해 할 수 있다.

📌 BeanFactory와 ApplicationContext

  • BeanFactory
    • 스프링 컨테이너의 최상위 인터페이스이다.
    • 스프링 빈을 관리하고 조회하는 역할을 한다.
    • 위에서 사용했던 getBean()을 제공한다.
    • 지금까지 우리가 사용했던 대부분의 기능은 BeanFactory가 제공하는 기능이었다.
  • ApplicationContext
    - BeanFacotry의 기능을 모두 상속받아서 제공한다.
    - 애플리케이션 개발시에, 빈을 관리하고 조회하는 기능 외에 많은 부가기능이 필요한데, 그것들을 제공해준다.
  • 부가기능
    • 메시지소스를 활용한 국제화 기능
    • 환경변수
    • 애플리케이션 이벤트
    • 편리한 리소스 조회
  • 실제 개발시에, BeanFactory를 직접 사용할 일은 거의 없고, 대부분 부가기능이 포함된 ApplicationContext를 사용한다.
  • BeanFacotryApplicationContext스프링 컨테이너라 한다.

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

  • 스프링 컨테이너는 다양한 형식의 설정 정보를 적용할 수 있게 유연하게 설계되어 있다.

  • ex) 자바코드, XML, Groovy 등등

  • 지금까지 했던 자바 코드를 이용한 설정 - new AnnotationConfigApplicatio(Appconfig.class)

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


🌱 XML 설정 사용

  • 최근에는 스프링부트를 사용하고, XML 기반 설정은 거의 사용하지 않는다. But 알아두면 좋다.
  • GenericXmlApplicationContext를 사용하면서 xml 설정파일을 넘기면 된다.
  • XmlAppConfig 사용 자바 코드
  • test 패키지 안에 xml 패키지 안에 XmlAppContex.class
package hello.core.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 기반의 스프링 빈 설정 정보
  • xml파일은 resource 패키지안에 작성하면 된다.
  • src/main/resource/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>

    <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.xmlAppConfig.java를 보면 구조가 거의 비슷하다.
  • xml기반 설정 방식은 최근에는 잘 사용하지 않는다.

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

(여기는 그냥 참고 부분. 보고 넘어가기)

  • BeanDefinition이라는 추상화는 역할과 구현을 개념적으로 나눈것이다
    • XML을 읽어서 BeanDefinition을 만들면 된다.
    • 자바 코드를 읽어서 BeanDefinition을 만들면 된다.
    • 스프링 컨테이너 입장에서는 자바코드인지, xml인지 알 필요x. 오직 BeanDefinitio만 알면 된다.
  • BeanDefinition을 빈 설정 메타정보라 한다.
    - @Bean, <'bean'>당 각각 하나씩 메타정보가 생성된다.
  • 스프링 컨테이너는 이 메타정보를 기반으로 스프링을 생성한다.
  • BeanDefinition에 있는 정보들 (강노 설명 읽어보고 넘어감)
    • BeanClassName
    • factoryBeanName
    • factoryMethodName
    • Scope
    • lazyInit
    • InitMethodName
    • DestoryMethodName
    • 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을 직접 생성해서 스프링 컨테이너에 등록할 수도 있다.
    • But. 실무에서는 직접 정의하거나 사용할 일은 거의 없음.
    • 스프링이 다양한 형태의 설정 정보를 BeanDefinition으로 추상화해서 사용하는 것 정도만 이해하자!

좋은 웹페이지 즐겨찾기