如何用ClassGraph识别含Retrofit注解的Android类/接口？配置及扫描问题

一、ClassGraph支持扫描外部代码吗？ #

支持，但前提是你得手动指定外部代码的类路径——不管是Android项目编译生成的class文件目录、JAR包还是AAR包里的classes.jar，都需要通过addClasspathElement()把这些路径加入扫描范围。独立Kotlin项目默认只会扫自己的类，不会自动识别你的Android项目代码。

二、当前配置的几个错误点 #

1. 包匹配规则错了
   你用的com.example.*只能匹配com.example下的一级子包（比如com.example.api），如果有更深的子包（比如com.example.api.v2）就扫不到。要匹配所有层级的子包，得写成com.example..*（两个点）。

2. 没指定Android项目的类路径
   你的代码里没告诉ClassGraph要扫哪个外部项目的代码，它自然找不到任何类。必须添加Android项目编译后的class文件路径，比如debug模式下的/path/to/your/android/app/build/intermediates/classes/debug，或者对应的JAR/AAR文件路径。

3. 误解了enableExternalClasses()
   这个方法是允许加载类路径里的外部依赖类（比如Retrofit本身的注解），不是让它自动去扫描外部项目的代码——外部项目的代码得先通过addClasspathElement()加到类路径里才行。

4. 可能遇到Android混淆问题
   如果你的Android项目开了混淆，debug包如果也混淆的话，带Retrofit注解的接口可能被重命名或删除，导致扫描不到。建议扫未混淆的debug编译产物。

三、修正后的代码示例 #

ClassGraph()
    .verbose()
    .ignoreClassVisibility()
    .enableAllInfo()
    // 匹配com.example下所有层级的子包
    .acceptPackages("com.example..*")
    // 替换成你的Android项目debug编译class目录路径
    .addClasspathElement("/Users/xxx/AndroidProjects/MyApp/app/build/intermediates/classes/debug")
    // 只扫描带Retrofit核心注解的类/接口，提升扫描效率
    .acceptAnnotations("retrofit2.http.GET", "retrofit2.http.POST", "retrofit2.http.PUT", "retrofit2.http.DELETE")
    .scan()
    .use { result ->
        // 收集所有带Retrofit请求注解的接口
        val retrofitApiInterfaces = mutableSetOf<ClassInfo>()
        listOf("retrofit2.http.GET", "retrofit2.http.POST", "retrofit2.http.PUT", "retrofit2.http.DELETE").forEach { annName ->
            retrofitApiInterfaces.addAll(result.getClassesWithAnnotation(annName))
        }

        println("找到${retrofitApiInterfaces.size}个Retrofit接口：")
        retrofitApiInterfaces.forEach { apiCls ->
            println("接口：${apiCls.name}")
            // 打印接口里的带注解方法
            apiCls.methods.forEach { method ->
                method.annotations.forEach { ann ->
                    println("  方法：${method.name}，注解：${ann.simpleName}")
                }
            }
        }
    }

四、额外注意事项 #

• 独立Kotlin项目里要加Retrofit依赖，不然ClassGraph识别不了Retrofit的注解：

  dependencies {
      implementation "io.github.classgraph:classgraph:4.8.179"
      implementation "com.squareup.retrofit2:retrofit:2.9.0" // 和你的Android项目Retrofit版本保持一致
  }
  

• 如果扫AAR文件，要先解压AAR，找到里面的classes.jar，然后把这个JAR文件路径传给addClasspathElement()。
• 别扫整个Android SDK，会拖慢扫描速度，精准指定你的业务包路径就行。

内容的提问来源于stack exchange，提问作者Hector