[스프링 기본] 컨테이너와 스프링 빈

공부 내용을 정리하고 앞으로의 학습에 이해를 돕기 위해 작성합니다.

 

스프링 컨테이너 생성

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

ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);

- ApplicationContext를 스프링 컨테이너라고 한다.

- ApplicationContext는 인터페이스이다.

- 스프링 컨테이너는 XML 기반으로 만들 수 있고, 애노테이션 기반의 자바 설정 클래스로 만들 수 있다.

- 이전에 AppConfig를 사용했던 방식이 애노테이션 기반의 자바 설정 클래스로 스프링 컨테이너를 만든 것이다.

- 자바 설정 클래스를 기반으로 스프링 컨테이너(ApplicationContext)를 만들어보자

  - new AnnotationConfigApplicationContext(Appconfig.class);

  - 이 클래스는 ApplicationContext 인터페이스의 구현체이다.

 

* 스프링 컨테이너는 BeanFactory와 ApplicationContext로 구분되지만 일반적으로 ApplicationContext를 스프링 컨테이너라 한다. BeanFactory를 직접 사용하는 경우는 거의 없다.

 

그림으로 보면

- new AnnotationConfigApplicationContext(AppConfig.class)

- 스프링 컨테이너를 생성할 때는 구성 정보(AppConfig.class)를 지정해주어야 한다.

 

- 스프링 컨테이너는 @Bean이 붙어있는 클래스들을 스프링 빈에 등록한다.

- Key는 메서드 이름, Value는 return 값으로 지정한다.

- 빈 이름은 메서드 이름을 사용한다.

- 빈 이름을 직접 부여할 수도 있다.

 

주의 : 빈 이름은 항상 다른 이름을 부여해야 한다. 다른 빈이 무시되거나, 덮어버리는 오류가 발생하기 때문이다.

 

Tip : 실무에서는 단순하고 명확하게 개발해야 한다. 이름 명명할 때, 헷갈리게 만들면 안 된다.

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

 

참고: 스프링은 빈 생성과 의존관계 주입 단계를 나누어 처리하지만, 자바 코드로 스프링 빈을 등록하면 생성자 호출 시 의존관계 주입이 함께 처리된다.

여기서는 이해를 돕기 위해 개념적으로 나누어 설명했다. 자세한 내용은 의존관계 자동 주입에서 설명하겠다.

 

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

스프링 컨테이너에 실제 스프링 빈들이 잘 등록되었는지 확인해 보자.

 

Test 파일을 생성한다.

package hello.core.beanfind;

import hello.core.AppConfig;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

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

            if (beanDefinition.getRole() == BeanDefinition.ROLE_APPLICATION) {
                Object bean = ac.getBean(beanDefinitionName);
                System.out.println("name = " + beanDefinitionName + "object = " + bean);
            }
        }
    }
}

• 모든 빈 출력하기 
  • 실행하면 스프링에 등록된 모든 빈 정보를 출력할 수 있다.
  • ac.getBeanDefinitionNames(): 스프링에 등록된 모든 빈 이름을 조회한다.
  • ac.getBean(): 빈 이름으로 빈 객체(인스턴스)를 조회한다.

• 애플리케이션 빈 출력하기
  • 스프링이 내부에서 사용하는 빈은 제외하고, 내가 등록한 빈만 출력해 보자.
  • 스프링이 내부에서 사용하는 빈은 getRole()로 구분할 수 있다.
    • ROLE_APPLICATION: 일반적으로 사용자가 정의한 빈
    • ROLE_INFRASTRUCTURE: 스프링이 내부에서 사용하는 빈

단축키 TIP

- iter + 앤터 : forEach문 생성

- soutm : 함수명 출력문 생성

- soutv : 직전 변수명 출력문 생성

 

스프링 빈 조회 - 기본

package hello.core.beanfind;

import hello.core.AppConfig;
import hello.core.member.MemberService;
import hello.core.member.MemberServiceImpl;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

import static org.assertj.core.api.Assertions.*;
import static org.junit.jupiter.api.Assertions.*;

public class ApplicationContextBasicFindText {

    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", MemberService.class);
        assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
    }

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

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

}

•  스프링 컨테이너에서 스프링 빈을 찾는 가장 기본적인 조회 방법
  • ac.getBean(빈이름, 타입)
  • ac.getBean(타입)
  • 조회 대상 스프링 빈이 없으면 예외 발생 
    • NoSuchBeanDefinitionException: No bean named 'xxxxx' available
    • junit의 Assertions를 사용한다.
• 3번째 테스트인 "구체 타입으로 조회"는 역할과 책임을 위반한 예이다. 인터페이스에 의존해야 하는데 구현체에 의존하고 있다.

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

package hello.core.beanfind;

import hello.core.member.MemberRepository;
import hello.core.member.MemoryMemberRepository;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.NoUniqueBeanDefinitionException;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.util.Map;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertThrows;

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

    @Test
    @DisplayName("타입으로 조회시 같은 타입이 둘 이상 있으면, 중복 오류가 발생한다.")
    void findBeanByTypeDuplicate() {
        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()을 사용하면 해당 타입의 모든 빈을 조회할 수 있다.

 

. class의 의미가 애매모호해서 챗GPT에게 물어봤다. 

- class는 특정 클래스 타입을 지정하여 해당 타입의 객체를 스프링 컨테이너에서 찾기 위해 사용된다.

- ac는 ApplicationContext의 약자로 스프링 컨테이너를 의미한다.

 

스프링 빈 조회 - 상속 관계

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

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

 

package hello.core.beanfind;

import hello.core.discount.DiscountPolicy;
import hello.core.discount.FixDiscountPolicy;
import hello.core.discount.RateDiscountPolicy;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.NoUniqueBeanDefinitionException;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.util.Map;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertThrows;

public class ApplicationConTextExtendsFindTest {
    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);
        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 fixedDiscountPolicy() {
            return new FixDiscountPolicy();
        }
    }
}

 

스프링 빈 조회 - 상속 관계

BeanFactory

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

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

- getBean()을 제공한다.

- 지금까지 사용했던 대부분 기능은 BeanFactory가 제공하는 기능이다.

 

ApplicationContext

- BeanFactory 기능을 모두 상속받아서 제공한다.

- 빈을 관리하고 검색하는 기능을 BeanFactory가 제공해 준다.

 

그렇다면 둘의 차이가 뭘까?

 

 

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

정리

- ApplicationContext는 BeanFactory의 기능을 상속받는다.

- ApplicationContext는 빈 관리기능 + 편리한 부가 기능을 제공한다.

 

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

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

- 지금까지 했던 것이다.

- new AnnotationConfigApplicationContext(AppConfig.class)

- AnnotationConfigApplicationContext 클래스를 사용하면서 자바 코드로 된 설정 정보를 넘기면 된다.

 

XML 설정 사용

- 최근에는 스프링 부트를 많이 사용하면서 XML 기반 설정은 잘 사용하지 않는다. 하지만 많은 레거시 프로젝트에서 여전히 XML을 사용하며, XML은 컴파일 없이 빈 설정 정보를 변경할 수 있는 장점이 있다.

- GenericXmlApplicationContext를 사용하여 XML 설정 파일을 넘기면 된다.

 

xml 파일은 resources 밑에 XML Counfiguration File로 만들었다.

 

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>

 

XmlAppConfig 사용 자바 코드

package hello.core.xml;

import hello.core.member.MemberService;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.GenericXmlApplicationContext;

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

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 기반의 appConfig.xml 스프링 설정 정보와 자바 코드로 된 AppConfig.java 설정 정보는 거의 비슷하다.

 

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

스프링은 어떻게 이런 다양한 설정 형식을 지원하는 것일까? 그 중심에는 BeanDefinition이라는 추상화가 있다.

한마디로, 역할과 구현을 개념적으로 나눈 것이다.

 

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

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

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

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

조금 더 깊게 살펴보자

 

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

- BeanDefinition을 직접 생성해서 스프링 컨테이너에 등록할 수 도 있다. 하지만 실무에서 BeanDefinition을 직접 정의하거나 사용할 일은 거의 없다.

- 스프링은 다양한 형태의 설정 정보를 BeanDefinition으로 추상화해서 사용한다.

package hello.core.beandefinition;

import hello.core.AppConfig;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.support.GenericXmlApplicationContext;

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

package hello.core.beandefinition;

import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.context.support.GenericXmlApplicationContext;

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

 

스프링에 빈을 등록하는 방법은 크게 두 가지가 있다.

 

1. 우회해서 등록하는 방법(위 예시에서는 AnnotationConfigApplicationContext)

- 팩토리 메서드를 사용한다.

- 자바코드를 가지고 등록하는 방법 (AppConfig 클래스)은 팩토리 메서드를 통해서 등록하는 방법이다.

- 내가 직접 임의의 코드를 조작해서 넣을 수 있다.

- 그래서 실행결과를 보면 class가 [null]이다. 정보가 직접적으로 드러나는 것이 아니라, 팩토리 빈(AppConfig) -> 팩토리 메서드(memberService)를 통해서 호출된다.

- 즉, memberService라는 팩토리 메서드를 사용해서 생성한 것이다. 

 

2.  직접 스프링 빈을 등록하는 방법 (위 예시에서는 GenericXmlApplicationContext)

- 결과를 보면 bean의 정보가 명확하게 드러나 있고 팩토리 메서드는 사용하지 않는 것을 볼 수 있다.

 

그리고 강사님이 GenericXmlApplicationContext를 ApplicationContext으로 바꾸면 ac.getBeanDefinition을 사용할 수 없다라고 하셨는데 그 이유가 궁금해서 챗GPT에게 물어봤다.

 

따라서 ApplicationContext 인터페이스에는 getBeanDefinition() 메서드가 정의되어 있지 않기 때문에 에러가 나는 것이었다.

 

BeanDefinition 정보

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