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

조유정·2023년 6월 28일
InflearnSpring

Spring/SpringBoot

목록 보기
4/5

인프런 김영한 강사님의 <스프링 핵심 원리-기본편> 강의를 정리한 글입니다.

//스프링 컨테이너 생성
ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);
  • ApplicationContext를 스프링 컨테이너라고 한다.
    • ApplicationContext는 인터페이스이다.
    • AnnotationConfigApplicationContext는 ApplicationContext를 구현한 구현객체이다.
  • XML을 기반 스프링 컨테이너 vs 애노테이션 기반 스프링 컨테이너
    • 스프링부트는 애노테이션 기반
    • 애노테이션이 더 쉽고 깔끔해서 요즘은 애노테이션

참고: 더 정확히는 스프링 컨테이너를 부를 때 BeanFactory , ApplicationContext 로 구분해서 이야기 한다. 이 부분은 뒤에서 설명하겠다. BeanFactory 를 직접 사용하는 경우는 거의 없으므로 일반적으로 ApplicationContext 를 스프링 컨테이너라 한다.

스프링 컨테이너 생성

  1. 스프링 컨테이너 생성

  1. 스프링 빈 등록

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

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

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

자바 코드로 스프링 빈 을 등록하면 생성자를 호출하면서 의존관계 주입도 한번에 처리된다. 메소드 생성 순서에 따라 의존관계가 뒤죽박죽 될 일이 없다.

스프링 빈 조회 - 모든 빈

테스트 코드를 작성하여, 빈이 등록되었는지 확인해보자.

public class ApplicationContextInfoTest {
    
    AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);
    
    @Test
    @DisplayName("모든 빈 출력하기")
    void findAllBean() {
        String[] beanDefinitionNames = applicationContext.getBeanDefinitionNames();
        for (String beanDefinitionName : beanDefinitionNames) {
            Object bean = applicationContext.getBean(beanDefinitionName);
            System.out.println("name = " + beanDefinitionName + " object" + bean);
        }
        
    }

    @Test
    @DisplayName("애플리케이션 빈 출력하기")
    void findApplicationBean() {
        String[] beanDefinitionNames = applicationContext.getBeanDefinitionNames();
        for (String beanDefinitionName : beanDefinitionNames) {
            BeanDefinition beanDefinition = applicationContext.getBeanDefinition(beanDefinitionName);

            // ROLE_APPLICATION: 직접 등록한 애플리케이션 빈
            // ROLE_INFRASTRUCTURE: 스프링이 내부에서 사용하는 빈
            if(beanDefinition.getRole() == BeanDefinition.ROLE_APPLICATION) {
                Object bean = applicationContext.getBean(beanDefinitionName);
                System.out.println("name = " + beanDefinitionName + " object" + bean);
            }
        }

    }   
}

스프링 빈 조회 - 빈

위는 모든 빈을 출력하는 코드이다.
일반적으로 사용하는 스프링 빈 조회 방법을 살펴보자.

  • 스프링 컨테이너에서 스프링 빈을 찾는 가장 기본적인 조회 방법
    • applicationContext.getBean(빈이름, 타입)
    • applicationContext.getBean(타입)
  • 조회 대상 스프링 빈이 없으면 예외 발생
    NoSuchBeanDefinitionException: No bean named 'xxxxx' available
public class ApplicationContextBasicFindTest {

    AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);

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

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

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

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

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

타입으로 조회시 같은 타입의 스프링 빈이 둘 이상이면 오류가 발생한다.
이번에는 동일한 타입이 둘 이상인 경우에 스프링 빈을 조회하는 방법을 살펴보자.

  • 빈 이름을 지정한다.
  • 해당 타입의 모든 빈을 조회한다.
    • applicationContext.getBeansOfType()
public class ApplicationContextSameBeanFIndTest {

    AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(SameBeanConfig.class);

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

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

    @Test
    @DisplayName("특정 타입을 모두 조회하기")
    void findAllBeanByName() {
        Map<String, MemberRepository> beansOfType = applicationContext.getBeansOfType(MemberRepository.class);
        for (String key : beansOfType.keySet()) {
            System.out.println("key = " + key + " value = " + beansOfType.get(key));
        }
        System.out.println("beansOfType = " + beansOfType);
        org.assertj.core.api.Assertions.assertThat(beansOfType.size()).isEqualTo(2);
    }

    @Configuration
    static class SameBeanConfig {

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

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

    }

}

스프링 빈 조회 - 상속관계인 빈

스프링 빈을 조회할 때, 자식 타입이 있다면 함께 조회된다.
부모 타입으로 조회하면, 자식 타입도 함께 조회한다.
그래서 Object 타입으로 조회하면, 모든 스프링 빈을 조회한다.

public class ApplicationContextExtendsFindTest {

    AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(TestConfig.class);

    @Test
    @DisplayName("부모 타입으로 조회시, 자식이 둘 이상 있으면, 중복 오류가 발생한다.")
    void findBeanByParentTypeDuplicate() {
        Assertions.assertThrows(NoUniqueBeanDefinitionException.class, () -> applicationContext.getBean(DiscountPolicy.class));
    }

    @Test
    @DisplayName("부모 타입으로 조회시, 자식이 둘 이상 있으면, 빈 이름을 지정하면 된다.")
    void findBeanByParentTypeBeanName() {
        DiscountPolicy rateDiscountPolicy = applicationContext.getBean("rateDiscountPolicy",
                DiscountPolicy.class);
        assertThat(rateDiscountPolicy).isInstanceOf(RateDiscountPolicy.class);
    }

    // 좋지 않은 코드
    @Test
    @DisplayName("특정 하위 타입으로 조회")
    void findBeanBySubType() {
        RateDiscountPolicy bean = applicationContext.getBean(RateDiscountPolicy.class);
        assertThat(bean).isInstanceOf(RateDiscountPolicy.class);
    }

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

    @Test
    @DisplayName("부모 타입으로 모두 조회하기 - Object")
    void findAllBeanByObjectType() {
        Map<String, Object> beansOfType = applicationContext.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 FixDoiscountPolicy();
        }
    }

}

BeanFactory vs ApplicationContext

  • BeanFactory
    • 스프링 컨테이너의 최상위 인터페이스다.
    • 스프링 빈을 관리하고 조회하는 역할을 담당한다.
    • getBean() 을 제공한다.
    • 지금까지 우리가 사용했던 대부분의 기능은 BeanFactory가 제공하는 기능이다.
  • ApplicationContext
    • BeanFactory 기능을 모두 상속받아서 제공한다.
    • 빈을 관리하고 검색하는 기능을 BeanFactory가 제공해주는데, 그러면 둘의 차이가 뭘까?
    • 애플리케이션을 개발할 때는 빈을 관리하고 조회하는 기능은 물론이고, 수 많은 부가기능이 필요하다.

[AppplicationContext가 제공하는 부가기능]

  • 메시지소스를 활용한 국제화 기능
    • 예를 들어서 한국에서 들어오면 한국어로, 영어권에서 들어오면 영어로 출력
  • 환경변수
    • 로컬, 개발, 운영등을 구분해서 처리
  • 애플리케이션 이벤트
    • 이벤트를 발행하고 구독하는 모델을 편리하게 지원
  • 편리한 리소스 조회
    • 파일, 클래스패스, 외부 등에서 리소스를 편리하게 조회

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

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

지금까지 자바코드를 사용하여 설정 정보를 구현하였다.
스프링 컨테이너는 자바코드, XML, Groovy 등 다양한 형식의 설정 정보를 받아드릴 수 있게 유연하게 설계되었다.

  • 애노테이션 기반 자바 코드 설정 사용
    • new AnnotationConfigApplicationContext(AppConfig.class)
    • AnnotationConfigApplicationContext 클래스를 사용하면서 자바 코드로된 설정 정보를 넘기면 된다.
  • XML 설정 사용
    • 최근에는 스프링 부트를 많이 사용하면서 XML기반의 설정은 잘 사용하지 않는다.
    • 아직 많은 레거시 프로젝트 들이 XML로 되어 있고, 또 XML을 사용하면 컴파일 없이 빈 설정 정보를 변경할 수 있는 장점도 있으므로 한번쯤 배워두는 것도 괜찮다.
    • GenericXmlApplicationContext 를 사용하면서 xml 설정 파일을 넘기면 된다.

다음은 xml을 사용하여 빈 설정한 appConfig.xml 파일이다.
(main > resources 에 추가한다. 자바 코드가 아닌 파일은 일반적으로 resources 폴더에 둔다.)

AppConfig.java와 비교해보았을 때, 설정하는 형식이 다르지 구성을 보면 똑같다.

<?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="inflearn.spring.basic.member.MemberServiceImpl">
            <constructor-arg name="memberRepository" ref="memberRepository" />
        </bean>

        <bean id="memberRepository" class="inflearn.spring.basic.member.MemoryMemberRepository" />

        <bean id="orderService" class="inflearn.spring.basic.order.OrderServiceImpl">
            <constructor-arg name="memberRepository" ref="memberRepository" />
            <constructor-arg name="discountPolicy" ref="discountPolicy" />
        </bean>

        <bean id="discountPolicy" class="inflearn.spring.basic.discount.RateDiscountPolicy" />

</beans>
@Configuration
public class AppConfig {

    @Bean
    public MemberService memberService() {
        return new MemberServiceImpl(memberRository());
    }

    @Bean
    public static MemoryMemberRepository memberRository() {
        return new MemoryMemberRepository();
    }

    @Bean
    public OrderService orderService() {
        return new OrderServiceImpl(memberRository(), discountPolicy());
    }

    @Bean
    public static DiscountPolicy discountPolicy() {
        return new RateDiscountPolicy();
    }

}

작성한 appConfig.xml을 GenericXmlApplicationContext()에 넣어주면 의존성을 주입할 수 있다.

public class XMLAppContext {

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

}

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

(몰라도 개발에 지장 없긴 함)

Q. 스프링이 다양한 설정 정보를 지원할 수 있는 이유는 무엇일까?
A. BeanDefinition이라는 추상화가 있기 때문이다.

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

    • XML을 읽어서 BeanDefinition을 만들면 된다.
    • 자바 코드를 읽어서 BeanDefinition을 만들면 된다.
    • BeanDefinition 자체가 인터페이스이다.

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

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

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

🔽 더 깊게

BeanDefinition을 출력해서 함 봐보자

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

    AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);

    @Test
    @DisplayName("빈 설정 메타정보 확인")
    void findApplicationBean() {
        String[] beanDefinitionNames = applicationContext.getBeanDefinitionNames();
        for (String beanDefinitionName : beanDefinitionNames) {
            BeanDefinition beanDefinition = applicationContext.getBeanDefinition(beanDefinitionName);

            if(beanDefinition.getRole() == BeanDefinition.ROLE_APPLICATION) {
                System.out.println("beanDefinitionName = " + beanDefinitionName + " beanDefinition = " + beanDefinition);
            }
        }
    }
}

beanDefinition을 그대로 출력해보면, beanDefinition의 메타 정보를 확인할 수 있다. 개발을 하는데는 몰라도 지장없는 내용이지만, 직접 BeanDefinition의 메타정보에 정보를 넣어가며 빈을 생성하는 코드를 간혹가다 볼 수 있기 때문에 알아두면 좋다.

profile
조유정
나는 아직 멍청하다
이전 포스트

[Spring] 스프링 핵심 원리 - 기본편 : 스프링 핵심 원리 이해2 - 객체 지향 원리 적용

다음 포스트

[Spring] 스프링 핵심 원리 - 기본편 : 싱글톤 컨테이너

0개의 댓글