java 非常好用的反射框架Reflections

背景

最近在设计和开发部门的基础架构，需要利用反射技术找到classpath目录下所有包含指定注解的类，然后根据注解配置完成指定的功能。
最初是想自己写代码来实现这些功能，边查资料边写，整了大半天，写出来的效果自己都不太满意。一方面是代码多，不好维护；另一方面是性能不太好。不过，在查资料的过程中，我发现了一个非常好用的反射框架：reflections。
reflections简单好用，性能也不错，很快就完成了我想要的功能，就是这么优秀！

简介

Reflections通过扫描classpath，索引元数据，并且允许在运行时查询这些元数据。

使用Reflections可以很轻松的获取以下元数据信息：

• 获取某个类型的全部子类
• 只要类型、构造器、方法，字段上带有特定注解，便能获取带有这个注解的全部信息（类型、构造器、方法，字段）
• 获取所有能匹配某个正则表达式的资源
• 获取所有带有特定签名的方法，包括参数，参数注解，返回类型
• 获取所有方法的名字
• 获取代码里所有字段、方法名、构造器的使用

Maven依赖

在pom.xml中添加reflections的依赖：

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

 

// 实例化Reflections，并指定要扫描的包名
Reflections reflections = new Reflections("my.project");
// 获取某个类的所有子类
Set<Class<? extends SomeType>> subTypes = reflections.getSubTypesOf(SomeType.class);
// 获取包含某个注解的所有类
Set<Class<?>> annotated = reflections.getTypesAnnotatedWith(SomeAnnotation.class);

 

 

 

使用

//scan urls that contain 'my.package', include inputs starting with 'my.package', use the default scanners
Reflections reflections = new Reflections("my.package");

//or using ConfigurationBuilder
new Reflections(new ConfigurationBuilder()
     .setUrls(ClasspathHelper.forPackage("my.project.prefix"))
     .setScanners(new SubTypesScanner(), 
                  new TypeAnnotationsScanner().filterResultsBy(optionalFilter), ...),
     .filterInputsBy(new FilterBuilder().includePackage("my.project.prefix"))
     ...);

 

扫描子类

Set<Class<? extends Module>> modules = 
    reflections.getSubTypesOf(com.google.inject.Module.class);

 

扫描注解

//TypeAnnotationsScanner 
Set<Class<?>> singletons = 
    reflections.getTypesAnnotatedWith(javax.inject.Singleton.class);

 

扫描资源

//ResourcesScanner
Set<String> properties = 
    reflections.getResources(Pattern.compile(".*\\.properties"));

 

扫描方法注解

//MethodAnnotationsScanner
Set<Method> resources =
    reflections.getMethodsAnnotatedWith(javax.ws.rs.Path.class);
Set<Constructor> injectables = 
    reflections.getConstructorsAnnotatedWith(javax.inject.Inject.class);

 

扫描字段注解

//FieldAnnotationsScanner
Set<Field> ids = 
    reflections.getFieldsAnnotatedWith(javax.persistence.Id.class);

 

扫描方法参数

//MethodParameterScanner
Set<Method> someMethods =
    reflections.getMethodsMatchParams(long.class, int.class);
Set<Method> voidMethods =
    reflections.getMethodsReturn(void.class);
Set<Method> pathParamMethods =
    reflections.getMethodsWithAnyParamAnnotated(PathParam.class);

 

扫描方法参数名

//MethodParameterNamesScanner
List<String> parameterNames = 
    reflections.getMethodParamNames(Method.class)

 

扫描方法调用情况

//MemberUsageScanner
Set<Member> usages = 
    reflections.getMethodUsages(Method.class)

 

参考资料

https://github.com/ronmamo/reflections

//TypeAnnotationsScanner 
Set<Class<?>> singletons = 
    reflections.getTypesAnnotatedWith(javax.inject.Singleton.class);