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

이글은 스프링핵심원리-기본편-인프런 강의를 학습 후 
나중에 다시 복습하기 위해 정리한 글입니다.
문제시 비공개로 처리하겠습니다. 

스프링 핵심 원리 - 기본편 - 인프런 | 강의

 

목차

1. 스프링 컨테이너 생성
2. 스프링 빈 조회
3. BeanFactory와 ApplicationContext
4. 다양한 설정 형식 지원
5. 스프링 빈 설정 메타 정보

---

1. 스프링 컨테이너 생성

스프링 컨테이너 생성 과정

ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);

 

• ApplicationContext 를 스프링 컨테이너라 한다.
• ApplicationContext 는 인터페이스이고 구현체가 AnnotationConfigApplicationContext 이다.
• 스프링 컨테이너는 XML 기반, 애노테이션 기반의 자바 설정 클래스로 만들 수 있다.
• 이전에 사용했던 방식이 애노테이션 기반의 자바 설정 클래스로 만든 것이다.

참고 : 스프링 컨테이너를 부를 때 더 정확히는 BeanFactory, ApplicationContext 로 구분해서 이야기 함. 일반적으로 BeanFactory를 직접 사용하는 경우가 없어 ApplicationContext 를 스프링 컨테이너라 함.

1. 스프링 컨테이너 생성

• new AnnotationConfigApplicationContext(AppConfig.class)
• 스프링 컨테이너를 생성할 때는 구성 정보를 지정해줘야 하는데 여기서는 AppConfig.class 를 구성 정보로 지정함.

2. 스프링 빈 등록

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

빈 이름

• 빈 이름은 메서드 이름을 사용한다.
• 빈 이름을 직접 부여할 수 도 있다. → @Bean(name="memberService2")

주의 : 빈 이름은 항상 다른 이름을 부여해야 함. 중복이 되면, 다른 빈이 무시되거나, 기존빈을 덮어버리거나 설정에 따라 오류가 발생한다.

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

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

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

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

정리

스프링 컨테이너를 생성하고, 설정 정보를 참고해서 스프링 빈도 등록하고, 의존관계도 설정했다.

이제 스프링 컨테이너에서 데이터를 조회해보자.

---

2. 스프링 빈 조회

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

실무에서 스프링 빈을 조회하는 경우는 거의 없으니 ...

개발 중에 실제 무엇이 생성되고 연결되는지 (상속 구조든 뭐든...) 테스트 할 때나?

아 이런게 있구나 가볍게 맛만 보면 될 거 같다.

 

• 모든 빈 출력

public class ApplicationContextInfoTest {
    //스프링 컨테이너 생성
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

    @Test
    @DisplayName("모든 빈 출력하기")
    void finaAllBean(){
        String[] beanDefinitionNames = ac.getBeanDefinitionNames();
        for (String beanDefinitionName : beanDefinitionNames) {
            Object bean = ac.getBean(beanDefinitionName);
            System.out.println("name = " + beanDefinitionName + ", object = " +bean);
        }
    }
}

ac.getBeanDefinitionNames() → 스프링 컨테이너에서 등록된 모든 빈 이름을 조회한다.

ac.getBean() → 빈 이름으로 빈 객체(인스턴스) 조회.

 

실행하면 스프링에 등록된 모든 빈 정보를 출력할 수 있다.

• 애플리케이션 빈 출력

public class ApplicationContextInfoTest {
    //스프링 컨테이너 생성
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

    @Test
    @DisplayName("애플리케이션 빈 출력하기")
    void finaApplicationBean(){
        String[] beanDefinitionNames = ac.getBeanDefinitionNames();
        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);
            }
        }
    }
}

스프링이 내부에서 사용하는 빈 제외하고, 내가 등록한 빈만 출력

getRole() → 스프링이 내부에서 사용하는 빈을 구분할 수 있다.

• ROLE_APPLICATION : 사용자가 정의한 빈
• ROLE_INFRASTRUCTURE : 스프링이 내부에서 사용하는 빈

실행하면 사용자가 정의한 애플리케이션 빈 로그만 볼 수 있다.

스프링 빈 조회 - 기본

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

• ac.getBean(빈이름,타입)
• ac.getBean(타입)
• 조회 대상 없으면 → 예외 발생
  • NoSuchBeanDefinitionException: No bean named 'xxxxx' available

 

public class ApplicationContextBasicFindTest {

    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);


    @Test
    @DisplayName("빈 이름으로 조회")
    void findBeanByName(){
        MemberService memberService = ac.getBean("memberService", MemberService.class);
        Assertions.assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
        // 현재 memberService 의 구현체가 MemberServiceImpl 인지 ...
        // AppConfig 를 보면 알 수 있듯이 MemberServiceImpl 가 맞다.
    }

    @Test
    @DisplayName("이름 없이 타입으로 조회")
    void findBeanByType(){
        MemberService memberService = ac.getBean( MemberService.class);
        Assertions.assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
    }

    // 구체 타입으로 조회하면 변경 시 유연성이 떨어진다.
    @Test
    @DisplayName("구체 타입으로 찾기")
    void findBeanByName2(){
        MemberServiceImpl memberService = ac.getBean("memberService", MemberServiceImpl.class);
        Assertions.assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
    }

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


}

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

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

→ NoUniqueBeanDefinitionException

→ 이때는 빈 이름을 지정하자.

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

 

public class ApplicationContextSameBeanFindTest {

    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SameBeanConfig.class);

    @Test
    @DisplayName("타입으로 조회시 같은 타입이 둘 이상이면, 중복 오류가 발생한다.")
    void findBeanTypeDuplicate(){
        //MemberRepository bean = ac.getBean(MemberRepository.class);
        // -> NoUniqueBeanDefinitionException 에러 발생
        Assertions.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);
    }

    /*
		특정 타입 모두 조회하기 결과 --- 
		key = memberRepository1value = hello.core.member.MemoryMemberRepository@6c45ee6e
		key = memberRepository2value = hello.core.member.MemoryMemberRepository@6b3e12b5
		beansOfType = {memberRepository1=hello.core.member.MemoryMemberRepository@6c45ee6e, 
		memberRepository2=hello.core.member.MemoryMemberRepository@6b3e12b5}
	  */
    
	@Configuration
    static class SameBeanConfig{

        @Bean
        public MemberRepository memberRepository1(){
            return new MemoryMemberRepository();
        }

        @Bean
        public MemberRepository memberRepository2(){
            return new MemoryMemberRepository();
        }

    }
}

스프링 빈 조회 - 상속관계

부모 타입으로 조회하면 → 자식 타입도 끌려나와 다 함께 조회된다.

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

public class ApplicationContextExtendsFindTest {

    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);

    @Test
    @DisplayName("부모 타입으로 조회시, 자식이 둘 이상 있으면, 중복 오류가 발생한다.")
    void findBeanByParentTypeDuplication(){
        //DiscountPolicy bean = ac.getBean(DiscountPolicy.class);
        // -> NoUniqueBeanDefinitionException 에러 발생
        Assertions.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 findBeansBySubType(){
        RateDiscountPolicy bean = ac.getBean(RateDiscountPolicy.class);
        assertThat(bean).isInstanceOf(RateDiscountPolicy.class);
    }

    @Test
    @DisplayName("부모 타입으로 모두 조회하기")
    void findAllBeansByParentType(){
        Map<String, DiscountPolicy> beansOfType = ac.getBeansOfType(DiscountPolicy.class);
        for (String key : beansOfType.keySet()) {
            System.out.println("key = " + key + " value= " + beansOfType.get(key));
        }
    }


    @Test
    @DisplayName("부모 타입으로 모두 조회하기 - Object")
    void findAllBeansByObjectType(){
        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();
        }
    }
}

---

3. BeanFactory와 ApplicationContext

BeanFactory와 ApplicationContext에 대해 알아보자.

• BeanFactory와 ApplicationContext의 계층구조

• BeanFactory
  • 스프링 컨테이너 최상위 인터페이스
  • 스프링 빈을 관리하고 조회하는 역할
  • 지금까지 사용했던 대부분의 기능은 BeanFactory가 제공한 기능이다. ex) getBean()
• ApplicationContext
  • BeanFactory 기능을 모두 상속받아 제공함.
  • 그 외 부가기능 ...

BeanFactory는 빈을 관리하고 검색하는 기능 제공.

애플리케이션을 개발할 때는 빈을 관리하고 조회하는 기능은 물론, 수많은 부가기능이 더 필요하다.

ApplicationContext가 제공하는 부가기능

• 메시지소스를 활용한 국제화 기능
  • 예를 들어서 한국에서 들어오면 한국어로, 영어권에서 들어오면 영어로 출력
• 환경변수
  • 실무에선 로컬 , 테스트 서버, 실제 프로덕션이 나가는 운영 개발환경이 있다.
  • 각 환경별로 어떤 DB를 연결해야 할지 등... 환경 변수에 대한 정보 처리
• 애플리케이션 이벤트
  • 이벤트를 발행하고 구독하는 모델을 편리하게 지원
• 편리한 리소스 조회
  • 파일, 클래스패스, 외부 등에서 리소스를 편리하게 조회

정리

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

---

4. 다양한 설정 형식 지원

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

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

자바 코드, XML, Groovy 등등

 

• 다양한 형식의 설정 정보 지원

 

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

지금 까지 했던 것이다.

ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);

 

AnnotationConfigApplicationContext 에 AppConfig.class를 넘겼던 것 처럼

AnnotationConfigApplicationContext 에 자바 코드로된 설정 정보를 넘기면 된다.

 

그러면

AppConfig에서 @Bean 애노테이션이 붙은 메서드들을 스프링 컨테이너에 빈으로 등록 되는 것이다.

XML 설정 사용

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

그러나 벗! B.U.T

아직 많은 레거시 프로젝트 들이 XML로 되어 있고, 또 XML을 사용하면 컴파일 없이 빈 설정 정보를 변경할 수 있는 장점도 있으므로 한번쯤 배워두는 것도 괜찮다. 😛

 

방법 : GenericXmlApplicationContext 를 사용하면서 xml 설정 파일을 넘기면 된다.

• appConfig.xml 위치

자바 파일이 아닌것은 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>

• test

public class XmlAppContext {

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

정리

• appConfig.xml(XML) 이나 AppConfig.java(자바 기반) 설정 정보는 비교해보면 비슷 하다.
• xml 기반으로 설정하는 것은 최근에 잘 사용하지 않으므로 이정도로 마무리 하고, 필요하면 스프링 공식 레퍼런스 문서를 확인하자. → Spring Framework

---

5. 스프링 빈 설정 메타 정보

스프링은 어떻게 이런 다양한 설정 형식을 지원하는 것 일까 ?

그 중심에는 BeanDefinition이라는 추상화가 있다. !

BeanDefinition 개념

결국 쉽게 말해 추상화를 통해 역할과 구현을 개념적으로 나눈 것이다.

• XML 을 읽어서 BeanDefinition을 만들면 됨.
• 자바 코드를 읽어서 BeanDefinition을 만들면 됨.

스프링 컨테이너는 자바 코드인지 , XML인지 몰라도 된다.

오직 BeanDefinition만 알면 된다.

 

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

• @Bean, <bean>당 각각 하나의 메타 정보가 생성된다.

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

코드 레벨로 깊게 들어가 보면

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

결국 스프링 컨테이너는 설정 정보를 읽고 BeanDefinition을 만들고 이 메타 정보를 토대로 스프링 빈을 생성한다.

 

그럼 BeanDefinition에는 무슨 정보를 저장할까?

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

/*
출력물
beanDefinitionName = appConfigbeanDefinitionGeneric bean: class [hello.core.AppConfig$$EnhancerBySpringCGLIB$$6db782b4]; scope=singleton; abstract=false; lazyInit=null; autowireMode=0; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=null; factoryMethodName=null; initMethodName=null; destroyMethodName=null
beanDefinitionName = memberServicebeanDefinitionRoot bean: class [null]; scope=; abstract=false; lazyInit=null; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=appConfig; factoryMethodName=memberService; initMethodName=null; destroyMethodName=(inferred); defined in hello.core.AppConfig
beanDefinitionName = memberRepositorybeanDefinitionRoot bean: class [null]; scope=; abstract=false; lazyInit=null; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=appConfig; factoryMethodName=memberRepository; initMethodName=null; destroyMethodName=(inferred); defined in hello.core.AppConfig
beanDefinitionName = orderServicebeanDefinitionRoot bean: class [null]; scope=; abstract=false; lazyInit=null; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=appConfig; factoryMethodName=orderService; initMethodName=null; destroyMethodName=(inferred); defined in hello.core.AppConfig
beanDefinitionName = discountPolicybeanDefinitionRoot bean: class [null]; scope=; abstract=false; lazyInit=null; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=appConfig; factoryMethodName=discountPolicy; initMethodName=null; destroyMethodName=(inferred); defined in hello.core.AppConfig
*/

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

정리

• AppConfig.class 방식을 팩토리 메서드를 통해서(약간 우회?) 빈을 등록하는 방법이라 함.
• appConfig.xml 방식을 직접 스프링 컨테이너에 등록하는 방법이라 함.
• BeanDefinition을 직접 생성해서 스프링 컨테이너에 등록할 수 도 있다. → 개발자가 설정 정보(AppConfig) 외적으로 BeanDefinition 객체를 만들어서 등록할 수 있다.
• 하지만 실무에선 BeanDefinition을 직접 정의하거나 사용할 일은 거의 없다. → 깊이있게 이해하기 보단 스프링이 다양한 형태의 설정 정보를 BeanDefinition으로 추상화해서 사용하는 것 정도만 이해하면 된다.
• 가끔 스프링 코드나 스프링 관련 오픈 소스의 코드를 볼 때, BeanDefinition 이라는 것이 보일 때가 있다. 이때 이러한 메커니즘을 떠올리면 된다.