Protobuf的使用

Posted 2022-09-09 kuronjq

Protobuf使用

最近写了些pb，来代替json，pb的特点就是小，简单，序列化快一点之类的，可用于通讯协议和数据存储等领域。

在做微服务的时候，先把业务拆分成独立完整的功能，从原来的模块里分离出来，然后定义pb，再通过脚本或者插件（需要protoc编译）生成java的类，pb生成的类可能就很大，不过我们不用关心，因为你不需要打开生成的java，只需要通过pb去了解它，然后通过ClassName.InnerClassName去找到你要的类。

比如: 具体参考官方文档https://developers.google.cn/protocol-buffers/docs/proto3

syntax = "proto3";

package outer.user;

import "common/errcode.proto";
import "google/protobuf/any.proto";

// true的话会分解类，false的话message、service、enum都会在一个类里
option java_multiple_files = true;
option java_package = "xx.xx.user";
option java_outer_classname = "User";

enum ErrorCode 
    // 枚举第一个要=0
    FAIL = 0;
    SUCCESS = 1;


message UserSearchReq 
    string user_id = 1;


message UserSearchResp 
    // 这里的1、2并不是值，可以理解为下标
    ErrorCode status = 1;
    string id = 2;
    string user_name = 3;
    // ....
 

// just for example
message Example 
    map<string, google.protobuf.Any> map = 1;
    stirng id = 2;
    int32 age = 3;
    // 转成java就是List
    repeated string card = 4；
    // ....


service UserXxxService 
    // 查询用户，相当于接口里的方法
    rpc UserSearch (UserSearchReq) returns (UserSearchResp);


// ....

推荐每个方法一个req和resp，比较清晰。

如何在代码里使用呢？

pb生成的类是通过类对应的builder去创建的，这个就是建造者模式的应用，创建的过程类似:

User.UserSearchReq.newBuilder().setUserId("1").build();

之后就是实现接口，注册服务，让别的模块去调用。