📖 ✏️

TILシリーズの記事は「毎日学ぶ知識のかけらを記録する」です.これは、共有ではなく個人学習を記録するために作成されます.

の他のシリーズで作成された共有用のロケーションは、いつでも個別に作成されます.主に、TILシリーズで作成されたコンテンツから特定のトピックを選択し、より深い学習とまとめを行います.

スプリングコンテナに登録されているbeanを検索

スプリングコンテナに登録されているbeanをクエリーする方法はいくつかあります.

1.登録されているbeanをすべて表示

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;

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);// getBean(): Bean 이름으로 Bean 객체(인스턴스)를 조회
            System.out.println("name = " + beanDefinitionName + " object: " + bean);
        }
    }

    @Test
    @DisplayName("애플리케이션 빈 출력하기")
    void findApplicationBean() {
        String[] beanDefinitionNames = ac.getBeanDefinitionNames();
        for (String beanDefinitionName : beanDefinitionNames) {
            // getBeanDefinition(): Bean 이름으로 Bean의 메타데이터 조회
            BeanDefinition beanDefinition = ac.getBeanDefinition(beanDefinitionName);

            // ROLE.APPLICATION: 개발자가 애플리케이션 개발을 위해 등록한 bean 또는 외부 라이브러리
            // ROLE.INFRASTRUCTURE: 스프링 내부에서 사용하는 bean
            if (beanDefinition.getRole() == BeanDefinition.ROLE_APPLICATION) {
                Object bean = ac.getBean(beanDefinitionName); // getBean(): Bean 이름으로 Bean 객체(인스턴스)를 조회
                System.out.println("name = " + beanDefinitionName + " object: " + bean);
            }
        }
    }
}

1-1. 登録済みbeanをすべて検索

getBeanDefinitionNames()スプリングの登録されたbeanのすべての名前をString配列に戻します.受信したbeanの名前はgetbean()をオブジェクトとして再受信できます.ただし、返されるオブジェクトはObjectタイプです.ac.getBeanDefinitionNames():Springに登録されているすべてのbean名を検索ac.getBean("이름"):bean名を使用してbeanオブジェクトをクエリーする(インスタンス)

1-2. 開発者が自分で登録したbeanを問い合わせる

getBeanDefinition()を使用して、bean名を使用してbeanのメタデータを受信することができる.メタデータにはROLEという情報があります.ROLE_APPLICATIONはユーザによって作成され登録されたbeanであり、ROLE_INFRASTRUCTUREはスプリング内部で作成され登録されたbeanである.ROLE_APPLICATIONを条件に直接登録されたbeanのみがクエリーできます.getBeanDefinition():bean名を使用してbeanのメタデータをクエリーするROLE_APPLICATION:通常、ユーザによって定義されるbean.開発者は、アプリケーションに登録されたbeanまたは外部ライブラリを開発します.ROLE_INFRASTRUCTURE:スプリング内部で使用されるbean.

2.beanの名前とタイプを表示する

2-1. 名前とタイプを使用したクエリー

beanの名前でクエリーすることは、SpringコンテナでSpringによって管理されるbeanを検索する最も基本的な方法です.getBean()を使用すると、名前とタイプでオブジェクトを検索できます.タイプのみでクエリーできます.ただし、同じタイプのオブジェクトが存在する必要があります.getBean()は単一のオブジェクトを返すからです.クエリという名前のオブジェクトがない場合は、NoSuchBeanDefinitionExceptionが発生します.

public class ApplicationContextBasicFindTest {
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

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

        System.out.println("memberService = " + memberService);
        System.out.println("memberService.getClass() = " + memberService.getClass());

        assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
    }
}

getBean(빈이름, 타입):指定したタイプのオブジェクトを返します.パラメータにbean名のみが含まれている場合はobjectオブジェクトを返します.
照会するスプリングbean:NoSuchBeanDefinitionException異常がない場合

2-2. タイプクエリーのみ使用

タイプを使用してクエリーを行う場合は、スプリングコンテナに登録されているメソッドの戻りタイプと一致する必要はありません.実際のメソッドのreturnオブジェクトに対応するインスタンスタイプもクエリーできます.

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

    System.out.println("memberService = " + memberService);
    System.out.println("memberService.getClass() = " + memberService.getClass());

    assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
}

以下の具体的なgetBean()タイプをメソッドに入れてクエリーできますが、推奨される方法ではありません.クライアント・オブジェクトはロールに依存するロールと実装を区別することが望ましい.これはテストコードでも有効です.実装タイプに依存すると、拡張性が低下し、メンテナンスコストが増加します.

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

    System.out.println("memberService = " + memberService);
    System.out.println("memberService.getClass() = " + memberService.getClass());

    assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
}

3.同じタイプのオブジェクトがある場合のクエリー方法

クエリー・タイプが同じbeanの場合、次のNoUniqueBeanDefinitionExceptionの例外が発生します.

クエリタイプが同じbeanの場合、基本的にbeanの名前で区別できます.JavaコードでSpringbeanを登録すると、メソッド名がbeanの名前になります.beanの名前は@Bean(name ="이름")で個別に指定できます.

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

@Configuration
// class 내에 class를 만드는 경우는 scope을 상위 class로 한정한다는 것을 의미한다.
static class SameBeanConfig {

    @Bean
    // MemoryMemberRepository를 반환하는 메서드
    public MemberRepository memberRepository1() {
        return new MemoryMemberRepository();
    }

    @Bean
    // 똑같은 반환 타입(MemoryMemberRepository)을 가진 메서드를 하나 더 만든다.
    public MemberRepository memberRepository2() {
        return new MemoryMemberRepository();
    }
}

同じタイプの2つ以上のbeanオブジェクトをクエリーする場合は、getBeansOfType()を使用します.getBeansOfType()は、Mapを使用して対応するbeanオブジェクトを返す.Mapのkeyはbeanの名前を使用し,valueはオブジェクトの参照(アドレス)を含む.

@Test
@DisplayName("특정 반환 타입 Bean 모두 조회하기")
void findAllBeanByType() {
    Map<String, MemberRepository> beansOfType = ac.getBeansOfType(MemberRepository.class);
    for (String key : beansOfType.keySet()) { // keySet(): map의 모든 키 값을 가져온다
        System.out.println("key = " + key + "/ value = " + beansOfType.get(key));
    }
    System.out.println("beansOfType = " + beansOfType);
    assertThat(beansOfType.size()).isEqualTo(2);
}

getBeansOfType():同じ戻りタイプのbeanをMapオブジェクトとして得ることができる.

4.継承関係を使用してbeanをクエリーする

beanをクエリーするときに親タイプを指定すると、サブタイプに対応するbeanオブジェクトが同時にクエリーされます.したがって、すべてのjavaオブジェクトの最上位の親としてオブジェクトタイプでクエリーすると、すべてのスプリングシートをクエリーできます.ただし、同じように、返されるオブジェクトが2つ以上ある場合は、getBeansOfType()を使用する必要があります.getBean()が使用される場合、NoUniqueBeanDefinitionExceptionが生成される.

クエリに重複するタイプのbeanと同様に、複数のサブオブジェクトがある場合はbean名で区別できます.複数のオブジェクトが必要な場合は、getBean()ではなくgetBeansOfType()を使用します.

4-1. オブジェクトを名前で区切ってクエリーする

@Test
@DisplayName("부모 타입으로 조회 시, 자식이 둘 이상 있으면 Bean 이름을 지정한다")
void findBeanByParentTypeBeanName() {
    DiscountPolicy rateDiscountPolicy = ac.getBean("rateDiscountPolicy", DiscountPolicy.class);
    // ac.getBean()의 반환 타입은 부모이지만, 특정 이름을 사용하여 RateDiscountPolicy를 받을 수 있다.
    assertThat(rateDiscountPolicy).isInstanceOf(RateDiscountPolicy.class); // 인스턴스 타입 증명
}

ac.getBean("rateDiscountPolicy", DiscountPolicy.class):ポリシーDiscountPolicyは名前、DiscountPolicyです.classは戻りタイプになります.isInstanceOf():インスタンスのタイプを検証できます.

4-1. Mapを使用して同じ親タイプのbeanオブジェクトを検索

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

オブジェクトはすべてのオブジェクトの親タイプであるため、タイプクエリに使用する場合、beanに登録されているすべてのオブジェクトをMapとして受信できます.

@Test
@DisplayName(" Object 타입으로 모두 조회하기")
void findAllBeansByObjectType() {
    Map<String, Object> beansOfType = ac.getBeansOfType(Object.class);
    // Object는 모든 자바 객체의 부모 클래스이므로, 스프링 내부에서 사용하는 Bean까지 모두 담긴다.

    for (String key : beansOfType.keySet()) {
        System.out.println("key = " + key + " / value = " + beansOfType.get(key));
    }
}