Quét các chú thích Java khi chạy [đã đóng]

Cách tốt nhất để tìm kiếm toàn bộ đường dẫn cho một lớp chú thích là gì?

Tôi đang làm một thư viện và tôi muốn cho phép người dùng chú thích các lớp của họ, vì vậy khi ứng dụng Web khởi động, tôi cần quét toàn bộ đường dẫn để tìm chú thích nhất định.

Bạn có biết một thư viện hoặc một cơ sở Java để làm điều này không?

Chỉnh sửa: Tôi đang suy nghĩ về một cái gì đó giống như chức năng mới cho Dịch vụ web Java EE 5 hoặc EJB. Bạn chú thích lớp của bạn với @WebServicehoặc @EJBvà hệ thống tìm thấy các lớp này trong khi tải để chúng có thể truy cập từ xa.

Sử dụng org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider

API

Một nhà cung cấp thành phần quét đường dẫn lớp từ gói cơ sở. Sau đó, nó áp dụng loại trừ và bao gồm các bộ lọc cho các lớp kết quả để tìm ứng viên.

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());

Và một giải pháp khác là phản ánh của Google .

Đánh giá nhanh:

• Giải pháp mùa xuân là cách tốt nhất nếu bạn đang sử dụng Spring. Nếu không, nó là một sự phụ thuộc lớn.
• Sử dụng ASM trực tiếp là một chút rườm rà.
• Sử dụng Java Assistant trực tiếp cũng rất khó hiểu.
• Thông báo là siêu nhẹ và thuận tiện. Không có tích hợp maven nào.
• Google phản ánh kéo trong bộ sưu tập của Google. Lập chỉ mục mọi thứ và sau đó là siêu nhanh.

Bạn có thể tìm thấy các lớp với bất kỳ chú thích cụ thể nào với ClassGraph , cũng như tìm kiếm các tiêu chí quan tâm khác, ví dụ các lớp thực hiện giao diện đã cho. (Tuyên bố miễn trừ trách nhiệm, tôi là tác giả của ClassGraph.) ClassGraph có thể xây dựng một biểu diễn trừu tượng của toàn bộ biểu đồ lớp (tất cả các lớp, chú thích, phương thức, tham số phương thức và trường) trong bộ nhớ, cho tất cả các lớp trên đường dẫn lớp hoặc cho các lớp trong các gói trong danh sách trắng và bạn có thể truy vấn biểu đồ lớp đó theo cách bạn muốn. ClassGraph hỗ trợ nhiều cơ chế đặc tả và trình tải lớp hơn bất kỳ trình quét nào khác và cũng hoạt động trơn tru với hệ thống mô-đun JPMS mới, vì vậy nếu bạn dựa vào mã của mình trên ClassGraph, mã của bạn sẽ có khả năng di động tối đa. Xem API tại đây.

Nếu bạn muốn có trọng lượng thực sự nhẹ (không phụ thuộc, API đơn giản, tệp jar 15 kb) và giải pháp rất nhanh , hãy xem annotation-detectortại https://github.com/rmuller/infomas-asl

Tuyên bố miễn trừ trách nhiệm: Tôi là tác giả.

Bạn có thể sử dụng API xử lý chú thích có thể cắm Java để viết bộ xử lý chú thích sẽ được thực thi trong quá trình biên dịch và sẽ thu thập tất cả các lớp chú thích và xây dựng tệp chỉ mục để sử dụng thời gian chạy.

Đây là cách nhanh nhất có thể để thực hiện khám phá lớp có chú thích vì bạn không cần quét đường dẫn lớp của mình khi chạy, thường hoạt động rất chậm. Ngoài ra, cách tiếp cận này hoạt động với bất kỳ trình nạp lớp nào và không chỉ với URLClassLoaders thường được hỗ trợ bởi các trình quét thời gian chạy.

Cơ chế trên đã được triển khai trong thư viện Class Index .

Để sử dụng nó chú thích chú thích tùy chỉnh của bạn với chú thích meta @ IndexAnnotated . Điều này sẽ tạo tại thời điểm biên dịch một tệp chỉ mục: META-INF / annotations / com / test / YourCustomAnnotation liệt kê tất cả các lớp chú thích. Bạn có thể xử lý chỉ mục trong thời gian chạy bằng cách thực hiện:

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

Có quá muộn để trả lời. Tôi có thể nói, tốt hơn là đi bằng các Thư viện như ClassPathScanningCandidateComponentProvider hoặc thích Scannotations

Nhưng ngay cả sau khi ai đó muốn thử một số thao tác với classLoader, tôi đã tự mình viết một số để in các chú thích từ các lớp trong một gói:

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;

}
}

Và trong tập tin cấu hình, bạn đặt tên gói và sắp xếp nó vào một lớp.

Với Spring, bạn cũng có thể viết những điều sau bằng lớp AnnotationUtils. I E:

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

Để biết thêm chi tiết và tất cả các phương pháp khác nhau, hãy kiểm tra tài liệu chính thức: https://docs.spring.io/spring/docs/civerse/javadoc-api/org/springframework/core/annotation/AnnotationUtils.html

Có một nhận xét tuyệt vời của zapp chìm trong tất cả những câu trả lời:

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

API Classloader không có phương thức "liệt kê", bởi vì tải lớp là một hoạt động "theo yêu cầu" - bạn thường có hàng ngàn lớp trong đường dẫn lớp của mình, chỉ cần một phần trong số đó (rt.jar một mình là 48MB ngày nay!).

Vì vậy, ngay cả khi bạn có thể liệt kê tất cả các lớp, điều này sẽ rất tốn thời gian và bộ nhớ.

Cách tiếp cận đơn giản là liệt kê các lớp liên quan trong tệp thiết lập (xml hoặc bất cứ thứ gì phù hợp với sở thích của bạn); nếu bạn muốn làm điều này tự động, hãy giới hạn bản thân trong một thư mục JAR hoặc một lớp.

Google Reflection nếu bạn muốn khám phá giao diện là tốt.

Mùa xuân ClassPathScanningCandidateComponentProviderkhông khám phá giao diện.

Google Reflecting dường như nhanh hơn nhiều so với Spring. Tìm thấy tính năng này yêu cầu nhấn mạnh sự khác biệt này: http://www.opensaga.org/jira/browse/OS-738

Đây là một lý do để sử dụng Reflection vì thời gian khởi động ứng dụng của tôi thực sự quan trọng trong quá trình phát triển. Phản xạ dường như cũng rất dễ sử dụng cho trường hợp sử dụng của tôi (tìm tất cả những người triển khai giao diện).

Nếu bạn đang tìm kiếm một giải pháp thay thế cho phản xạ, tôi muốn giới thiệu Panda Utility - AnnotationsScanner . Đó là máy quét không có ổi (Guava có ~ 3MB, Panda Utility có ~ 200kb) dựa trên mã nguồn của thư viện phản chiếu.

Nó cũng dành riêng cho các tìm kiếm dựa trên tương lai. Nếu bạn muốn quét nhiều lần bao gồm các nguồn hoặc thậm chí cung cấp API, cho phép ai đó quét đường dẫn hiện tại, AnnotationsScannerProcesslưu trữ tất cả các lần tìm nạp ClassFiles, vì vậy nó thực sự nhanh.

Ví dụ đơn giản về AnnotationsScannercách sử dụng:

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

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

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

Mùa xuân có một cái gì đó gọi là một AnnotatedTypeScannerlớp học.
Lớp này sử dụng nội bộ

ClassPathScanningCandidateComponentProvider

Lớp này có mã để quét thực tế các tài nguyên đường dẫn . Nó thực hiện điều này bằng cách sử dụng siêu dữ liệu lớp có sẵn trong thời gian chạy.

Người ta có thể chỉ cần mở rộng lớp này hoặc sử dụng cùng một lớp để quét. Dưới đây là định nghĩa của nhà xây dựng.

/**
     * 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;
    }