ClassGraph：高效、强大的JVM类路径扫描工具

戴艺音

于 2024-04-24 09:39:17 发布

阅读量401

点赞数 5

本文链接：https://blog.csdn.net/gitblog_00074/article/details/138147044

版权

ClassGraph：高效、强大的JVM类路径扫描工具

classgraph An uber-fast parallelized Java classpath scanner and module scanner. 项目地址: https://gitcode.com/gh_mirrors/cl/classgraph

项目介绍

ClassGraph 是一款超快、并行化的类路径扫描器和模块扫描器，专为Java、Scala、Kotlin等JVM语言设计。它不仅赢得了2018年Oracle Code One的Duke's Choice Award（Java生态系统中最有用或最具创新性的软件），还在2022年获得了Google Open Source Peer Bonus奖项。ClassGraph的稳定性和成熟度使其在数百个项目中得到了广泛应用，且拥有较低的错误报告率。

项目技术分析

核心功能

反向反射：ClassGraph能够“反转”Java的类和反射API，例如，找到所有继承自某个类的子类，或所有实现某个接口的类。
资源扫描：能够查找并加载所有符合特定路径模式的资源文件。
元编程：通过构建类、接口、方法和字段的内存模型，实现对代码属性的分析和响应。
兼容性：完全兼容JDK 7、8、9+（包括JPMS），并支持传统的类路径和模块路径扫描。
性能优化：采用多线程优化扫描速度，尽可能接近I/O带宽限制。

技术优势

直接读取字节码：无需加载或初始化类即可读取所有类信息。
广泛的类路径机制支持：支持多种类路径规范机制，确保代码的最大可移植性。
运行时与构建时扫描：既可以在运行时扫描，也可以在构建时扫描（如Android的注解处理）。
重复类检测：能够发现类路径或模块路径中的重复类定义，帮助解决类解析问题。

项目及技术应用场景

应用场景

依赖注入框架：用于扫描并加载所有带有特定注解的类。
配置文件管理：查找并加载所有符合特定路径模式的配置文件。
代码分析工具：构建代码的类图模型，用于代码理解和分析。
模块化系统：在JDK 9+的模块系统中，扫描模块路径中的类和资源。

示例代码

以下代码展示了如何查找并打印所有带有特定注解的类及其注解参数值：

String pkg = "com.xyz";
String routeAnnotation = pkg + ".Route";
try (ScanResult scanResult =
        new ClassGraph()
            .verbose()               // 记录到标准错误
            .enableAllInfo()         // 扫描类、方法、字段、注解
            .acceptPackages(pkg)     // 扫描com.xyz及其子包（省略则扫描所有包）
            .scan()) {               // 开始扫描
    for (ClassInfo routeClassInfo : scanResult.getClassesWithAnnotation(routeAnnotation)) {
        AnnotationInfo routeAnnotationInfo = routeClassInfo.getAnnotationInfo(routeAnnotation);
        List<AnnotationParameterValue> routeParamVals = routeAnnotationInfo.getParameterValues();
        // @com.xyz.Route有一个必需参数
        String route = (String) routeParamVals.get(0).getValue();
        System.out.println(routeClassInfo.getName() + " 带有路由注解 " + route);
    }
}