使用 ASM 在构建时检测字段上的嵌套注解（如 @NotNull）-java教程-PHP中文网

使用 ASM 在构建时检测字段上的嵌套注解（如 @NotNull）

本文介绍如何利用 Java ASM 库在编译后字节码层面，准确识别字段是否被带有 @NotNull 等元注解（meta-annotation）的自定义注解（如 @MyAnnotation）所标记，解决直接遍历失败的问题。

本文介绍如何利用 java asm 库在编译后字节码层面，准确识别字段是否被带有 `@notnull` 等元注解（meta-annotation）的自定义注解（如 `@myannotation`）所标记，解决直接遍历失败的问题。

在使用 ASM 进行构建时字节码操作时，一个常见误区是：仅检查字段上直接声明的注解（如 @MyAnnotation），却忽略了注解本身可能携带的元注解（meta-annotations） ——例如 @MyAnnotation 自身被 @NotNull 标记，这意味着该字段应具备非空语义。ASM 默认的 visitAnnotation() 回调仅暴露顶层注解描述符（descriptor），不会自动递归解析其元注解，因此原始代码中 hasNotNullAnnotation 始终为 false。

要正确检测嵌套的 @NotNull，关键在于：对每个访问到的注解，进一步监听其内部嵌套的注解声明。这需要在 visitAnnotation() 中返回一个自定义 AnnotationVisitor，并重写 visitAnnotation(String name, String descriptor) 方法——该方法专门用于处理注解类型上的注解（即元注解）。

以下是修正后的核心逻辑（Gradle compileJava.doLast 中）：

val notNullDescriptor = "Ljakarta/validation/constraints/NotNull;"

classReader.accept(object : ClassVisitor(ASM9, classWriter) {
    override fun visitField(
        access: Int,
        name: String,
        descriptor: String,
        signature: String?,
        value: Any?
    ): FieldVisitor {
        val fv = super.visitField(access, name, descriptor, signature, value)
        return object : FieldVisitor(ASM9, fv) {
            var hasNotNull = false

            override fun visitAnnotation(desc: String, visible: Boolean): AnnotationVisitor {
                // 检查当前注解是否为 @NotNull（直接标注）
                if (desc == notNullDescriptor) {
                    hasNotNull = true
                }
                // 返回自定义 visitor，用于捕获该注解上的元注解
                return object : AnnotationVisitor(ASM9) {
                    override fun visitAnnotation(name: String?, desc: String?): AnnotationVisitor {
                        // 此处 desc 是元注解的 descriptor，例如 @NotNull
                        if (desc == notNullDescriptor) {
                            hasNotNull = true
                        }
                        // 继续支持多层嵌套（如元注解自身也有元注解）
                        return this
                    }
                }
            }

            override fun visitEnd() {
                println("[Field: $name] Contains @NotNull (direct or meta): $hasNotNull")
                super.visitEnd()
            }
        }
    }
}, ClassReader.SKIP_DEBUG)

✅ 关键点说明：

visitAnnotation(String name, String descriptor) 在 AnnotationVisitor 中被调用时，参数 descriptor 即为被嵌套的元注解的二进制类型描述符（如 "Ljakarta/validation/constraints/NotNull;"），而非外层注解名；
必须显式返回一个新的 AnnotationVisitor 实例来接收元注解事件，不能复用父 visitor；
支持任意深度嵌套（如 @A → @B → @NotNull），只需在内层 visitor 中继续重写 visitAnnotation 并递归处理；
使用 ClassReader.SKIP_DEBUG 可提升性能（跳过调试信息）；

⚠️ 注意事项：

ASM 不解析注解运行时值（如 @NotNull(message="xxx") 中的 message），仅处理类型结构；
确保目标注解（如 @NotNull）的类路径在 ASM 分析时可达（通常 jakarta.validation-api 已引入，无需额外处理）；
若需同时检查多个元注解（如 @NotBlank, @Size），建议将待查 descriptor 存入 Set<string></string> 统一比对；
生产环境建议封装为可复用的 MetaAnnotationDetector 工具类，避免重复逻辑。