Protobuf 入门级指南(谷歌的序列化框架，类似json，但更快 ...

syntax = "proto3"; // PB协议版本

import "google/protobuf/any.proto"; // 引用外部的message，可以是本地的，也可以是此处比较特殊的 Any

option java_package = "com.didispace.web"; // 生成类的包名，注意：会在指定路径下按照该包名的定义来生成文件夹
option java_outer_classname="PersonTestProtos"; // 生成类的类名，注意：下划线的命名会在编译的时候被自动改为驼峰命名

message PersonTest {
    int32 id = 1; // int 类型
    string name = 2; // string 类型
    string email = 3;
    Sex sex = 4; // 枚举类型
    repeated PhoneNumber phone = 5; // 引用下面定义的 PhoneNumber 类型的 message repeated的含义是这里可以放多个PhoneNumber，相当于list
    map<string, string> tags = 6; // map 类型
    repeated google.protobuf.Any details = 7; // 使用 google 的 any 类型

    // 定义一个枚举
    enum Sex {
        DEFAULT = 0;
        MALE = 1;
        Female = 2;
    }

    // 定义一个 message
    message PhoneNumber {
        string number = 1;
        PhoneType type = 2;

        enum PhoneType {
            MOBILE = 0;
            HOME = 1;
            WORK = 2;
        }

    }

}

protoc -I=./ --java_out=./ ./ProtobufTest.proto

package com.didispace.web;

import com.google.protobuf.ByteString;
import com.google.protobuf.InvalidProtocolBufferException;
import com.googlecode.protobuf.format.JsonFormat;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;

/**
* @ClassName: ProtobufTest
* @Description: ProtoBuf 测试
**/
public class ProtobufTest {

    public static void main(String[] args) {
        try {
            /** Step1：生成 personTest 对象 */
            // personTest 构造器
            PersonTestProtos.PersonTest.Builder personBuilder = PersonTestProtos.PersonTest.newBuilder();
            // personTest 赋值
            personBuilder.setName("yizhiyuan");
            personBuilder.setEmail("test@gmail.com");
            personBuilder.setSex(PersonTestProtos.PersonTest.Sex.MALE);

            // 内部的 PhoneNumber 构造器
            PersonTestProtos.PersonTest.PhoneNumber.Builder phoneNumberBuilder = PersonTestProtos.PersonTest.PhoneNumber.newBuilder();
            // PhoneNumber 赋值
            phoneNumberBuilder.setType(PersonTestProtos.PersonTest.PhoneNumber.PhoneType.MOBILE);
            phoneNumberBuilder.setNumber("17717037257");

            // personTest 设置 PhoneNumber
            personBuilder.addPhone(phoneNumberBuilder);

            // 生成 personTest 对象
            PersonTestProtos.PersonTest personTest = personBuilder.build();

            //查看生成的personTest对象
            System.out.println("生成的personTest对象" + personTest.toString());

            // 粘包,将一个或者多个protobuf 对象字节写入 stream
            // 序列化
            ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
            personTest.writeDelimitedTo(byteArrayOutputStream);

            // Step2：反序列化，从 steam 中读取一个或者多个 protobuf 字节对象
            ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream(byteArrayOutputStream.toByteArray());
            PersonTestProtos.PersonTest personTestResult = PersonTestProtos.PersonTest.parseDelimitedFrom(byteArrayInputStream);
            System.out.println(String.format("反序列化得到的信息，姓名：%s，性别：%d，手机号：%s,邮箱:%s",
                    personTestResult.getName(), personTest.getSexValue(), personTest.getPhone(0).getNumber(),
                    personTest.getEmail()));

            // Step3：protobuf 对象与json的相互转换，有时候我们与第三方系统可能要使用json
            // 将personTest 对象转换为json
            Strin json =  JsonFormat.printToString(personTest);
            System.out.println("对象转换为string后："+JsonFormat.printToString(personTest));

            //将json反序列化为protobuf对象
            PersonTestProtos.PersonTest.Builder personBuilderForJson = PersonTestProtos.PersonTest.newBuilder();
            JsonFormat.merge(json,personBuilderForJson);
            System.out.println("json 反序列化为对象："+ personBuilderForJson.build().toString());
        } catch (InvalidProtocolBufferException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }

    }

}