Spring Boot自定义注解扫描器

之前在整合Spring Boot和tkMybatis的时候使用了这个注解：

这个还挺实用的，会将指定包下的相应的类加载至Spring容器中，刚好我这边也有一个独立抽取出来的权限模块也想实现这样的功能（当然可以使用@EnableXX的方式，但是注入的组件太多了，直接包扫描直接点），而不是使用@ComponentScan或者是scanBasePackages必须指定某个包，这样显得太low了，使用注解自动扫描多好。

先来看看@MapperScan是怎么实现的：

没有什么特别的，引入了MapperScannerRegistrar：

中间有很多其他的代码都不用管，直接看最关键的：

定义了一个Mapper的Scanner：

然后调用doScan()方法即可：

而doScan()方法实际上就是Spring的核心扫描器ClassPathBeanDefinitionScanner的方法，而tkMybatis中定义了一个ClassPathMapperScanner继承了ClassPathBeanDefinitionScanne重写了doScan()方法，我们就可以照葫芦画瓢了。

自定义注解

自定义Registrar

import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.context.EnvironmentAware;
import org.springframework.context.ResourceLoaderAware;
import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
import org.springframework.core.annotation.AnnotationAttributes;
import org.springframework.core.env.Environment;
import org.springframework.core.io.ResourceLoader;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.util.StringUtils;

import java.util.ArrayList;
import java.util.List;

/**
 * @author Dongguabai
 * @date 2018/8/15 13:36
 */
@Slf4j
public class DgbSecurityScannerRegistrar implements ImportBeanDefinitionRegistrar, ResourceLoaderAware, EnvironmentAware {

    private ResourceLoader resourceLoader;

    private Environment environment;

    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {

        AnnotationAttributes annoAttrs = AnnotationAttributes.fromMap(importingClassMetadata.getAnnotationAttributes(DgbSecurityScan.class.getName()));
        ClassPathDgbSecurityScanner scanner = new ClassPathDgbSecurityScanner(registry);
        // this check is needed in Spring 3.1
        if (resourceLoader != null) {
            scanner.setResourceLoader(resourceLoader);
        }

        List<String> basePackages = new ArrayList<String>();
        for (String pkg : annoAttrs.getStringArray("basePackages")) {
            if (StringUtils.hasText(pkg)) {
                basePackages.add(pkg);
            }
        }
        scanner.doScan(StringUtils.toStringArray(basePackages));
    }

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

    @Override
    public void setResourceLoader(ResourceLoader resourceLoader) {
        this.resourceLoader = resourceLoader;
    }
}

自定义Scanner

import org.springframework.beans.factory.config.BeanDefinitionHolder;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.context.annotation.ClassPathBeanDefinitionScanner;
import org.springframework.core.env.Environment;
import org.springframework.core.io.ResourceLoader;
import org.springframework.lang.Nullable;

import java.util.Arrays;
import java.util.Set;

/**
 * @author Dongguabai
 * @date 2018/8/15 13:40
 */
public class ClassPathDgbSecurityScanner extends ClassPathBeanDefinitionScanner {


    public ClassPathDgbSecurityScanner(BeanDefinitionRegistry registry) {
        super(registry);
    }

    public ClassPathDgbSecurityScanner(BeanDefinitionRegistry registry, boolean useDefaultFilters) {
        super(registry, useDefaultFilters);
    }

    public ClassPathDgbSecurityScanner(BeanDefinitionRegistry registry, boolean useDefaultFilters, Environment environment) {
        super(registry, useDefaultFilters, environment);
    }

    public ClassPathDgbSecurityScanner(BeanDefinitionRegistry registry, boolean useDefaultFilters, Environment environment, @Nullable ResourceLoader resourceLoader) {
        super(registry, useDefaultFilters, environment, resourceLoader);
    }

    /**
     * Calls the parent search that will search and register all the candidates.
     * Then the registered objects are post processed to set them as
     * MapperFactoryBeans
     */
    @Override
    public Set<BeanDefinitionHolder> doScan(String... basePackages) {
        Set<BeanDefinitionHolder> beanDefinitions = super.doScan(basePackages);

        if (beanDefinitions.isEmpty()) {
            logger.warn("No DgbSecurity Spring Componet was found in '" + Arrays.toString(basePackages) + "' package. Please check your configuration.");
        }

        return beanDefinitions;
    }
}

最后将注解放到Spring Boot启动类上即可。

因为是临时突然想到这个，代码应该有不少可以优化的地方，以后再看吧。

========================================================================================

使用这个方式用在基于Spring Security的权限模块是可以的，但是用在基于Quartz的调度模块一直出问题，经过debug发现是可以扫描成功并且是可以注册的，但是启动过程中执行调度任务的时候一直出问题，异常显示为create Bean找不到那个Bean，一直无法理解。但是在别的模块是可以正常使用的。