g7r / reflections

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

##Java runtime metadata analysis, in the spirit of Scannotations

Reflections scans your classpath, indexes the metadata, allows you to query it on runtime and may save and collect that information for many modules within your project.

Using Reflections you can query your metadata such as:

  • get all subtypes of some type
  • get all types/members annotated with some annotation, optionally with annotation parameters matching
  • get all resources matching a regular expression
  • get all methods with specific signature including parameters, parameter annotations and return type

Build Status

###Intro Add Reflections to your project. for maven projects just add this dependency:


A typical use of Reflections would be:

Reflections reflections = new Reflections("my.project");

Set<Class<? extends SomeType>> subTypes = reflections.getSubTypesOf(SomeType.class);

Set<Class<?>> annotated = reflections.getTypesAnnotatedWith(SomeAnnotation.class);

###Usage Basically, to use Reflections first instantiate it with urls and scanners

//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()
     .setScanners(new SubTypesScanner(), 
                  new TypeAnnotationsScanner().filterResultsBy(optionalFilter), ...),
     .filterInputsBy(new FilterBuilder().includePackage("my.project.prefix"))

Then use the convenient query methods: (depending on the scanners configured)

Set<Class<? extends Module>> modules = 
Set<Class<?>> singletons = 
Set<String> properties = 
Set<Method> resources =
Set<Constructor> injectables = 
Set<Field> ids = 
Set<Method> someMethods =
    reflections.getMethodsMatchParams(long.class, int.class);
Set<Method> voidMethods =
Set<Method> pathParamMethods =
List<String> parameterNames = 
Set<Member> usages = 
  • If no scanners are configured, the default will be used - SubTypesScanner and TypeAnnotationsScanner.
  • Classloader can also be configured, which will be used for resolving runtime classes from names.
  • Make sure to scan all the transitive relevant urls (your packages and relevant 3rd party).

Browse the javadoc for more info. Also, browse the tests directory to see some more examples.

###ReflectionUtils ReflectionsUtils contains some convenient Java reflection helper methods for getting types/constructors/methods/fields/annotations matching some predicates, generally in the form of *getAllXXX(type, withYYY)

for example:

import static org.reflections.ReflectionUtils.*;

Set<Method> getters = getAllMethods(someClass,
  withModifier(Modifier.PUBLIC), withPrefix("get"), withParametersCount(0));

Set<Method> listMethodsFromCollectionToBoolean = 
    withParametersAssignableTo(Collection.class), withReturnType(boolean.class));

Set<Fields> fields = getAllFields(SomeClass.class, withAnnotation(annotation), withTypeAssignableTo(type));

See more in the ReflectionUtils javadoc

###ClasspathHelper ClasspathHelper contains some convenient methods to get urls for package, for class, for classloader and so.

See more in the ClasspathHelper javadoc

###Integrating into your build lifecycle Although scanning can be easily done on bootstrap time of your application - and shouldn't take long, it is sometime a good idea to integrate Reflections into your build lifecyle. With simple Maven/Gradle/SBT/whatever configuration you can save all scanned metadata into xml/json files just after compile time. Later on, when your project is bootstrapping you can let Reflections collect all those resources and re-create that metadata for you, making it available at runtime without re-scanning the classpath - thus reducing the bootstrapping time.

For Maven, see example using gmavenplus in the reflections-maven repository

###Other use cases Reflections can also:

  • scan urls in parallel
  • serialize scanned metadata to xml/json
  • collect saved metadata on bootstrap time for fastest load time without scanning
  • save your model entities metadata as .java file, so you can reference types/fields/methods/annotation in a static manner
  • initial Spring component scan

See the UseCases wiki page

###Contribute Pull requests are welcomed!!

The license is WTFPL, just do what the fuck you want to. This library is given as an act of giving and generosity, Dāna Donate


ezoic increase your site revenue


License:Do What The F*ck You Want To Public License


Language:Java 100.0%