spring 扫描自定义注解

spring 扫描自定义注解

在实现自定义RPC的时候，需要扫描自定义注解，那 在 spring 环境下是如何做到的呢，这里有一个模板

定义注解

CrtScan 扫描自定义包

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Import(CrtScanMetricsBeanDefinitionRegistrar.class)
public @interface CrtScan {
    String[] basePackages();
}

@CrtService 自定义 service 注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface CrtService {
    String group() default "";
}

@CrtServiceRef - service 引用注解

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface CrtServiceRef {
    String value() default "";
}

扫描自定义注解

使用

//定义服务
public interface HelloService {

    String sayHi(String name);
}

@CrtService(group = "test")
public class HelloServiceImpl implements HelloService {

    @Override
    public String sayHi(String name) {
        return "echo: " + name;
    }
}

//引用 service
@Service
public class UserService {

    @CrtServiceRef
    private HelloService helloService;

}

//启动类
@CrtScan(basePackages = "org.example")
public class App {
    public static void main(String[] args) throws IOException {

        ApplicationContext act = new AnnotationConfigApplicationContext(App.class);
        System.in.read();
    }
}

结果:

CrtScanMetricsBeanDefinitionRegistrar - CrtService scan total: 3
CrtServiceBeanProcessor - 扫描到 service: class org.example.server.api.HelloServiceImpl
CrtServiceBeanProcessor - 扫描到 属性: class org.example.server.service.UserService - helloService

实现

CrtClasspathBeanDefinitionScanner 自定义注解扫描Scanner

public class CrtClasspathBeanDefinitionScanner extends ClassPathBeanDefinitionScanner {

    public CrtClasspathBeanDefinitionScanner(BeanDefinitionRegistry registry, Class<? extends Annotation> annotationType) {
        super(registry);
        super.addIncludeFilter(new AnnotationTypeFilter(annotationType));
    }
}

CrtScanMetricsBeanDefinitionRegistrar

扫描自定义注解

@Slf4j
public class CrtScanMetricsBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar, ResourceLoaderAware {

    private static final String BASE_PKG = "basePackages";

    private ResourceLoader resourceLoader;

    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry, BeanNameGenerator importBeanNameGenerator) {
        ImportBeanDefinitionRegistrar.super.registerBeanDefinitions(importingClassMetadata, registry, importBeanNameGenerator);
    }

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

        AnnotationAttributes crtScanAttribute = AnnotationAttributes.fromMap(importingClassMetadata.getAnnotationAttributes(CrtScan.class.getName()));
        String[] basePackages = crtScanAttribute.getStringArray(BASE_PKG);
        CrtClasspathBeanDefinitionScanner scanner = new CrtClasspathBeanDefinitionScanner(registry, CrtService.class);
        scanner.setResourceLoader(resourceLoader);
        int scan = scanner.scan(basePackages);
        log.info("CrtService scan total: {}", scan);
    }

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

CrtServiceBeanProcessor

• postProcessBeforeInitialization: 处理服务，同时暴露服务
• postProcessAfterInitialization： 处理服务引用，生成代理对象

good luck!