如何向Protobuf生成的代码添加Java编译时自定义注解

Question

我使用Proto 3框架的gRPC。我们有一个名为Jacoco的Java代码覆盖工具，该工具会扫描编译后的类中的Java字节码，以查找带有@Generated "注释"的Java注释，并跳过该Java类的覆盖范围。但是Proto编译器会添加此注释：

@javax.annotation.Generated(
    value = "by gRPC proto compiler (version 1.20.0)",
    comments = "Source: myProto.proto")
public class MyClass {
...
}

但是 javax.annotation.Generated 的注释具有 @Retention(value=SOURCE)，这在已编译的类中不存在。

有没有一种方法可以在 protobuf 生成的 Java 文件中添加注释并在编译时处理？

- Ivan Voroshilin

---

你能找到解决这个问题的方法吗？我们也遇到了同样的问题（我们也使用lombok，但是lombok生成的注释被正确地跳过了）。 - vpram86

Answer 1

这是一个老问题，但仍然存在。

https://github.com/protocolbuffers/protobuf/issues/42

所以你应该将 --java_out=annotate_code 添加到 protoc 选项列表中。

如果你使用 https://github.com/google/protobuf-gradle-plugin gradle 插件进行代码生成，那么你可以像这样做（Gradle Kotlin DSL）：

protobuf {
    generateProtoTasks {
        all().forEach { task ->
            task.builtins {
                getByName("java") {
                    option("annotate_code")
                }
            }
        }
    }
}

- Andrej Urvantsev