如何找到带有自定义注释@Foo的所有bean？

Question

我有这个spring配置：

@Lazy
@Configuration
public class MyAppConfig {
    @Foo @Bean
    public IFooService service1() { return new SpecialFooServiceImpl(); }
}

如何获取用Foo注释的所有bean的列表？

注意：@Foo是我定义的自定义注释。这不是一个“官方”的Spring注释。

[编辑]根据Avinash T.的建议，我编写了这个测试用例：

import static org.junit.Assert.*;
import java.lang.annotation.ElementType;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import java.lang.annotation.Retention;
import java.lang.reflect.Method;
import java.util.Map;
import org.junit.Test;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Lazy;

public class CustomAnnotationsTest {

    @Test
    public void testFindByAnnotation() throws Exception {

        AnnotationConfigApplicationContext appContext = new AnnotationConfigApplicationContext( CustomAnnotationsSpringCfg.class );

        Method m = CustomAnnotationsSpringCfg.class.getMethod( "a" );
        assertNotNull( m );
        assertNotNull( m.getAnnotation( Foo.class ) );

        BeanDefinition bdf = appContext.getBeanFactory().getBeanDefinition( "a" );
        // Is there a way to list all annotations of bdf?

        Map<String, Object> beans = appContext.getBeansWithAnnotation( Foo.class );
        assertEquals( "[a]", beans.keySet().toString() );
    }


    @Retention( RetentionPolicy.RUNTIME )
    @Target( ElementType.METHOD )
    public static @interface Foo {

    }

    public static class Named {
        private final String name;

        public Named( String name ) {
            this.name = name;
        }

        @Override
        public String toString() {
            return name;
        }
    }

    @Lazy
    @Configuration
    public static class CustomAnnotationsSpringCfg {

        @Foo @Bean public Named a() { return new Named( "a" ); }
             @Bean public Named b() { return new Named( "b" ); }
    }
}

但它失败与org.junit.比较失败：预期：




Answer 1

在几位Spring专家的帮助下，我找到了一个解决方案：BeanDefinition的源属性可以是AnnotatedTypeMetadata。这个接口有一个方法，我可以用它来获取bean方法的注释：

public List<String> getBeansWithAnnotation( Class<? extends Annotation> type, Predicate<Map<String, Object>> attributeFilter ) {

    List<String> result = Lists.newArrayList();

    ConfigurableListableBeanFactory factory = applicationContext.getBeanFactory();
    for( String name : factory.getBeanDefinitionNames() ) {
        BeanDefinition bd = factory.getBeanDefinition( name );

        if( bd.getSource() instanceof AnnotatedTypeMetadata ) {
            AnnotatedTypeMetadata metadata = (AnnotatedTypeMetadata) bd.getSource();

            Map<String, Object> attributes = metadata.getAnnotationAttributes( type.getName() );
            if( null == attributes ) {
                continue;
            }

            if( attributeFilter.apply( attributes ) ) {
                result.add( name );
            }
        }
    }
    return result;
}

带有助手类和测试用例的完整代码的gist

Answer 2

更新：Spring 5.2改变了context.getBeansAuthAnnotion（...）的行为，现在它可以正确处理通过工厂方法创建的bean。所以只需使用它。

原始答案

虽然公认的答案和Grzegorz的答案包含了在所有情况下都适用的方法，但我发现了一个更简单的方法，它在最常见的情况下同样适用。

>

用限定符对Foo进行元注释：

@Target({ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Qualifier
public @interface Foo {
}

将Foo喷洒在工厂方法上，如问题中所述：

@Foo
@Bean
public IFooService service1() {
    return new SpecialFooServiceImpl();
}

但它也适用于类型级别：

@Foo
@Component
public class EvenMoreSpecialFooServiceImpl { ... }

然后，注入所有由Foo限定的实例，无论其类型和创建方法如何：

@Autowired
@Foo
List<Object> fooBeans; 

然后，fooBeans将包含由带注释的方法（如问题所需）生成的所有实例，或由发现的带注释的类创建的所有实例。

如果需要，该列表还可以按类型过滤：

@Autowired
@Foo
List<SpecialFooServiceImpl> fooBeans;

好的方面是它不会干扰方法上的任何其他@Qualifier（meta）注释，也不会干扰类型级别上的@Component和其他注释。它也不会在目标bean上强制执行任何特定的名称或类型。

Answer 3

使用getBeansWithAnnotation（）方法获取带有注释的bean。

Map<String,Object> beans = applicationContext.getBeansWithAnnotation(Foo.class);

下面是类似的讨论。