安卓protobuf nano文档

Question

安卓protobuf nano文档

5

我正在尝试减少由Google Proto-buf生成的方法数量，其中一种替代方案是使用Proto-buf Nano。然而，我发现没有关于如何使用它的文档。除了包链接外，我找不到任何关于如何使用nano从proto文件生成Java文件的信息。

因此，问题很简单：如何使用Google Proto Nano生成Java类，并在项目中使用它们？

- gunar

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- vzamanillo · Accepted Answer

看主要的protobuf编译器源代码：

#include <google/protobuf/compiler/javanano/javanano_generator.h>
.... 

int main(int argc, char* argv[]) {

    google::protobuf::compiler::CommandLineInterface cli;
    cli.AllowPlugins("protoc-");
    ...
    // Proto2 JavaNano
    google::protobuf::compiler::javanano::JavaNanoGenerator javanano_generator;
    cli.RegisterGenerator("--javanano_out", &javanano_generator,
    "Generate Java source file nano runtime.");

    return cli.Run(argc, argv);
}

请看protobuf的自述文件

Nano生成器选项

java_package -> <file-name>|<package-name>

java_outer_classname -> <file-name>|<package-name>

java_multiple_files -> true or false

java_nano_generate_has -> true or false [已弃用]

optional_field_style -> default or accessors

enum_style -> c or java

在Android存储库之外使用nano protobufs：

链接生成的jar文件，如：<protobuf-root>java/target/protobuf-java-2.3.0-nano.jar.

使用--javanano_out调用，例如：

./protoc '--javanano_out=java_package=src/proto/simple-data.proto|my_package,java_outer_classname=src/proto/simple-data.proto|OuterName:.' src/proto/simple-data.proto

在Android存储库内使用nano protobufs：

在您的本地.mk文件中设置'LOCAL_PROTOC_OPTIMIZE_TYPE := nano'。当构建Java库或应用程序（包）目标时，构建系统会将Java nano运行时库添加到LOCAL_STATIC_JAVA_LIBRARIES变量中，因此您不需要自己添加。

在您的本地.mk文件中设置'LOCAL_PROTO_JAVA_OUTPUT_PARAMS := ...'以获取所需的任何命令行选项。使用逗号将多个选项连接起来。仅在nano flavor中，忽略选项名称和值周围的空格，因此可以使用反斜杠换行符或'+='来优化您的make文件结构。

在构建Java库或包时，这些选项将应用于所有LOCAL_SRC_FILES中的proto文件。如果需要为不同的proto文件使用不同的选项，请构建单独的Java库并在主目标中引用它们。注意：对于每个单独的目标，您应确保从LOCAL_SRC_FILES中的任何proto文件导入的所有proto文件都包含在LOCAL_SRC_FILES中。这是因为生成器必须假定导入的文件是使用相同选项构建的，并且将生成引用导入文件中的字段和枚举的代码使用相同的代码风格。

提示：'include $(CLEAR_VARS)'重置所有LOCAL_变量，包括上述两个变量。

来自https://android.googlesource.com/platform/external/protobuf/+/master/src/google/protobuf/的简单nano示例。 unittest_simple_nano.proto

package protobuf_unittest_import;

option java_package = "com.google.protobuf.nano";
// Explicit outer classname to suppress legacy info.
option java_outer_classname = "UnittestSimpleNano";

message SimpleMessageNano {
  message NestedMessage {
    optional int32 bb = 1;
  }

  enum NestedEnum {
    FOO = 1;
    BAR = 2;
    BAZ = 3;
  }

  optional int32 d = 1 [default = 123];
  optional NestedMessage nested_msg = 2;
  optional NestedEnum default_nested_enum = 3 [default = BAZ];
}

命令行

./protoc '--javanano_out=java_package=google/protobuf/unittest_simple_nano.proto|com.google.protobuf.nano,java_outer_classname=google/protobuf/unittest_simple_nano.proto|UnittestSimpleNano:target/generated-test-sources' google/protobuf/unittest_simple_nano.proto

测试摘自NanoTest.java

这是一个关于 IT 技术的测试。

  public void testSimpleMessageNano() throws Exception {
    SimpleMessageNano msg = new SimpleMessageNano();
    assertEquals(123, msg.d);
    assertEquals(null, msg.nestedMsg);
    assertEquals(SimpleMessageNano.BAZ, msg.defaultNestedEnum);

    msg.d = 456;
    assertEquals(456, msg.d);

    SimpleMessageNano.NestedMessage nestedMsg = new SimpleMessageNano.NestedMessage();
    nestedMsg.bb = 2;
    assertEquals(2, nestedMsg.bb);
    msg.nestedMsg = nestedMsg;
    assertEquals(2, msg.nestedMsg.bb);

    msg.defaultNestedEnum = SimpleMessageNano.BAR;
    assertEquals(SimpleMessageNano.BAR, msg.defaultNestedEnum);

    byte [] result = MessageNano.toByteArray(msg);
    int msgSerializedSize = msg.getSerializedSize();
    //System.out.printf("mss=%d result.length=%d\n", msgSerializedSize, result.length);
    assertTrue(msgSerializedSize == 9);
    assertEquals(result.length, msgSerializedSize);

    SimpleMessageNano newMsg = SimpleMessageNano.parseFrom(result);
    assertEquals(456, newMsg.d);
    assertEquals(2, msg.nestedMsg.bb);
    assertEquals(SimpleMessageNano.BAR, msg.defaultNestedEnum);
  }

同一个类中有很多测试用例，在查看项目pom时，您可以找到maven-antrun-plugin配置以生成测试资源类。

<!-- java nano -->
<exec executable="../src/protoc">
  <arg value="--javanano_out=java_package=google/protobuf/unittest_import_nano.proto|com.google.protobuf.nano,java_outer_classname=google/protobuf/unittest_import_nano.proto|UnittestImportNano:target/generated-test-sources" />
  <arg value="--proto_path=../src" />
  <arg value="--proto_path=src/test/java" />
  <arg value="../src/google/protobuf/unittest_nano.proto" />
  <arg value="../src/google/protobuf/unittest_simple_nano.proto" />
  <arg value="../src/google/protobuf/unittest_stringutf8_nano.proto" />
  <arg value="../src/google/protobuf/unittest_recursive_nano.proto" />
  <arg value="../src/google/protobuf/unittest_import_nano.proto" />
  <arg value="../src/google/protobuf/unittest_enum_multiplejava_nano.proto" />
  <arg value="../src/google/protobuf/unittest_multiple_nano.proto" />
</exec>

希望这可以帮助你。