登录/ 注册
 找回密码
 立即注册
关闭

CSDN热搜

程序园 精品问答 技术交流 资源下载
返回列表 发新帖
首页 › 业界区 › 业界 ›高效编解码协议之protobuf协议详解

高效编解码协议之protobuf协议详解

肿抢 2025-8-1 20:18:36
Protocol Buffers（简称 protobuf）是 Google 开发的 高效二进制序列化工具，用于结构化数据的存储和传输。
核心特性

特性说明跨语言支持支持 Java、C++、Python、Go 等主流语言。高效编解码二进制格式，比 JSON/XML 更小、更快。强类型约束通过 .proto 文件定义数据结构，避免运行时错误。向后兼容支持字段扩展（新增字段不影响旧代码）。使用指南

开发环境


  • windows
  • jetbrains idea
  • maven_3.9.7
  • jdk_8
  • protobuf_31.1
安装编译器（protoc）


  • 下载地址： protobuf_v31.1
配置


  • 将下载的压缩包解压出来，新增环境变量protobuf=文件夹路径
  • 编辑环境变量Path，新增%protobuf%\bin
验证
  1. # 打开cmd命令行，执行以下命令
  2. protoc --version
  4. # 输出结果如下，表示安装成功
  5. libprotoc 31.1
复制代码
定义数据结构


  • 新建person.proto文件
  1. // person.proto
  2. syntax = "proto3";
  4. message Person {
  5.   string name = 1;
  6.   int32 id = 2;
  7.   repeated string emails = 3;
  8. }
复制代码
编译

手动执行命令
  1. # 打开cmd命令行，切换到person.proto文件目录下，执行以下命令
  2. protoc --java_out=./ ./person.proto
  4. # 当前目录下会生成PersonOuterClass.java文件
  5. # 将PersonOuterClass.java复制到对应项目目录就可以使用了
  6. # PersonOuterClass.java默认没有package路径，需要手动加一下
复制代码
maven插件编译


  • 在pom.xml中加入以下代码，执行maven的clean compile
  1. <build>
  2.   <plugins>
  3.     <plugin>
  4.       <groupId>org.xolstice.maven.plugins</groupId>
  5.       protobuf-maven-plugin</artifactId>
  6.       <version>0.6.1</version>
  7.       <executions>
  8.         <execution>
  9.           <goals>
  10.             <goal>compile</goal>
  11.           </goals>
  12.         </execution>
  13.       </executions>
  14.       <configuration>
  15.         
  16.         <protocExecutable>protoc</protocExecutable>
  17.         
  18.         
  19.       </configuration>
  20.     </plugin>
  21.   </plugins>
  22. </build>
复制代码

  • 插件默认读取文件夹/src/main/proto下的proto文件去编译
  • 在文件夹target/generated-sources/protobuf/java下会生成对应pojo的protobuf操作类
注意：

  • 若执行protoc命令之后idea报如下错误：Module 'my-test' production: java.lang.ClassCastException: class org.jetbrains.jps.builders.java.dependencyView.TypeRepr$PrimitiveType cannot be cast to class org.jetbrains.jps.builders.java.dependencyView.TypeRepr$ClassType (org.jetbrains.jps.builders.java.dependencyView.TypeRepr$PrimitiveType and org.jetbrains.jps.builders.java.dependencyView.TypeRepr$ClassType are in unnamed module of loader java.net.URLClassLoader @2f2c9b19)。则清除一下idea的缓存，然后执行rebuild
  • 若idea的terminal或者maven执行compile的时候报错未找到protoc命令，则可以在terminal中执行以下命令排查idea是否读取到最新的Path。若打印的Path值没有protoc的路径，则重启一下电脑。
  1. # terminal中使用的是powershell的话执行
  2. echo $env:path
  4. # terminal中使用的是cmd的话执行
  5. echo %path%
复制代码
编译结果示例
  1. // Generated by the protocol buffer compiler.  DO NOT EDIT!
  2. // NO CHECKED-IN PROTOBUF GENCODE
  3. // source: person.proto
  4. // Protobuf Java Version: 4.31.1
  6. @com.google.protobuf.Generated
  7. public final class PersonOuterClass {
  8.   private PersonOuterClass() {}
  9.   static {
  10.     com.google.protobuf.RuntimeVersion.validateProtobufGencodeVersion(
  11.       com.google.protobuf.RuntimeVersion.RuntimeDomain.PUBLIC,
  12.       /* major= */ 4,
  13.       /* minor= */ 31,
  14.       /* patch= */ 1,
  15.       /* suffix= */ "",
  16.       PersonOuterClass.class.getName());
  17.   }
  18.   public static void registerAllExtensions(
  19.       com.google.protobuf.ExtensionRegistryLite registry) {
  20.   }
  22.   public static void registerAllExtensions(
  23.       com.google.protobuf.ExtensionRegistry registry) {
  24.     registerAllExtensions(
  25.         (com.google.protobuf.ExtensionRegistryLite) registry);
  26.   }
  27.   public interface PersonOrBuilder extends
  28.       // @@protoc_insertion_point(interface_extends:Person)
  29.       com.google.protobuf.MessageOrBuilder {
  31.     /**
  32.      * string name = 1;
  33.      * @return The name.
  34.      */
  35.     java.lang.String getName();
  36.     /**
  37.      * string name = 1;
  38.      * @return The bytes for name.
  39.      */
  40.     com.google.protobuf.ByteString
  41.         getNameBytes();
  43.     /**
  44.      * int32 id = 2;
  45.      * @return The id.
  46.      */
  47.     int getId();
  49.     /**
  50.      * repeated string emails = 3;
  51.      * @return A list containing the emails.
  52.      */
  53.     java.util.List<java.lang.String>
  54.         getEmailsList();
  55.     /**
  56.      * repeated string emails = 3;
  57.      * @return The count of emails.
  58.      */
  59.     int getEmailsCount();
  60.     /**
  61.      * repeated string emails = 3;
  62.      * @param index The index of the element to return.
  63.      * @return The emails at the given index.
  64.      */
  65.     java.lang.String getEmails(int index);
  66.     /**
  67.      * repeated string emails = 3;
  68.      * @param index The index of the value to return.
  69.      * @return The bytes of the emails at the given index.
  70.      */
  71.     com.google.protobuf.ByteString
  72.         getEmailsBytes(int index);
  73.   }
  74.   /**
  75.    * Protobuf type {@code Person}
  76.    */
  77.   public static final class Person extends
  78.       com.google.protobuf.GeneratedMessage implements
  79.       // @@protoc_insertion_point(message_implements:Person)
  80.       PersonOrBuilder {
  81.   private static final long serialVersionUID = 0L;
  82.     static {
  83.       com.google.protobuf.RuntimeVersion.validateProtobufGencodeVersion(
  84.         com.google.protobuf.RuntimeVersion.RuntimeDomain.PUBLIC,
  85.         /* major= */ 4,
  86.         /* minor= */ 31,
  87.         /* patch= */ 1,
  88.         /* suffix= */ "",
  89.         Person.class.getName());
  90.     }
  91.     // Use Person.newBuilder() to construct.
  92.     private Person(com.google.protobuf.GeneratedMessage.Builder<?> builder) {
  93.       super(builder);
  94.     }
  95.     private Person() {
  96.       name_ = "";
  97.       emails_ =
  98.           com.google.protobuf.LazyStringArrayList.emptyList();
  99.     }
  101.     public static final com.google.protobuf.Descriptors.Descriptor
  102.         getDescriptor() {
  103.       return PersonOuterClass.internal_static_Person_descriptor;
  104.     }
  106.     @java.lang.Override
  107.     protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
  108.         internalGetFieldAccessorTable() {
  109.       return PersonOuterClass.internal_static_Person_fieldAccessorTable
  110.           .ensureFieldAccessorsInitialized(
  111.               PersonOuterClass.Person.class, PersonOuterClass.Person.Builder.class);
  112.     }
  114.     public static final int NAME_FIELD_NUMBER = 1;
  115.     @SuppressWarnings("serial")
  116.     private volatile java.lang.Object name_ = "";
  117.     /**
  118.      * string name = 1;
  119.      * @return The name.
  120.      */
  121.     @java.lang.Override
  122.     public java.lang.String getName() {
  123.       java.lang.Object ref = name_;
  124.       if (ref instanceof java.lang.String) {
  125.         return (java.lang.String) ref;
  126.       } else {
  127.         com.google.protobuf.ByteString bs =
  128.             (com.google.protobuf.ByteString) ref;
  129.         java.lang.String s = bs.toStringUtf8();
  130.         name_ = s;
  131.         return s;
  132.       }
  133.     }
  134.     /**
  135.      * string name = 1;
  136.      * @return The bytes for name.
  137.      */
  138.     @java.lang.Override
  139.     public com.google.protobuf.ByteString
  140.         getNameBytes() {
  141.       java.lang.Object ref = name_;
  142.       if (ref instanceof java.lang.String) {
  143.         com.google.protobuf.ByteString b =
  144.             com.google.protobuf.ByteString.copyFromUtf8(
  145.                 (java.lang.String) ref);
  146.         name_ = b;
  147.         return b;
  148.       } else {
  149.         return (com.google.protobuf.ByteString) ref;
  150.       }
  151.     }
  153.     public static final int ID_FIELD_NUMBER = 2;
  154.     private int id_ = 0;
  155.     /**
  156.      * int32 id = 2;
  157.      * @return The id.
  158.      */
  159.     @java.lang.Override
  160.     public int getId() {
  161.       return id_;
  162.     }
  164.     public static final int EMAILS_FIELD_NUMBER = 3;
  165.     @SuppressWarnings("serial")
  166.     private com.google.protobuf.LazyStringArrayList emails_ =
  167.         com.google.protobuf.LazyStringArrayList.emptyList();
  168.     /**
  169.      * repeated string emails = 3;
  170.      * @return A list containing the emails.
  171.      */
  172.     public com.google.protobuf.ProtocolStringList
  173.         getEmailsList() {
  174.       return emails_;
  175.     }
  176.     /**
  177.      * repeated string emails = 3;
  178.      * @return The count of emails.
  179.      */
  180.     public int getEmailsCount() {
  181.       return emails_.size();
  182.     }
  183.     /**
  184.      * repeated string emails = 3;
  185.      * @param index The index of the element to return.
  186.      * @return The emails at the given index.
  187.      */
  188.     public java.lang.String getEmails(int index) {
  189.       return emails_.get(index);
  190.     }
  191.     /**
  192.      * repeated string emails = 3;
  193.      * @param index The index of the value to return.
  194.      * @return The bytes of the emails at the given index.
  195.      */
  196.     public com.google.protobuf.ByteString
  197.         getEmailsBytes(int index) {
  198.       return emails_.getByteString(index);
  199.     }
  201.     private byte memoizedIsInitialized = -1;
  202.     @java.lang.Override
  203.     public final boolean isInitialized() {
  204.       byte isInitialized = memoizedIsInitialized;
  205.       if (isInitialized == 1) return true;
  206.       if (isInitialized == 0) return false;
  208.       memoizedIsInitialized = 1;
  209.       return true;
  210.     }
  212.     @java.lang.Override
  213.     public void writeTo(com.google.protobuf.CodedOutputStream output)
  214.                         throws java.io.IOException {
  215.       if (!com.google.protobuf.GeneratedMessage.isStringEmpty(name_)) {
  216.         com.google.protobuf.GeneratedMessage.writeString(output, 1, name_);
  217.       }
  218.       if (id_ != 0) {
  219.         output.writeInt32(2, id_);
  220.       }
  221.       for (int i = 0; i < emails_.size(); i++) {
  222.         com.google.protobuf.GeneratedMessage.writeString(output, 3, emails_.getRaw(i));
  223.       }
  224.       getUnknownFields().writeTo(output);
  225.     }
  227.     @java.lang.Override
  228.     public int getSerializedSize() {
  229.       int size = memoizedSize;
  230.       if (size != -1) return size;
  232.       size = 0;
  233.       if (!com.google.protobuf.GeneratedMessage.isStringEmpty(name_)) {
  234.         size += com.google.protobuf.GeneratedMessage.computeStringSize(1, name_);
  235.       }
  236.       if (id_ != 0) {
  237.         size += com.google.protobuf.CodedOutputStream
  238.           .computeInt32Size(2, id_);
  239.       }
  240.       {
  241.         int dataSize = 0;
  242.         for (int i = 0; i < emails_.size(); i++) {
  243.           dataSize += computeStringSizeNoTag(emails_.getRaw(i));
  244.         }
  245.         size += dataSize;
  246.         size += 1 * getEmailsList().size();
  247.       }
  248.       size += getUnknownFields().getSerializedSize();
  249.       memoizedSize = size;
  250.       return size;
  251.     }
  253.     @java.lang.Override
  254.     public boolean equals(final java.lang.Object obj) {
  255.       if (obj == this) {
  256.        return true;
  257.       }
  258.       if (!(obj instanceof PersonOuterClass.Person)) {
  259.         return super.equals(obj);
  260.       }
  261.       PersonOuterClass.Person other = (PersonOuterClass.Person) obj;
  263.       if (!getName()
  264.           .equals(other.getName())) return false;
  265.       if (getId()
  266.           != other.getId()) return false;
  267.       if (!getEmailsList()
  268.           .equals(other.getEmailsList())) return false;
  269.       if (!getUnknownFields().equals(other.getUnknownFields())) return false;
  270.       return true;
  271.     }
  273.     @java.lang.Override
  274.     public int hashCode() {
  275.       if (memoizedHashCode != 0) {
  276.         return memoizedHashCode;
  277.       }
  278.       int hash = 41;
  279.       hash = (19 * hash) + getDescriptor().hashCode();
  280.       hash = (37 * hash) + NAME_FIELD_NUMBER;
  281.       hash = (53 * hash) + getName().hashCode();
  282.       hash = (37 * hash) + ID_FIELD_NUMBER;
  283.       hash = (53 * hash) + getId();
  284.       if (getEmailsCount() > 0) {
  285.         hash = (37 * hash) + EMAILS_FIELD_NUMBER;
  286.         hash = (53 * hash) + getEmailsList().hashCode();
  287.       }
  288.       hash = (29 * hash) + getUnknownFields().hashCode();
  289.       memoizedHashCode = hash;
  290.       return hash;
  291.     }
  293.     public static PersonOuterClass.Person parseFrom(
  294.         java.nio.ByteBuffer data)
  295.         throws com.google.protobuf.InvalidProtocolBufferException {
  296.       return PARSER.parseFrom(data);
  297.     }
  298.     public static PersonOuterClass.Person parseFrom(
  299.         java.nio.ByteBuffer data,
  300.         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
  301.         throws com.google.protobuf.InvalidProtocolBufferException {
  302.       return PARSER.parseFrom(data, extensionRegistry);
  303.     }
  304.     public static PersonOuterClass.Person parseFrom(
  305.         com.google.protobuf.ByteString data)
  306.         throws com.google.protobuf.InvalidProtocolBufferException {
  307.       return PARSER.parseFrom(data);
  308.     }
  309.     public static PersonOuterClass.Person parseFrom(
  310.         com.google.protobuf.ByteString data,
  311.         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
  312.         throws com.google.protobuf.InvalidProtocolBufferException {
  313.       return PARSER.parseFrom(data, extensionRegistry);
  314.     }
  315.     public static PersonOuterClass.Person parseFrom(byte[] data)
  316.         throws com.google.protobuf.InvalidProtocolBufferException {
  317.       return PARSER.parseFrom(data);
  318.     }
  319.     public static PersonOuterClass.Person parseFrom(
  320.         byte[] data,
  321.         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
  322.         throws com.google.protobuf.InvalidProtocolBufferException {
  323.       return PARSER.parseFrom(data, extensionRegistry);
  324.     }
  325.     public static PersonOuterClass.Person parseFrom(java.io.InputStream input)
  326.         throws java.io.IOException {
  327.       return com.google.protobuf.GeneratedMessage
  328.           .parseWithIOException(PARSER, input);
  329.     }
  330.     public static PersonOuterClass.Person parseFrom(
  331.         java.io.InputStream input,
  332.         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
  333.         throws java.io.IOException {
  334.       return com.google.protobuf.GeneratedMessage
  335.           .parseWithIOException(PARSER, input, extensionRegistry);
  336.     }
  338.     public static PersonOuterClass.Person parseDelimitedFrom(java.io.InputStream input)
  339.         throws java.io.IOException {
  340.       return com.google.protobuf.GeneratedMessage
  341.           .parseDelimitedWithIOException(PARSER, input);
  342.     }
  344.     public static PersonOuterClass.Person parseDelimitedFrom(
  345.         java.io.InputStream input,
  346.         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
  347.         throws java.io.IOException {
  348.       return com.google.protobuf.GeneratedMessage
  349.           .parseDelimitedWithIOException(PARSER, input, extensionRegistry);
  350.     }
  351.     public static PersonOuterClass.Person parseFrom(
  352.         com.google.protobuf.CodedInputStream input)
  353.         throws java.io.IOException {
  354.       return com.google.protobuf.GeneratedMessage
  355.           .parseWithIOException(PARSER, input);
  356.     }
  357.     public static PersonOuterClass.Person parseFrom(
  358.         com.google.protobuf.CodedInputStream input,
  359.         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
  360.         throws java.io.IOException {
  361.       return com.google.protobuf.GeneratedMessage
  362.           .parseWithIOException(PARSER, input, extensionRegistry);
  363.     }
  365.     @java.lang.Override
  366.     public Builder newBuilderForType() { return newBuilder(); }
  367.     public static Builder newBuilder() {
  368.       return DEFAULT_INSTANCE.toBuilder();
  369.     }
  370.     public static Builder newBuilder(PersonOuterClass.Person prototype) {
  371.       return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype);
  372.     }
  373.     @java.lang.Override
  374.     public Builder toBuilder() {
  375.       return this == DEFAULT_INSTANCE
  376.           ? new Builder() : new Builder().mergeFrom(this);
  377.     }
  379.     @java.lang.Override
  380.     protected Builder newBuilderForType(
  381.         com.google.protobuf.GeneratedMessage.BuilderParent parent) {
  382.       Builder builder = new Builder(parent);
  383.       return builder;
  384.     }
  385.     /**
  386.      * Protobuf type {@code Person}
  387.      */
  388.     public static final class Builder extends
  389.         com.google.protobuf.GeneratedMessage.Builder<Builder> implements
  390.         // @@protoc_insertion_point(builder_implements:Person)
  391.         PersonOuterClass.PersonOrBuilder {
  392.       public static final com.google.protobuf.Descriptors.Descriptor
  393.           getDescriptor() {
  394.         return PersonOuterClass.internal_static_Person_descriptor;
  395.       }
  397.       @java.lang.Override
  398.       protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
  399.           internalGetFieldAccessorTable() {
  400.         return PersonOuterClass.internal_static_Person_fieldAccessorTable
  401.             .ensureFieldAccessorsInitialized(
  402.                 PersonOuterClass.Person.class, PersonOuterClass.Person.Builder.class);
  403.       }
  405.       // Construct using PersonOuterClass.Person.newBuilder()
  406.       private Builder() {
  408.       }
  410.       private Builder(
  411.           com.google.protobuf.GeneratedMessage.BuilderParent parent) {
  412.         super(parent);
  414.       }
  415.       @java.lang.Override
  416.       public Builder clear() {
  417.         super.clear();
  418.         bitField0_ = 0;
  419.         name_ = "";
  420.         id_ = 0;
  421.         emails_ =
  422.             com.google.protobuf.LazyStringArrayList.emptyList();
  423.         return this;
  424.       }
  426.       @java.lang.Override
  427.       public com.google.protobuf.Descriptors.Descriptor
  428.           getDescriptorForType() {
  429.         return PersonOuterClass.internal_static_Person_descriptor;
  430.       }
  432.       @java.lang.Override
  433.       public PersonOuterClass.Person getDefaultInstanceForType() {
  434.         return PersonOuterClass.Person.getDefaultInstance();
  435.       }
  437.       @java.lang.Override
  438.       public PersonOuterClass.Person build() {
  439.         PersonOuterClass.Person result = buildPartial();
  440.         if (!result.isInitialized()) {
  441.           throw newUninitializedMessageException(result);
  442.         }
  443.         return result;
  444.       }
  446.       @java.lang.Override
  447.       public PersonOuterClass.Person buildPartial() {
  448.         PersonOuterClass.Person result = new PersonOuterClass.Person(this);
  449.         if (bitField0_ != 0) { buildPartial0(result); }
  450.         onBuilt();
  451.         return result;
  452.       }
  454.       private void buildPartial0(PersonOuterClass.Person result) {
  455.         int from_bitField0_ = bitField0_;
  456.         if (((from_bitField0_ & 0x00000001) != 0)) {
  457.           result.name_ = name_;
  458.         }
  459.         if (((from_bitField0_ & 0x00000002) != 0)) {
  460.           result.id_ = id_;
  461.         }
  462.         if (((from_bitField0_ & 0x00000004) != 0)) {
  463.           emails_.makeImmutable();
  464.           result.emails_ = emails_;
  465.         }
  466.       }
  468.       @java.lang.Override
  469.       public Builder mergeFrom(com.google.protobuf.Message other) {
  470.         if (other instanceof PersonOuterClass.Person) {
  471.           return mergeFrom((PersonOuterClass.Person)other);
  472.         } else {
  473.           super.mergeFrom(other);
  474.           return this;
  475.         }
  476.       }
  478.       public Builder mergeFrom(PersonOuterClass.Person other) {
  479.         if (other == PersonOuterClass.Person.getDefaultInstance()) return this;
  480.         if (!other.getName().isEmpty()) {
  481.           name_ = other.name_;
  482.           bitField0_ |= 0x00000001;
  483.           onChanged();
  484.         }
  485.         if (other.getId() != 0) {
  486.           setId(other.getId());
  487.         }
  488.         if (!other.emails_.isEmpty()) {
  489.           if (emails_.isEmpty()) {
  490.             emails_ = other.emails_;
  491.             bitField0_ |= 0x00000004;
  492.           } else {
  493.             ensureEmailsIsMutable();
  494.             emails_.addAll(other.emails_);
  495.           }
  496.           onChanged();
  497.         }
  498.         this.mergeUnknownFields(other.getUnknownFields());
  499.         onChanged();
  500.         return this;
  501.       }
  503.       @java.lang.Override
  504.       public final boolean isInitialized() {
  505.         return true;
  506.       }
  508.       @java.lang.Override
  509.       public Builder mergeFrom(
  510.           com.google.protobuf.CodedInputStream input,
  511.           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
  512.           throws java.io.IOException {
  513.         if (extensionRegistry == null) {
  514.           throw new java.lang.NullPointerException();
  515.         }
  516.         try {
  517.           boolean done = false;
  518.           while (!done) {
  519.             int tag = input.readTag();
  520.             switch (tag) {
  521.               case 0:
  522.                 done = true;
  523.                 break;
  524.               case 10: {
  525.                 name_ = input.readStringRequireUtf8();
  526.                 bitField0_ |= 0x00000001;
  527.                 break;
  528.               } // case 10
  529.               case 16: {
  530.                 id_ = input.readInt32();
  531.                 bitField0_ |= 0x00000002;
  532.                 break;
  533.               } // case 16
  534.               case 26: {
  535.                 java.lang.String s = input.readStringRequireUtf8();
  536.                 ensureEmailsIsMutable();
  537.                 emails_.add(s);
  538.                 break;
  539.               } // case 26
  540.               default: {
  541.                 if (!super.parseUnknownField(input, extensionRegistry, tag)) {
  542.                   done = true; // was an endgroup tag
  543.                 }
  544.                 break;
  545.               } // default:
  546.             } // switch (tag)
  547.           } // while (!done)
  548.         } catch (com.google.protobuf.InvalidProtocolBufferException e) {
  549.           throw e.unwrapIOException();
  550.         } finally {
  551.           onChanged();
  552.         } // finally
  553.         return this;
  554.       }
  555.       private int bitField0_;
  557.       private java.lang.Object name_ = "";
  558.       /**
  559.        * string name = 1;
  560.        * @return The name.
  561.        */
  562.       public java.lang.String getName() {
  563.         java.lang.Object ref = name_;
  564.         if (!(ref instanceof java.lang.String)) {
  565.           com.google.protobuf.ByteString bs =
  566.               (com.google.protobuf.ByteString) ref;
  567.           java.lang.String s = bs.toStringUtf8();
  568.           name_ = s;
  569.           return s;
  570.         } else {
  571.           return (java.lang.String) ref;
  572.         }
  573.       }
  574.       /**
  575.        * string name = 1;
  576.        * @return The bytes for name.
  577.        */
  578.       public com.google.protobuf.ByteString
  579.           getNameBytes() {
  580.         java.lang.Object ref = name_;
  581.         if (ref instanceof String) {
  582.           com.google.protobuf.ByteString b =
  583.               com.google.protobuf.ByteString.copyFromUtf8(
  584.                   (java.lang.String) ref);
  585.           name_ = b;
  586.           return b;
  587.         } else {
  588.           return (com.google.protobuf.ByteString) ref;
  589.         }
  590.       }
  591.       /**
  592.        * string name = 1;
  593.        * @param value The name to set.
  594.        * @return This builder for chaining.
  595.        */
  596.       public Builder setName(
  597.           java.lang.String value) {
  598.         if (value == null) { throw new NullPointerException(); }
  599.         name_ = value;
  600.         bitField0_ |= 0x00000001;
  601.         onChanged();
  602.         return this;
  603.       }
  604.       /**
  605.        * string name = 1;
  606.        * @return This builder for chaining.
  607.        */
  608.       public Builder clearName() {
  609.         name_ = getDefaultInstance().getName();
  610.         bitField0_ = (bitField0_ & ~0x00000001);
  611.         onChanged();
  612.         return this;
  613.       }
  614.       /**
  615.        * string name = 1;
  616.        * @param value The bytes for name to set.
  617.        * @return This builder for chaining.
  618.        */
  619.       public Builder setNameBytes(
  620.           com.google.protobuf.ByteString value) {
  621.         if (value == null) { throw new NullPointerException(); }
  622.         checkByteStringIsUtf8(value);
  623.         name_ = value;
  624.         bitField0_ |= 0x00000001;
  625.         onChanged();
  626.         return this;
  627.       }
  629.       private int id_ ;
  630.       /**
  631.        * int32 id = 2;
  632.        * @return The id.
  633.        */
  634.       @java.lang.Override
  635.       public int getId() {
  636.         return id_;
  637.       }
  638.       /**
  639.        * int32 id = 2;
  640.        * @param value The id to set.
  641.        * @return This builder for chaining.
  642.        */
  643.       public Builder setId(int value) {
  645.         id_ = value;
  646.         bitField0_ |= 0x00000002;
  647.         onChanged();
  648.         return this;
  649.       }
  650.       /**
  651.        * int32 id = 2;
  652.        * @return This builder for chaining.
  653.        */
  654.       public Builder clearId() {
  655.         bitField0_ = (bitField0_ & ~0x00000002);
  656.         id_ = 0;
  657.         onChanged();
  658.         return this;
  659.       }
  661.       private com.google.protobuf.LazyStringArrayList emails_ =
  662.           com.google.protobuf.LazyStringArrayList.emptyList();
  663.       private void ensureEmailsIsMutable() {
  664.         if (!emails_.isModifiable()) {
  665.           emails_ = new com.google.protobuf.LazyStringArrayList(emails_);
  666.         }
  667.         bitField0_ |= 0x00000004;
  668.       }
  669.       /**
  670.        * repeated string emails = 3;
  671.        * @return A list containing the emails.
  672.        */
  673.       public com.google.protobuf.ProtocolStringList
  674.           getEmailsList() {
  675.         emails_.makeImmutable();
  676.         return emails_;
  677.       }
  678.       /**
  679.        * repeated string emails = 3;
  680.        * @return The count of emails.
  681.        */
  682.       public int getEmailsCount() {
  683.         return emails_.size();
  684.       }
  685.       /**
  686.        * repeated string emails = 3;
  687.        * @param index The index of the element to return.
  688.        * @return The emails at the given index.
  689.        */
  690.       public java.lang.String getEmails(int index) {
  691.         return emails_.get(index);
  692.       }
  693.       /**
  694.        * repeated string emails = 3;
  695.        * @param index The index of the value to return.
  696.        * @return The bytes of the emails at the given index.
  697.        */
  698.       public com.google.protobuf.ByteString
  699.           getEmailsBytes(int index) {
  700.         return emails_.getByteString(index);
  701.       }
  702.       /**
  703.        * repeated string emails = 3;
  704.        * @param index The index to set the value at.
  705.        * @param value The emails to set.
  706.        * @return This builder for chaining.
  707.        */
  708.       public Builder setEmails(
  709.           int index, java.lang.String value) {
  710.         if (value == null) { throw new NullPointerException(); }
  711.         ensureEmailsIsMutable();
  712.         emails_.set(index, value);
  713.         bitField0_ |= 0x00000004;
  714.         onChanged();
  715.         return this;
  716.       }
  717.       /**
  718.        * repeated string emails = 3;
  719.        * @param value The emails to add.
  720.        * @return This builder for chaining.
  721.        */
  722.       public Builder addEmails(
  723.           java.lang.String value) {
  724.         if (value == null) { throw new NullPointerException(); }
  725.         ensureEmailsIsMutable();
  726.         emails_.add(value);
  727.         bitField0_ |= 0x00000004;
  728.         onChanged();
  729.         return this;
  730.       }
  731.       /**
  732.        * repeated string emails = 3;
  733.        * @param values The emails to add.
  734.        * @return This builder for chaining.
  735.        */
  736.       public Builder addAllEmails(
  737.           java.lang.Iterable<java.lang.String> values) {
  738.         ensureEmailsIsMutable();
  739.         com.google.protobuf.AbstractMessageLite.Builder.addAll(
  740.             values, emails_);
  741.         bitField0_ |= 0x00000004;
  742.         onChanged();
  743.         return this;
  744.       }
  745.       /**
  746.        * repeated string emails = 3;
  747.        * @return This builder for chaining.
  748.        */
  749.       public Builder clearEmails() {
  750.         emails_ =
  751.           com.google.protobuf.LazyStringArrayList.emptyList();
  752.         bitField0_ = (bitField0_ & ~0x00000004);;
  753.         onChanged();
  754.         return this;
  755.       }
  756.       /**
  757.        * repeated string emails = 3;
  758.        * @param value The bytes of the emails to add.
  759.        * @return This builder for chaining.
  760.        */
  761.       public Builder addEmailsBytes(
  762.           com.google.protobuf.ByteString value) {
  763.         if (value == null) { throw new NullPointerException(); }
  764.         checkByteStringIsUtf8(value);
  765.         ensureEmailsIsMutable();
  766.         emails_.add(value);
  767.         bitField0_ |= 0x00000004;
  768.         onChanged();
  769.         return this;
  770.       }
  772.       // @@protoc_insertion_point(builder_scope:Person)
  773.     }
  775.     // @@protoc_insertion_point(class_scope:Person)
  776.     private static final PersonOuterClass.Person DEFAULT_INSTANCE;
  777.     static {
  778.       DEFAULT_INSTANCE = new PersonOuterClass.Person();
  779.     }
  781.     public static PersonOuterClass.Person getDefaultInstance() {
  782.       return DEFAULT_INSTANCE;
  783.     }
  785.     private static final com.google.protobuf.Parser<Person>
  786.         PARSER = new com.google.protobuf.AbstractParser<Person>() {
  787.       @java.lang.Override
  788.       public Person parsePartialFrom(
  789.           com.google.protobuf.CodedInputStream input,
  790.           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
  791.           throws com.google.protobuf.InvalidProtocolBufferException {
  792.         Builder builder = newBuilder();
  793.         try {
  794.           builder.mergeFrom(input, extensionRegistry);
  795.         } catch (com.google.protobuf.InvalidProtocolBufferException e) {
  796.           throw e.setUnfinishedMessage(builder.buildPartial());
  797.         } catch (com.google.protobuf.UninitializedMessageException e) {
  798.           throw e.asInvalidProtocolBufferException().setUnfinishedMessage(builder.buildPartial());
  799.         } catch (java.io.IOException e) {
  800.           throw new com.google.protobuf.InvalidProtocolBufferException(e)
  801.               .setUnfinishedMessage(builder.buildPartial());
  802.         }
  803.         return builder.buildPartial();
  804.       }
  805.     };
  807.     public static com.google.protobuf.Parser<Person> parser() {
  808.       return PARSER;
  809.     }
  811.     @java.lang.Override
  812.     public com.google.protobuf.Parser<Person> getParserForType() {
  813.       return PARSER;
  814.     }
  816.     @java.lang.Override
  817.     public PersonOuterClass.Person getDefaultInstanceForType() {
  818.       return DEFAULT_INSTANCE;
  819.     }
  821.   }
  823.   private static final com.google.protobuf.Descriptors.Descriptor
  824.     internal_static_Person_descriptor;
  825.   private static final
  826.     com.google.protobuf.GeneratedMessage.FieldAccessorTable
  827.       internal_static_Person_fieldAccessorTable;
  829.   public static com.google.protobuf.Descriptors.FileDescriptor
  830.       getDescriptor() {
  831.     return descriptor;
  832.   }
  833.   private static  com.google.protobuf.Descriptors.FileDescriptor
  834.       descriptor;
  835.   static {
  836.     java.lang.String[] descriptorData = {
  837.       "\n\014person.proto"2\n\006Person\022\014\n\004name\030\001 \001(\t\022\n" +
  838.       "\n\002id\030\002 \001(\005\022\016\n\006emails\030\003 \003(\tb\006proto3"
  839.     };
  840.     descriptor = com.google.protobuf.Descriptors.FileDescriptor
  841.       .internalBuildGeneratedFileFrom(descriptorData,
  842.         new com.google.protobuf.Descriptors.FileDescriptor[] {
  843.         });
  844.     internal_static_Person_descriptor =
  845.       getDescriptor().getMessageTypes().get(0);
  846.     internal_static_Person_fieldAccessorTable = new
  847.       com.google.protobuf.GeneratedMessage.FieldAccessorTable(
  848.         internal_static_Person_descriptor,
  849.         new java.lang.String[] { "Name", "Id", "Emails", });
  850.     descriptor.resolveAllFeaturesImmutable();
  851.   }
  853.   // @@protoc_insertion_point(outer_class_scope)
  854. }
复制代码
执行

从上面编译出来的文件中可以找到这行注释// Protobuf Java Version: 4.31.1，表示protobuf对应java依赖的版本。

  • 在pom.xml中引入依赖
  1. <dependency>
  2.   <groupId>com.google.protobuf</groupId>
  3.   protobuf-java</artifactId>
  4.   <version>4.31.1</version>
  5. </dependency>
复制代码

  • java测试代码
  1. public static void main(String[] args) throws InvalidProtocolBufferException {
  2.     // 构造对象
  3.     PersonOuterClass.Person person = PersonOuterClass.Person.newBuilder()
  4.     .setName("Alice")
  5.     .setId(123)
  6.     .addEmails("alice@example.com")
  7.     .build();
  9.     // 序列化为字节数组
  10.     byte[] bytes = person.toByteArray();
  12.     // 反序列化
  13.     PersonOuterClass.Person parsedPerson = PersonOuterClass.Person.parseFrom(bytes);
  14.     System.out.println(parsedPerson.getName());
  15.     System.out.println(parsedPerson.getId());
  16.     System.out.println(parsedPerson.getEmails(0));
  18. }
复制代码

  • 执行结果
  1. Alice
  2. 123
  3. alice@example.com
复制代码
性能测试

protobuf和json的性能对比

此处对比protobuf、hutool的json工具类、jackson的性能

  • 引入依赖
  1. <dependency>
  2.   <groupId>org.junit.jupiter</groupId>
  3.   junit-jupiter-api</artifactId>
  4.   <version>5.8.2</version>
  5. </dependency>
  7. <dependency>
  8.   <groupId>org.openjdk.jmh</groupId>
  9.   jmh-core</artifactId>
  10.   <version>1.37</version>
  11. </dependency>
  13. <dependency>
  14.   <groupId>org.openjdk.jmh</groupId>
  15.   jmh-generator-annprocess</artifactId>
  16.   <version>1.37</version>
  17.   <scope>provided</scope>
  18. </dependency>
  21. <dependency>
  22.   <groupId>com.fasterxml.jackson.core</groupId>
  23.   jackson-databind</artifactId>
  24.   <version>2.15.2</version>
  25. </dependency>
  26. <dependency>
  27.   <groupId>com.fasterxml.jackson.core</groupId>
  28.   jackson-core</artifactId>
  29.   <version>2.15.2</version>
  30. </dependency>
  31. <dependency>
  32.   <groupId>com.fasterxml.jackson.core</groupId>
  33.   jackson-annotations</artifactId>
  34.   <version>2.15.2</version>
  35. </dependency>
  38. <dependency>
  39.   <groupId>cn.hutool</groupId>
  40.   hutool-all</artifactId>
  41.   <version>5.8.27</version>
  42. </dependency>
复制代码

  • 测试的pojo类
  1. public class PersonJson {
  3.     private String name;
  4.     private int id;
  5.     private String[] emails;
  7.     public String getName() {
  8.         return name;
  9.     }
  11.     public void setName(String name) {
  12.         this.name = name;
  13.     }
  15.     public int getId() {
  16.         return id;
  17.     }
  19.     public void setId(int id) {
  20.         this.id = id;
  21.     }
  23.     public String[] getEmails() {
  24.         return emails;
  25.     }
  27.     public void setEmails(String[] emails) {
  28.         this.emails = emails;
  29.     }
  30. }
复制代码

  • 测试代码
  1. package protobuf;
  3. import cn.hutool.json.JSONUtil;
  4. import com.fasterxml.jackson.core.JsonProcessingException;
  5. import com.fasterxml.jackson.databind.ObjectMapper;
  6. import org.openjdk.jmh.annotations.*;
  8. import java.io.IOException;
  10. @Warmup(iterations = 2, time = 1)
  11. @Measurement(iterations = 2, time = 1)
  12. @Fork(2)
  13. @State(Scope.Thread)
  14. public class ProtobufBenchmark {
  15.     private PersonOuterClass.Person person;
  16.     private byte[] serializedData;
  17.     private String jsonStr;
  19.     private PersonJson personJson;
  21.     private ObjectMapper objectMapper = new ObjectMapper();
  23.     @Setup
  24.     public void setup() {
  25.         person = PersonOuterClass.Person.newBuilder()
  26.                 .setName("Charlie")
  27.                 .setId(789)
  28.                 .addEmails("charlie@example.com")
  29.                 .build();
  30.         serializedData = person.toByteArray();
  32.         personJson = new PersonJson();
  33.         personJson.setName("Charlie");
  34.         personJson.setId(789);
  35.         personJson.setEmails(new String[]{"charlie@example.com"});
  37.         jsonStr = JSONUtil.toJsonStr(personJson);
  38.     }
  40.     /**
  41.      * 测试protobuf序列化
  42.      *
  43.      * @return
  44.      */
  45.     @Benchmark
  46.     public byte[] testSerialize() {
  47.         return person.toByteArray();
  48.     }
  50.     /**
  51.      * 测试protobuf反序列化
  52.      *
  53.      * @return
  54.      * @throws Exception
  55.      */
  56.     @Benchmark
  57.     public PersonOuterClass.Person testDeserialize() throws Exception {
  58.         return PersonOuterClass.Person.parseFrom(serializedData);
  59.     }
  61.     /**
  62.      * 测试hutool-json序列化
  63.      *
  64.      * @return
  65.      */
  66.     @Benchmark
  67.     public String testJsonSerialize() {
  68.         return JSONUtil.toJsonStr(personJson);
  69.     }
  71.     /**
  72.      * 测试hutool-json反序列化
  73.      *
  74.      * @return
  75.      */
  76.     @Benchmark
  77.     public PersonJson testJsonDeserialize() {
  78.         return JSONUtil.toBean(jsonStr, PersonJson.class);
  79.     }
  81.     /**
  82.      * 测试Jackson序列化
  83.      *
  84.      * @return
  85.      * @throws JsonProcessingException
  86.      */
  87.     @Benchmark
  88.     public String testJacksonSerialize() throws JsonProcessingException {
  89.         return objectMapper.writeValueAsString(personJson);
  90.     }
  92.     /**
  93.      * 测试Jackson反序列化
  94.      *
  95.      * @return
  96.      * @throws Exception
  97.      */
  98.     @Benchmark
  99.     public PersonJson testJacksonDeserialize() throws Exception {
  100.         return objectMapper.readValue(jsonStr, PersonJson.class);
  101.     }
  103. }
复制代码
运行结果
  1. Benchmark                                  Mode  Cnt         Score         Error  Units
  2. ProtobufBenchmark.testSerialize           thrpt    4  23652174.844 ± 1801935.493  ops/s
  3. ProtobufBenchmark.testDeserialize         thrpt    4   7830878.513 ± 2204277.060  ops/s
  4. ProtobufBenchmark.testJacksonSerialize    thrpt    4   5737731.097 ±  975288.754  ops/s
  5. ProtobufBenchmark.testJacksonDeserialize  thrpt    4   2806124.511 ±  396224.766  ops/s
  6. ProtobufBenchmark.testJsonSerialize       thrpt    4    256885.571 ±   42109.112  ops/s
  7. ProtobufBenchmark.testJsonDeserialize     thrpt    4    289602.156 ±   78181.194  ops/s
复制代码

  • protobuf序列化性能是jackson的4倍，反序列化性能也将近3倍
  • hutool的json性能就比较差了，所以实际项目中若要使用json，推荐使用jackson
小结

本文介绍了protobuf从安装到使用的全过程，并提供了相应的代码示例。读者可以通过直接运行代码示例直观的学习到protobuf如何使用。最后测试和对比了protobuf、json序列化和反序列化的性能。

来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

使用道具 举报
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 | 立即注册
发帖
肿抢
2025-8-1 20:18:36

0

粉丝关注

18

主题发布

板块介绍填写区域，请于后台编辑
微信扫一扫