Escaneo de anotaciones de Java en tiempo de ejecución [cerrado]

¿Cuál es la mejor manera de buscar en todo el classpath una clase anotada?

Estoy haciendo una biblioteca y quiero permitir que los usuarios anoten sus clases, por lo que cuando se inicia la aplicación web, necesito escanear toda la ruta de clase para obtener cierta anotación.

¿Conoces una biblioteca o una instalación de Java para hacer esto?

Editar: Estoy pensando en algo como la nueva funcionalidad para Java EE 5 Web Services o EJB's. Anota tu clase con @WebServiceo @EJBy el sistema encuentra estas clases mientras se carga para que sean accesibles de forma remota.

Utilice org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider

API

Un proveedor de componentes que escanea el classpath desde un paquete base. Luego aplica excluir e incluir filtros a las clases resultantes para encontrar candidatos.

ClassPathScanningCandidateComponentProvider scanner =
new ClassPathScanningCandidateComponentProvider(<DO_YOU_WANT_TO_USE_DEFALT_FILTER>);

scanner.addIncludeFilter(new AnnotationTypeFilter(<TYPE_YOUR_ANNOTATION_HERE>.class));

for (BeanDefinition bd : scanner.findCandidateComponents(<TYPE_YOUR_BASE_PACKAGE_HERE>))
    System.out.println(bd.getBeanClassName());

Y otra solución son las reflexiones de Google .

Revisión rápida:

• La solución Spring es el camino a seguir si está utilizando Spring. De lo contrario, es una gran dependencia.
• Usar ASM directamente es un poco engorroso.
• Usar Java Assist directamente también es torpe.
• Annovention es súper ligero y conveniente. No hay integración de Maven todavía.
• Las reflexiones de Google atraen a las colecciones de Google. Indexa todo y luego es súper rápido.

Puede encontrar clases con cualquier anotación dada con ClassGraph , así como buscar otros criterios de interés, por ejemplo, clases que implementan una interfaz determinada. (Descargo de responsabilidad, soy el autor de ClassGraph.) ClassGraph puede construir una representación abstracta de todo el gráfico de clase (todas las clases, anotaciones, métodos, parámetros de métodos y campos) en la memoria, para todas las clases en el classpath, o para las clases en paquetes en la lista blanca, y puede consultar ese gráfico de clase como desee. ClassGraph admite más mecanismos de especificación de classpath y cargadores de clases que cualquier otro escáner, y también funciona a la perfección con el nuevo sistema de módulos JPMS, por lo que si basa su código en ClassGraph, su código será máximamente portátil. Vea la API aquí.

Si desea un peso realmente ligero (sin dependencias, API simple, archivo jar de 15 kb) y una solución muy rápida , eche un vistazo annotation-detectora https://github.com/rmuller/infomas-asl

Descargo de responsabilidad: soy el autor.

Puede usar la API de procesamiento de anotación conectable de Java para escribir un procesador de anotación que se ejecutará durante el proceso de compilación y recopilará todas las clases anotadas y creará el archivo de índice para el uso en tiempo de ejecución.

Esta es la forma más rápida posible de hacer un descubrimiento de clase anotado porque no necesita escanear su classpath en tiempo de ejecución, que generalmente es una operación muy lenta. Además, este enfoque funciona con cualquier cargador de clases y no solo con URLClassLoaders, generalmente compatibles con escáneres de tiempo de ejecución.

El mecanismo anterior ya está implementado en la biblioteca ClassIndex .

Para usarlo, anote su anotación personalizada con @IndexAnotaciones anotadas . Esto creará en tiempo de compilación un archivo de índice: META-INF / annotations / com / test / YourCustomAnnotation que enumera todas las clases anotadas. Puede acceder al índice en tiempo de ejecución ejecutando:

ClassIndex.getAnnotated(com.test.YourCustomAnnotation.class)

¿Es demasiado tarde para responder? Yo diría que es mejor ir por bibliotecas como ClassPathScanningCandidateComponentProvider o como Scannotations

Pero incluso después de que alguien quiera probarlo con classLoader, he escrito algunos por mi cuenta para imprimir las anotaciones de las clases en un paquete:

public class ElementScanner {

public void scanElements(){
    try {
    //Get the package name from configuration file
    String packageName = readConfig();

    //Load the classLoader which loads this class.
    ClassLoader classLoader = getClass().getClassLoader();

    //Change the package structure to directory structure
    String packagePath  = packageName.replace('.', '/');
    URL urls = classLoader.getResource(packagePath);

    //Get all the class files in the specified URL Path.
    File folder = new File(urls.getPath());
    File[] classes = folder.listFiles();

    int size = classes.length;
    List<Class<?>> classList = new ArrayList<Class<?>>();

    for(int i=0;i<size;i++){
        int index = classes[i].getName().indexOf(".");
        String className = classes[i].getName().substring(0, index);
        String classNamePath = packageName+"."+className;
        Class<?> repoClass;
        repoClass = Class.forName(classNamePath);
        Annotation[] annotations = repoClass.getAnnotations();
        for(int j =0;j<annotations.length;j++){
            System.out.println("Annotation in class "+repoClass.getName()+ " is "+annotations[j].annotationType().getName());
        }
        classList.add(repoClass);
    }
    } catch (ClassNotFoundException e) {
        e.printStackTrace();
    }
}

/**
 * Unmarshall the configuration file
 * @return
 */
public String readConfig(){
    try{
        URL url = getClass().getClassLoader().getResource("WEB-INF/config.xml");
        JAXBContext jContext = JAXBContext.newInstance(RepositoryConfig.class);
         Unmarshaller um =  jContext.createUnmarshaller();
         RepositoryConfig rc = (RepositoryConfig) um.unmarshal(new File(url.getFile()));
         return rc.getRepository().getPackageName();
        }catch(Exception e){
            e.printStackTrace();
        }
    return null;

}
}

Y en el archivo de configuración, coloca el nombre del paquete y lo desmarca a una clase.

Con Spring también puede escribir lo siguiente usando la clase AnnotationUtils. es decir:

Class<?> clazz = AnnotationUtils.findAnnotationDeclaringClass(Target.class, null);

Para obtener más detalles y todos los métodos diferentes, consulte los documentos oficiales: https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/core/annotation/AnnotationUtils.html

Hay un comentario maravilloso de zapp que incluye todas esas respuestas:

new Reflections("my.package").getTypesAnnotatedWith(MyAnnotation.class)

La API de Classloader no tiene un método de "enumeración", porque la carga de clases es una actividad "a pedido": generalmente tiene miles de clases en su classpath, de las cuales solo se necesitará una fracción (rt.jar ¡solo 48MB hoy en día!).

Entonces, incluso si pudieras enumerar todas las clases, esto consumiría mucho tiempo y memoria.

El enfoque simple es enumerar las clases en cuestión en un archivo de configuración (xml o lo que más le convenga); Si desea hacer esto automáticamente, limítese a un JAR o un directorio de clase.

Reflexión de Google si también quieres descubrir interfaces.

Spring ClassPathScanningCandidateComponentProviderno está descubriendo interfaces.

Google Reflections parece ser mucho más rápido que Spring. Encontré esta solicitud de función que aborda esta diferencia: http://www.opensaga.org/jira/browse/OS-738

Esta es una razón para usar Reflections ya que el tiempo de inicio de mi aplicación es realmente importante durante el desarrollo. Reflexiones también parece ser muy fácil de usar para mi caso de uso (encontrar todos los implementadores de una interfaz).

Si está buscando una alternativa a las reflexiones, me gustaría recomendar Panda Utilities - AnnotationsScanner . Es un escáner libre de guayaba (guayaba tiene ~ 3 MB, Panda Utilities tiene ~ 200 kb) basado en el código fuente de la biblioteca de reflexiones.

También está dedicado a búsquedas futuras. Si desea escanear varias veces las fuentes incluidas o incluso proporcionar una API, que permite a alguien escanear la ruta de clase actual, AnnotationsScannerProcessalmacena en caché todas las recuperadas ClassFiles, por lo que es realmente rápido.

Ejemplo simple de AnnotationsScanneruso:

AnnotationsScanner scanner = AnnotationsScanner.createScanner()
        .includeSources(ExampleApplication.class)
        .build();

AnnotationsScannerProcess process = scanner.createWorker()
        .addDefaultProjectFilters("net.dzikoysk")
        .fetch();

Set<Class<?>> classes = process.createSelector()
        .selectTypesAnnotatedWith(AnnotationTest.class);

La primavera tiene algo llamado AnnotatedTypeScannerclase.
Esta clase usa internamente

ClassPathScanningCandidateComponentProvider

Esta clase tiene el código para el escaneo real de los recursos de classpath . Para ello, utiliza los metadatos de clase disponibles en tiempo de ejecución.

Simplemente se puede extender esta clase o usar la misma clase para escanear. A continuación se muestra la definición del constructor.

/**
     * Creates a new {@link AnnotatedTypeScanner} for the given annotation types.
     * 
     * @param considerInterfaces whether to consider interfaces as well.
     * @param annotationTypes the annotations to scan for.
     */
    public AnnotatedTypeScanner(boolean considerInterfaces, Class<? extends Annotation>... annotationTypes) {

        this.annotationTypess = Arrays.asList(annotationTypes);
        this.considerInterfaces = considerInterfaces;
    }