Reflections一个强大的类扫描工具介绍

目录

一、Reflections能够做什么

二、如何使用

2.1、 在maven项目中添加如下依赖

2.2、使用示例

2.2.1、实例化

2.2.2、根据父类获取所有子类

2.2.3、根据接口获取所有实现类

2.2.4、根据注解获取所有类

2.2.5、根据注解获取所有方法

2.2.6、根据方法返回类型获取所有方法

2.2.7、根据方法签名获取所有方法

2.2.8、根据表达式获取所有资源文件

三、项目中使用

---

一、Reflections能够做什么

反射扫描和索引项目的类路径元数据，允许在运行时对类型系统进行反向传递查询。

使用反射，您可以查询元数据，例如：

1. 获取某种类型的所有子类型

2. 获取所有类型/构造函数/方法/字段，并使用一些注释进行注释，可选地使用匹配的注释参数

3. 获取匹配正则表达式的所有资源

4. 获取具有特定签名的所有方法，包括参数、参数注释和返回类型

5. 获取所有方法参数名称

6. 获取代码中的所有字段/方法/构造函数用法

二、如何使用

2.1、 在maven项目中添加如下依赖

<dependency>
    <groupId>org.reflections</groupId>
    <artifactId>reflections</artifactId>
    <version>0.10.2</version>
</dependency>

2.2、使用示例

2.2.1、实例化

//指定包路径，默认支持Scanners.TypesAnnotated, Scanners.SubTypes 两种扫描类型
 Reflections reflections = new Reflections("com.dora.distribution");

//指定包路径和扫描类型
  Reflections reflections = new Reflections("com.koala.distribution", Scanners.MethodsAnnotated);

//使用Configuration实例化
 Reflections reflections = new Reflections(ConfigurationBuilder.build().forPackage("com.dora.distribution").setScanners(Scanners.values()));

2.2.2、根据父类获取所有子类

 Reflections reflections = new Reflections("com.dora.distribution");
        //根据父类型查询所有子类型
        Set<Class<? extends ApplicationEvent>> bySuperClass = reflections.getSubTypesOf(ApplicationEvent.class);
      

2.2.3、根据接口获取所有实现类

Reflections reflections = new Reflections("com.dora.distribution");
//根据接口查询所有实现类
Set<Class<? extends ApplicationListener>> byInterfaces = reflections.getSubTypesOf(ApplicationListener.class);

2.2.4、根据注解获取所有类

Reflections reflections = new Reflections(ConfigurationBuilder.build().forPackage("com.dora.distribution").setScanners(Scanners.values()));
//根据注解扫描
Set<Class<?>> typesAnnotatedWith = reflections.getTypesAnnotatedWith(RestController.class);

2.2.5、根据注解获取所有方法

  //指定包路径和扫描类型
Reflections reflections = new Reflections("com.dora.distribution", Scanners.MethodsAnnotated);
Set<Method> methodsAnnotatedWith = reflections.getMethodsAnnotatedWith(RequestMapping.class);

2.2.6、根据方法返回类型获取所有方法

 Reflections reflections = new Reflections("com.dora.distribution", Scanners.values());
 Set<Method> byReturnMethods = reflections.getMethodsReturn(String.class);

2.2.7、根据方法签名获取所有方法

 Reflections reflections = new Reflections("com.dora.distribution", Scanners.values());
Set<Method> methodsWithSignature = reflections.getMethodsWithSignature(LoginEvent.class);

2.2.8、根据表达式获取所有资源文件

Reflections reflections = new Reflections("com.dora.distribution", Scanners.values());
Set<String> resources = reflections.getResources(".*\\.properties");

三、项目中使用

      在Spring 项目中监听SpringEvent只需要在处理方法中增加一个注解 @EventListener 如下：

@Service
@Slf4j
public class PushNotifyService {

    @EventListener(LoginEvent.class)
    public void sendPush(LoginEvent loginEvent) {
        log.info("listener 接收到事件是：{}", loginEvent);
    }
}

在有消息触达的时候就可以使用该方法进行处理，如果我们在自己的项目中也使用类似的设计，就可以使用 Reflections来根据方法的注解来扫描所有方法