自定义注解扫描

扫描自定义注解有多种方式，这里通过实现ImportBeanDefinitionRegistrar类来进行自定义注解的扫描，并将其注入IOC容器中。ImportBeanDefinitionRegistrar类本身只能通过@Import方式进行注入，所以先来实现一个注解方便使用，类似@Enablexxx。

/**
 * 扫描指定包下的client
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Import(AnnotationClientRegistrar.class)
public @interface ReactClientScan {
    String[] packages() default {};
}

 

我们将这个注解加到spring启动过程种能加载到的类上，那么就能利用@Import导入我们的目标类，使用注解看起来就比直接使用@Import更容易理解。

下面来实现配置类，扫描自定义注解分为以下3步：

1. 解析查找路径，因为已知ImportBeanDefinitionRegistrar 只能通过@Import使用，所以通过注解的参数传递package路径是比较合适。通过注解元数据，找到ReactClientScan注解，从而可以得到其packages参数。
2. 自定义一个扫描器，可以继承ClassPathBeanDefinitionScanner，来实现自定义的扫描器，ClassPathBeanDefinitionScanner 提供了filter机制简化自定义扫描器的实现。
3. 利用第二步实现的扫描器对第一步的packages进行扫描，并且会动将扫描到的类注入IOC容器中。

/**
 * 根据指定的包路径进行扫描，如果没有自定包路径，则在当前类所在路径进行扫描
 *
 * @see ReactClientScan 通过注解加载该类
 */
public class AnnotationClientRegistrar implements ImportBeanDefinitionRegistrar {
    @Override
    public void registerBeanDefinitions(
            AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        Set<String> packages = getPackages(importingClassMetadata);
        ReactClientDefinitionScanner scanner = new ReactClientDefinitionScanner(registry);
        scanner.scan(packages.toArray(new String[]{}));
    }

    private Set<String> getPackages(AnnotationMetadata metadata) {
        AnnotationAttributes attributes =
                AnnotationAttributes.fromMap(metadata.getAnnotationAttributes(ReactClientScan.class.getName()));
        String[] packages = attributes.getStringArray("packages");
        Set<String> packagesToScan = new LinkedHashSet<>(Arrays.asList(packages));
        if (packagesToScan.isEmpty()) {
            packagesToScan.add(ClassUtils.getPackageName(metadata.getClassName()));
        }
        return packagesToScan;
    }

    /**
     * 继承ClassPathBeanDefinitionScanner，添加filter实现对ReactClient的加载
     */
    private static class ReactClientDefinitionScanner extends ClassPathBeanDefinitionScanner {

        public ReactClientDefinitionScanner(BeanDefinitionRegistry registry) {
            super(registry);
            // 利用filter查找目标类，ReactClient.class是用来标记目标类的注解
            addIncludeFilter(new AnnotationTypeFilter(ReactClient.class));
        }
    }
}