스프링 빈 조회

이 포스트는 인프런 사이트에 김영한 - 스프링 핵심원리 강의를 보고 정리한 포스터입니다.

https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8

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

 

---

스프링 빈을 조회하는 방법에 대해 알아보겠습니다.
스프링에서 빈을 조회하는 것은 개발 중에 컨테이너에 어떤 빈이 등록되어 있는지 확인하거나, 특정 빈을 가져와야 할 때 중요한 과정입니다.

---

🔆 1. 모든 빈 조회하기

먼저, 스프링 컨테이너에 등록된 모든 빈을 출력하여 확인해보겠습니다.

 

🔹 모든 빈 출력

package hello.core.beanfind;

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;

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

✅ 실행 결과

■ 이 코드를 실행하면 스프링 컨테이너에 등록된 모든 빈을 출력할 수 있습니다. 
■  ac.getBeanDefinitionNames() 메서드를 사용하여 등록된 모든 빈의 이름을 가져오고, ac.getBean(beanDefinitionName)을 통해 빈 객체를 가져옵니다.
■ ac.getBean() : 빈 이름으로 빈 객체(인스턴스)를 조회합니다.

 

 

🔹 애플리케이션 빈 출력

스프링 컨테이너에는 우리가 직접 등록한 빈 외에도 스프링이 내부적으로 사용하는 빈이 있습니다. 이러한 내부 빈을 제외하고 사용자가 등록한 빈만 출력하는 방법은 다음과 같습니다.

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

스프링이 내부에서 사용한 빈은 getRole()로 구분할 수 있습니다.

● ROLE_APPLICATION : 일반적으로 사용자가 정의한 빈이며, 역할을 가진 빈만 필터링하여 출력합니다.
● ROLE_INFRASTRUCTURE : 스프링이 내부에서 사용하는 빈입니다.

 

---

🔆 2. 특정 빈 조회하기

스프링 컨테이너에서 특정 빈을 조회하는 방법을 알아봅시다.

 

🔹 빈 이름으로 조회

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

ac.getBean(빈 이름, 빈 타입)을 사용하여 특정 빈을 조회할 수 있습니다.

 

🔹 타입으로 조회

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

ac.getBean(타입)을 사용하여 빈의 이름을 지정하지 않고 타입만으로 조회할 수도 있습니다.

 

🔹 구체적인 타입으로 조회

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

하지만, 구체적인 타입으로 조회하면 향후 구현체가 변경될 경우 유연성이 떨어지는 문제가 있습니다.

 

🔹 빈이 존재하지 않을 경우 예외 처리

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

존재하지 않는 빈을 조회하면 NoSuchBeanDefinitionException이 발생합니다.

 

---

🔆 3. 동일한 타입이 둘 이상 존재할 경우

만약 같은 타입의 빈이 여러 개 등록되어 있다면, 타입만으로 조회하면 NoUniqueBeanDefinitionException 오류가 발생합니다.

이 경우, ac.getBeansOfType()을 사용하여 빈 이름을 지정하여 조회하면 됩니다.

 

🔹 동일한 타입이 둘 이상 있을 때 오류 발생

@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));
    }
    assertThat(beansOfType.size()).isEqualTo(2);
}

ac.getBeansOfType()을 사용하면 특정 타입의 모든 빈을 조회할 수 있습니다.

 

---

🔆 4. 부모 타입으로 조회하기

부모 타입으로 조회하면 해당 부모를 상속받은 모든 자식 타입 빈을 조회할 수 있습니다.

 

🔹 부모 타입으로 조회 시 중복 오류 발생

@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 findAllBeanByParentType() {
    Map<String, DiscountPolicy> beansOfType = ac.getBeansOfType(DiscountPolicy.class);
    assertThat(beansOfType.size()).isEqualTo(2);
}

 

---

정리

이처럼 스프링 컨테이너에서 빈을 조회하는 방법에는 여러 가지가 있습니다.

1️⃣ 모든 빈 조회
2️⃣ 특정 빈 조회 (이름, 타입, 구체 타입)
3️⃣ 동일한 타입이 둘 이상일 때 조회 방법
4️⃣ 부모 타입으로 조회