Java Proto 名称

由 Java protoc 插件生成的名称。

本文档包含关于根据不同 proto 选项生成的 proto 的完全限定 Java 名称的信息。此名称对应于您需要导入才能使用该消息的包。

建议

  • 设置选项 java_multiple_files = true;
  • 设置选项 java_outer_classname = "FileNameProto";
  • 设置选项 java_package = "com.google.package";

解释

多文件

当设置 java_multiple_files = true 时，为每条消息生成的 Java 类将放在一个单独的 .java 文件中。这使得在不同的 .proto 文件之间移动消息变得容易得多。

外部类名

对于 .proto 文件本身，会生成一个 Java 类。如果没有指定名称，则文件的类名将自动生成。然而，该名称的生成规则过于复杂且不直观。最好的策略是显式地将 java_outer_classname 选项设置为将 .proto 文件名转换为 PascalCase 并移除 '.' 后的名称。例如

  • 文件 student_record_request.proto 应设置

    option java_outer_classname = "StudentRecordRequestProto";

Java 包

为生成的绑定设置的 Java 包将自动设置为 proto 包。然而，这通常不符合 Java 约定。为了确保符合惯例的 Java 包名，我们建议显式地设置 java_package 选项。例如，在 Google 内部，惯例是在 proto 包名前加上 com.google.。

不可变 API 消息名称

protoc 的 Java 插件将根据此表生成名称。

java_multiple_filesjava_packagejava_outer_classname生成的完整消息名称
true未定义忽略com.google.protos.$package.$message
true已定义忽略$java_package.$message
false未定义未定义com.google.protos.$package.$derived_outer_class.$message
false未定义已定义com.google.protos.$package.$java_outer_classname.$message
false已定义未定义$java_package.$derived_outer_class.$message
false已定义已定义$java_package.$java_outer_classname.$message

图例

  • $message 是 proto 消息的实际名称。

  • $package 是 proto 包的名称。这是 proto 文件中由 package 指令指定的名称，通常位于文件顶部。

  • $derived_outer_class 是根据 proto 文件名生成的名称。通常是通过移除文件名的标点符号并转换为 PascalCase 计算得出。例如，如果 proto 文件是 foo_bar.proto，则 $derived_outer_class 的值是 FooBar。

    如果生成的类名与 proto 文件中定义的消息之一相同，derived_outer_class 将被附加 OuterClass。例如，如果 proto 文件是 foo_bar.proto 且包含 FooBar 消息，则 $derived_outer_class 的值是 FooBarOuterClass。使用 v1 API 时也是如此，无论类名是否与定义的消息之一相同。

  • 所有其他 $names 都是 .proto 文件中定义的相应文件选项的值。