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

[YuDeokRin]

스프링 컨테이너와 스프링 빈

1️⃣스프링 컨테이너 생성

스프링 컨테이너가 생성되는 과정

//스프링 컨테이너 생성
ApplicationContext application = new AnnotationConfigApplicationContext(AppConfig.class);

• ApplicationContext 를 스프링 컨테이너라 한다.
• ApplicationContext 를 인터페이스이다.
• 스프링 컨테이너는 XML을 기반으로 만들 수 있고, 애노테이션 기반의 자바 설정 클래스로 만들 수 있다.
• 자바 설정 클래스를 기반으로 스프링 컨테이너(ApplicationContext)를 만들어보자.
  • new AnnotationConfigApplicationContext(AppConfig.class);
  • 이 클래스는 ApplicationContext인터페이스의 구현체이다.

1. 스프링 컨테이너 생성

• new AnnotationConfigApplicationContext(AppConfig.class)
• 스프링 컨테이너를 생성할 때는 구성 정보를 지정해주어야 한다.
• 여기서는 AppConfig.class 를 구성 정보를 지정했다.

2. 스프링 빈 등록

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

✅빈 이름

• 빈 이름은 메서드 이름을 사용한다.
• 빈이름을 직접 부여할 수 도 있다. → @bean(name=”memberService2”)
  • 주의 : 빈 이름은 항상 다른 이름을 부여해야 한다. 같은 이름을 부여하면, 다른 빈이 무시되거나, 기존 빈을 덮어버리거나 설정에 따라 오류가 발생한다.
  • 최근에는 스프링 부트 경우 충돌날 경우 경고를 날리고 튕겨버리게한다 → 디폴트 설정

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

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

• 스프링 컨테이너는 설정 정보를 참고해서 의존관계를 주입(DI)한다.
• 단순히 자바 코드를 호출하는 것 같지만, 내부적으로는 큰 차이가 있다. → 싱글톤 컨테이너 때문에. 뒤에서 학습

참고 : 스프링 빈을 생성하고, 의존관계를 주입하는 단계가 나누어져 있다. 그런데 이렇게 자바 코드로 스프링 빈을 등록하면 생성자를 호출하면서 의존관계 주입도 한번에 처리.

---

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

• 스프링 컨테이너에 실제 스프링 빈들이 들어있는지 확인하기
  • 모든 빈 출력하기
    • 실행하면 스프링에 있는 모든 빈 정보를 출력할 수 있다.
    • ac.getBeanDefinitionNames() : 스프링에 등록된 모든 빈 이름을 조회한다.
    • ac.getBean() : 빈 이름으로 빈 객체(인스턴스)를 조회한다.
  • 애플리케이션 빈 출력하기
    • 스프링이 내부에서 사용하는 빈은 제외하고, 내가 등록한 빈만 출력해보자.
    • 스프링이 내부에서 사용하는 빈은 getRole() 로 구분할 수 있다.
    • ROLE_APPLICATION : 일반적으로 사용자가 정의한 빈
    • ROLE_INFRASTRUCTURE : 스프링이 내부에서 사용하는 빈

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.etBean(타입)
  • 조회 대상 스프링 빈이 없으면 예외 발생
    • NoSuchBeanDefinitionException: No bean named 'xxxxx' available

• 예제 코드

  • 구체 타입으로 조회하면 변경시 유연셩이 떨어진다.

import static org.assertj.core.api.Assertions.assertThat;

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 findBeanByType() {
        MemberService memberService = ac.getBean(MemberService.class);
        assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
    }

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

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

}

---

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

• 타입으로 조회시 같은 타입의 스프링 빈이 둘 이상이면 오류가 발생한다. 이때는 빈 이름을 지정하자.
• ac.getBeanOfType()을 사용하면 해당 타입의 모든 빈을 조회할 수 있다.

public class ApplicationContextSameBeanFindTest {
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SameBeanConfig.class);

    @Test
    @DisplayName("타입으로 조회시 같은 타입이 둘 이상 있으면, 중복 오류가 발생한다.")
    void findBeanByTypeDuplicate() {

    }

    @Test
    @DisplayName("타입으로 조회시 같은 타입이 둘 이상 있으면, 빈 이름을 지정하면 된다.")
    void findBeanByName() {

    }

    @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);
        Assertions.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 타입으로 조회하면, 모든 스프링 빈을 조회한다.

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

}

---

6️⃣BeanFactory와 AppliactionContext

✅BeanFactory

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

✅ApplicationContext

• BeanFactory 기능을 모두 상속받아서 제공
• 빈을 관리하고 검색하는 기능을 BeanFactory가 제공 그렇다면 둘의 차이는?
• 애플리케이션을 개발할 때는 빈은 관리하고 조회하는 기능은 물론이고, 수 많은 부가기능이 필요하다.

ApplicationContext가 제공하는 부가기능

• 메시지소스를 활용한 국제화 기능

  • 예를 들어서 한국에서 들어오면 한국어로, 영어권에서 들어오면 영어로 출력

• 환경변수

  • 로컬, 개발, 운영등을 구분해서 처리

• 애플리케이션 이벤트

  • 이벤트를 발행하고 구독하는 모델을 편리하게 지원

• 편리한 리소스 조회

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

• BeanFactory 와 ApplicationContext차이

• 정리
  • ApplicationContext는 BeanFactory의 기능을 상속받는다.
  • ApplicationContext는 빈 관리기능 + 편리한 부가 기능을 제공한다.
  • BeanFactory를 직접 사용할 일은 거의 없다. 부가기능이 포함된 ApplicationContext를 사용한다.
  • BeanFactory나 ApplicationContext를 스프링 컨테이너라 한다.

---

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

• 스프링 컨테이너는 다양한 형식의 설정 정보를 받아들일 수 있게 유연하게 설계되어 있다.
  • 자바 코드, XML, Groovy 등등

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

• 지금까지 했던 것은 애노테이션 기반으로 해옴.
• new ApplicationConfigApplicationContext(AppConfig.class)
• ApplicationConfigApplicationContext클래스를 사용하면서 자바 코드로된 설정 정보를 넘기면 된다.

✅ XML 설정 사용

• 최근에는 스프링 부트를 많이 사용하면서 XML 기반의 설정은 잘 사용하지 않는다.
• GenericXmlApplicationContext를 사용하면서 xml 설정 파일을 넘기면 된다.

➡️XmlAppConfig 사용 자바 코드

import static org.assertj.core.api.Assertions.assertThat;

public class XmlAppContext {

    @Test
    void xmlAppContext() {
        ApplicationContext ac = new GenericXmlApplicationContext("appConfig.xml");
        MemberService memberService = ac.getBean("memberService", MemberService.class);
        assertThat(memberService).isInstanceOf(MemberService.class);
    }
    
}

• 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 기반의 appConfig.xml 스프링 설정 정보와 자바 코드로 된 AppConfig.java설정 정보를 비교해보면 거의 비슷하다.
• xml 기반으로 스프링 공식 레퍼렌스 문서 - https://spring.io/projects/spring-framework

---

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

• 스프링은 어떻게 이런 다양한 설정 형식을 지원하는 것일까? → 그 중심에는 BeanDefinition 만 알면 된다.

• 역할과 구현을 개념적으로 나눈것..

  • XML을 읽어서 BeanDefinition을 만들면 된다.
  • 자바 코드를 읽어서 BaanDefinition을 만들면 된다.
  • 스프링 컨테이너는 자바 코드인지, XML인지 몰라도 된다. 오직 BeanDefinition만 알면 된다.

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

  • @bean, 당 각각 하나씩 메타 정보가 생성된다.

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

• 코드 레벨로 조금 더 깊에 분석할 경우

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

BeanDefinition 살펴보기

• BeanDefinition 정보
  • BeanClassName : 생성할 빈의 클래스명(자바 설정 처럼 팩토리 역할의 빈을 사용하면 없음)
  • factoryBeanName : 팩토리 역할의 빈을 사용할 경우 이름, 예) appConfig
  • factoryMethodName : 빈을 생성할 팩토리 메서드 지정, 예)memberService
  • 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을 직접 생성해서 스프링 컨테이너에 등록할 수 있다. → But! 실무에서는 BeanDefinition을 직접 정의하거나 사용할 일은 거의 없음
• BeanDefinition에 대해서는 너무 깊이 이해하기 보다는 스프링이 다양한 형태의 설정 정보를 BeanDefinition으로 추상화해서 사용하는 것 정도만 이해하면 된다.

[cyzlcyzl]

오.. BeanFactory랑 ApplicationContext 비교 참고할게요!

[Pracrobo]

표가 깔끔하네요 저도 참고하겠씁니다!