[스프링 핵심 원리] 04. 스프링 컨테이너와 스프링 빈 - 스프링 빈 조회(상속 관계)

(인프런) 김영한님의 스프링 핵심 원리-기본편을 공부하고 리뷰한 글입니다.

5. 스프링 빈 조회(상속 관계)

부모 타입도 조회하면 자식 타입도 함께 조회된다!

모든 자바 객체의 최상위 클래스인 Object 타입으로 조회하면 모든 스프링 빈을 조회한다.

 

1. ApplicationContextExtendsFindTest 예제 코드

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);
        // rateDiscountPolicy가 RateDiscountPolicy의 인스턴스인지 검증
        assertThat(rateDiscountPolicy).isInstanceOf(RateDiscountPolicy.class);
    }
    
    // 안좋은 방법
    @Test
    @DisplayName("특정 하위 타입으로 조회")
    void findBeanBySubType() {
        RateDiscountPolicy bean = ac.getBean(RateDiscountPolicy.class);
        // bean이 RateDiscountPolicy의 인스턴스인지 검증
        assertThat(bean).isInstanceOf(RateDiscountPolicy.class);
    }

    @Test
    @DisplayName("부모 타입으로 모두 조회")
    void findAllBeanByParentType() {
        // DiscountPolicy 타입인 모든 빈을 Map으로 반환
        Map<String, DiscountPolicy> beansOfType = ac.getBeansOfType(DiscountPolicy.class);
        // DiscountPolicy 타입인 빈의 개수가 맞는지 검증
        assertThat(beansOfType.size()).isEqualTo(2);
        // DiscountPolicy 타입인 빈의 정보 출력(빈 이름, 빈 객체)
        for (String key : beansOfType.keySet()) {
            System.out.println("key = " + key + " value = " + beansOfType.get(key));
        }
    }

    // 스프링 컨테이너에 등록된 모든 빈 조회(내부 빈 & 사용자 등록 빈)
    @Test
    @DisplayName("부모 타입으로 모두 조회하기 - Object")
    void findAllBeanByObjectType() {
        // Object 타입인 모든 빈을 Map으로 반환
        Map<String, Object> beansOfType = ac.getBeansOfType(Object.class);
        // Object 타입인 빈의 정보 출력(빈 이름, 빈 객체)
        for (String key : beansOfType.keySet()) {
            System.out.println("key = " + key + " value = " + beansOfType.get(key));
        }
    }

    @Configuration
    static class TestConfig {
        // 부모 타입이 DiscountPolicy인 2개의 빈
        @Bean
        public DiscountPolicy rateDiscountPolicy() {
            return new RateDiscountPolicy();
        }

        @Bean
        public DiscountPolicy fixDiscountPolicy() {
            return new FixDiscountPolicy();
        }
    }
}

 

1) TestConfig - 설정 정보 클래스

이 테스트 클래스내에서만 사용하기 위해 만든 Config 클래스이기때문에 static으로 선언하였다.

@Configuration
static class TestConfig {
    // 부모 타입이 DiscountPolicy인 2개의 빈
    @Bean
    public DiscountPolicy rateDiscountPolicy() {
        return new RateDiscountPolicy();
    }

    @Bean
    public DiscountPolicy fixDiscountPolicy() {
        return new FixDiscountPolicy();
    }
}

 

• 타입 = DiscountPolicy 인 빈 2개(rateDiscountPolicy, fixDiscountPolicy)를 등록한다.

2) findBeanByParentTypeDuplicate() - getBean(부모 타입)으로 조회시, 자식이 둘 이상이면 중복 오류

@Test
@DisplayName("부모 타입으로 조회시, 자식이 둘 이상 있으면, 중복 오류가 발생한다")
void findBeanByParentTypeDuplicate() {
    // 오른쪽 로직을 수행했을 때 왼쪽 예외가 터져야 테스트 성공
    assertThrows(NoUniqueBeanDefinitionException.class,
            () -> ac.getBean(DiscountPolicy.class));
}

 

• 타입 = DiscountPolicy 인 빈을 조회한다.
• 부모 타입이 DiscountPolicy 인 빈이 2개이므로 NoUniqueBeanDefinitionException 예외가 발생한다.

3) findBeanByParentTypeBeanName() - 자식이 2개 이상이어도 getBean(이름, 부모 타입)으로 조회하면 성공

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

• 이름 = rateDiscountPolicy, 타입 = DiscountPolicy 인 빈을 조회한다.
• 조회한 빈의 객체 타입이 RateDiscountPolicy 인지 검증한다. 

4) findBeanBySubType() - getBean(타입) 특정 하위 타입으로 조회

특정 하위 타입으로 조회하는 것은 좋지 않은 방식이다.

// 안좋은 방법
@Test
@DisplayName("특정 하위 타입으로 조회")
void findBeanBySubType() {
    RateDiscountPolicy bean = ac.getBean(RateDiscountPolicy.class);
    // bean이 RateDiscountPolicy의 인스턴스인지 검증
    assertThat(bean).isInstanceOf(RateDiscountPolicy.class);
}

• 타입 = RateDiscountPolicy 인 빈을 조회한다.
• 조회한 빈의 객체 타입이 RateDiscountPolicy 인지 검증한다. 

5) findAllBeanByParentType() - getBeansOfType(부모 타입)으로 (부모 타입+하위 타입) 빈 조회

@Test
@DisplayName("부모 타입으로 모두 조회")
void findAllBeanByParentType() {
    // DiscountPolicy 타입인 모든 빈을 Map으로 반환
    Map<String, DiscountPolicy> beansOfType = ac.getBeansOfType(DiscountPolicy.class);
    // DiscountPolicy 타입인 빈의 개수가 맞는지 검증
    assertThat(beansOfType.size()).isEqualTo(2);
    // DiscountPolicy 타입인 빈의 정보 출력(빈 이름, 빈 객체)
    for (String key : beansOfType.keySet()) {
        System.out.println("key = " + key + " value = " + beansOfType.get(key));
    }
}

• 타입 = DiscountPolicy 인 모든 빈을 조회한다.
• Map으로 반환된 모든 빈의 개수가 2개(FixDiscountPolicy, RateDiscountPolicy)가 맞는지 검증한다.

6) findAllBeanByObjectType() - getBeansOfType(Object)로 모든 빈 조회

// 스프링 컨테이너에 등록된 모든 빈 조회(내부 빈 & 사용자 등록 빈)
@Test
@DisplayName("부모 타입으로 모두 조회하기 - Object")
void findAllBeanByObjectType() {
    // Object 타입인 모든 빈을 Map으로 반환
    Map<String, Object> beansOfType = ac.getBeansOfType(Object.class);
    // Object 타입인 빈의 정보 출력(빈 이름, 빈 객체)
    for (String key : beansOfType.keySet()) {
        System.out.println("key = " + key + " value = " + beansOfType.get(key));
    }
}

• 타입 = Object 인 모든 빈을 조회한다. (Object는 최상위 클래스이므로 모든 빈이 조회됨)
• Map으로 반환된 모든 빈 정보 출력

<결과>

스프링 컨테이너에 등록된 내부 빈 & 사용자 등록 빈 모두 출력된 것을 확인할 수 있다.

---

 

<정리>

1. 스프링 빈 이름 조회

▶getBeanDefinitionNames(): ApplicationContext(스프링 컨테이너)에 등록된 모든 스프링 빈 이름 조회

 

2. 스프링 빈 객체 조회

- 부모 타입으로 조회하면 자식 타입까지 조회된다.(중요!)

- 구체 타입으로 조회하는 것은 변경시 유연성이 떨어지므로 좋지 않은 방식이다.

- Object 타입으로 조회하면 모든 스프링 빈이 조회된다.

▶ getBean(타입): ApplicationContext(스프링 컨테이너)에 등록된 해당 타입의 스프링 빈 객체 조회

- NoSuchBeanDefinitionException: 조회 대상 스프링 빈이 없을 때 예외 발생

- NoUniqueBeanDefinitionException: 같은 타입의 스프링 빈이 2개 이상일 때 중복 오류

▶ getBean(빈 이름, 타입): ApplicationContext(스프링 컨테이너)에 등록된 (빈 이름, 타입)의 스프링 빈 객체 조회

- NoSuchBeanDefinitionException: 조회 대상 스프링 빈이 없을 때 예외 발생

- 동일한 타입이 2개 이상이거나 부모 타입의 자식 타입이 2개 이상일 때, 빈 이름으로 조회해야 중복 오류를 막을 수 있다.

▶ getBeansOfType(타입): ApplicationContext(스프링 컨테이너)에 등록된 해당 타입의 모든 스프링 빈 객체 조회

 

Q. 스프링 빈 조회 기능에 대해 공부한 이유는?

실제 개발할 때는 ApplicationContext에서 스프링 빈을 조회할 일은 거의 없다. 하지만,

1) 스프링 빈 조회는 기본 기능이다.

2) 가끔 순수 자바 애플리케이션에서 스프링 컨테이너를 생성해서 써야하는 경우, 스프링 빈 조회를 사용한다.

3) "부모 타입으로 조회할 때 어디까지 조회되는지"에 대한 이해가 있어야 자동 의존 관계 주입에 대해 문제없이 잘 해결할 수 있다.