Spring类路径组件扫描

Question

我需要为类构建映射（字面上是映射）

@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Mapping {
     String value();
}

和：

public class MappingLookUp {
    private static final Map<Class<?>, String> MAPPING_LOOK_UP;
    static {
        Map<Class<?>, String> lookUp = new HashMap<>();
        ClassPathScanningCandidateComponentProvider scanningCandidateComponentProvider = new ClassPathScanningCandidateComponentProvider(false);
        scanningCandidateComponentProvider.addIncludeFilter(new AnnotationTypeFilter(Mapping.class));
        for (BeanDefinition beanDefinition : scanningCandidateComponentProvider.findCandidateComponents("blah")) {
            Class<?> clazz;
            try {
                clazz = Class.forName(beanDefinition.getBeanClassName());
            } catch (ClassNotFoundException e) {
                throw new RuntimeException(e);
            }
            Mapping mapping = AnnotationUtils.getAnnotation(clazz, Mapping.class);
            if (mapping == null) {
                throw new IllegalStateException("This should never be null");
            }
            lookUp.put(clazz, mapping.value());
        }
        MAPPING_LOOK_UP = Collections.unmodifiableMap(lookUp);
    }

    public static String getMapping(Class<?> clazz) {
        ...
    }
}

虽然我相信这会起作用，但这感觉就像：

1. 静态初始化需要投入大量精力。
2. 对扫描组件提供商的恶意使用，尽管通常推荐用于此目的BeanDefinition使它听起来像是用于查找Spring Bean，而不是一般的类定义

需要明确的是，带注释的值是数据类 - 而不是Spring管理的bean - 所以BeanPostProcessor模式不适合，事实上，这就是为什么使用扫描组件提供程序感觉很尴尬的原因，对我来说，它似乎是为了发现Spring管理的Bean。

这是实现这种模式的正确方式吗？是提供商的正当应用吗？在不引入其他类路径扫描实现的情况下，有没有可行的替代方案？




Answer 1

最近我问了一个非常类似的问题：如何从@ComponentScan包中获取接口列表，并最终实现了建议的第一种方法。

你可以看到代码https://github.com/StanislavLapitsky/SpringSOAProxy看到https://github.com/StanislavLapitsky/SpringSOAProxy/blob/master/core/src/main/java/org/proxysoa/spring/service/ProxyableScanRegistrar.java当然还有初始化注释https://github.com/StanislavLapitsky/SpringSOAProxy/blob/master/core/src/main/java/org/proxysoa/spring/annotation/ProxyableScan.java关键是添加@导入（{ProxyableScanRegistrar.class}）

关键代码是

public class ProxyableScanRegistrar implements ImportBeanDefinitionRegistrar, EnvironmentAware {
    private Environment environment;

    @Override
    public void setEnvironment(Environment environment) {
        this.environment = environment;
    }

    @Override
    public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
        // Get the ProxyableScan annotation attributes
        Map<String, Object> annotationAttributes = metadata.getAnnotationAttributes(ProxyableScan.class.getCanonicalName());

        if (annotationAttributes != null) {
            String[] basePackages = (String[]) annotationAttributes.get("value");

            if (basePackages.length == 0) {
                // If value attribute is not set, fallback to the package of the annotated class
                basePackages = new String[]{((StandardAnnotationMetadata) metadata).getIntrospectedClass().getPackage().getName()};
            }

Answer 2

我建议这看起来不像是以一种非常Spring的方式完成的。

如果我要这样做，我会使用Spring的BeanPostProcessor或BeanFactoryPostProcessor。这两者都允许对Spring的BeanFactory中的所有Bean进行自省，并允许您摆脱当前设置的静态性，因为后处理器就是Spring Bean本身。

class MappingLookup implements BeanPostProcessor {
  private final Map<Class<?>, String> lookup = new HashMap<>();

  @Override
  public Object postProcessAfterInitialization(Object bean, String beanName) {
    // check bean's class for annotation...
    // add to lookup map as necessary...
    // make sure to return bean (javadoc explains why)
    return bean;
  }

  public String getMapping(Class<?> clazz) {
    // ...
  }

  // omitted other methods...
}