protobuf序列化和反序列化

1. 新建Maven项目

2. 引入pom

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>protobuff-parser</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <protobuf-maven-plugin.version>0.5.1</protobuf-maven-plugin.version>
        <protoc.version>3.5.1-1</protoc.version>
        <grpc.version>1.13.1</grpc.version>
        <protobuf.version>3.6.0</protobuf.version>
    </properties>

    <dependencies>
        <!--protobuf相关-->
        <dependency>
            <groupId>com.google.protobuf</groupId>
            <artifactId>protobuf-java</artifactId>
            <version>${protobuf.version}</version>
        </dependency>
        <dependency>
            <groupId>com.google.protobuf</groupId>
            <artifactId>protobuf-java-util</artifactId>
            <version>${protobuf.version}</version>
        </dependency>
        <!--protobuf相关end-->
    </dependencies>


    <build>
        <extensions>
            <extension>
                <groupId>kr.motd.maven</groupId>
                <artifactId>os-maven-plugin</artifactId>
                <version>1.5.0.Final</version>
            </extension>
        </extensions>


        <plugins>
            <plugin>
                <groupId>org.xolstice.maven.plugins</groupId>
                <artifactId>protobuf-maven-plugin</artifactId>
                <version>${protobuf-maven-plugin.version}</version>
                <configuration>
                    <protocArtifact>com.google.protobuf:protoc:${protoc.version}:exe:${os.detected.classifier}</protocArtifact>
                    <pluginId>grpc-java</pluginId>
                    <pluginArtifact>io.grpc:protoc-gen-grpc-java:${grpc.version}:exe:${os.detected.classifier}</pluginArtifact>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>compile</goal>
                            <goal>compile-custom</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

3. 编写proto

addressbook.proto

syntax = "proto3";

package tutorial;

message Person {
  string username = 1;
  string phone = 2;
  string email = 3;
  enum Gender {
    MALE = 0;
    FEMALE = 1;
    OTHER = 2;
  }
  Gender gender = 4;
}

message AddressBook {
  repeated Person people = 1;
}

编写的proto文件放src/main/proto中

3. 序列化

package org.example;


import tutorial.Addressbook;

import java.io.*;

public class AddressBookSerializer {

    // 主函数：硬编码数据并执行序列化操作。
    public static void main(String[] args) throws Exception {
        Addressbook.AddressBook.Builder addressBook = Addressbook.AddressBook.newBuilder();

        // 添加一个人员信息（硬编码数据）。
        Addressbook.Person person1 = Addressbook.Person.newBuilder()
                .setUsername("Alice")
                .setPhone("1234567890")
                .setEmail("alice@example.com")
                .setGender(Addressbook.Person.Gender.FEMALE)
                .build();

        addressBook.addPeople(person1);

        // 将地址簿写入字节数组。
        byte[] serializedData = addressBook.build().toByteArray();

        // 将字节数组写入文件。
        String addressBookFile = "addressbook.dat";
        FileOutputStream output = new FileOutputStream(addressBookFile);
        output.write(serializedData);
        output.close();

        System.out.println("序列化成功，数据已写入 " + addressBookFile);
    }
}

4. 反序列化

package org.example;

import tutorial.Addressbook;

import java.io.*;
import java.nio.file.Files;
import java.nio.file.Paths;

public class AddressBookDeserializer {

    // 主函数：从文件中读取字节数组并执行反序列化操作。
    public static void main(String[] args) throws Exception {
        String addressBookFile = "addressbook.dat";
        // 从文件中读取字节数组并反序列化AddressBook
        byte[] serializedData = Files.readAllBytes(Paths.get(addressBookFile));
        Addressbook.AddressBook addressBook = Addressbook.AddressBook.parseFrom(serializedData);
        // 处理addressBook对象
        // 打印地址簿信息。
        for (Addressbook.Person person : addressBook.getPeopleList()) {
            System.out.println("用户名: " + person.getUsername());
            System.out.println("手机号: " + person.getPhone());
            if (!person.getEmail().isEmpty()) {
                System.out.println("电子邮件: " + person.getEmail());
            }
            System.out.println("性别: " + person.getGender());
            System.out.println();
        }
    }
}

5. 项目结构

项目地址（parser分支）：

https://gitee.com/javadage/protobuff-parser

https://github.com/JavaSqh/protobuff-parser.git

有任何问题请在下方留言。