Golang + Protobuf 构造通讯协议

Posted 2021-04-11 Golang语言社区

Golang 用于写网络通讯非常方便，其中消息通讯就可能会用到跨语言的Protobuf。本文讲述如何使用Protobuf构造Golang的通讯协议。

（1）Protobuf需要protoc，这个只要在github下载编译即可安装。Debian系也可以通过apt来安装。
（2）第二个是go的插件，这个同样下载源代码后，执行go build 和 go install就能安装在$GOPATH路径下面，然后把该文件夹加入$PATH就可以使用了。
（3）撰写proto文件，详情请参考官方文档。看起来是这样样子的：

// poster.proto
package poster;

message Mail {
    required bytes type = 1;
    required bytes md5 = 2;
    required bytes path = 3;
}

以上是我在socket中用到的消息格式，分别定义消息的type，md5的值， path路径还有文件的大小，就可以用于接下来的md5检验，续传功能，还有根据消息类型来自定义不同的信号。这里使用bytes不是必须的，只是我在我的代码里面会分别定义各个字段的长度，byte对于我更直观。

然后，就是将它变成golang的一个库import到自己的代码里，生成的命令是：

protoc --go_out=. poster.proto

然后我就会得到一个poster.pb.go的文件，随后我就可以在我的代码里import这个库了。但这个库只是提供了定义格式和读取信息的功能。要去将信息打包成protobuf或解包还需要另外一个库去支持，可以通过以下命令来达成：

go get github.com/golang/protobuf/proto

关于最基本的Marshal和Unmarshal方法我就不做解释了，但这里粘出struct和protoc配合使用的例子，不过不要复制粘贴，这里有一个utils的库是自己写的，主要是把int64转成byte的方法。另外请注意因为我定在proto文件里义了三个字段都是byte类型，所以我会先将原有的类型转化成byte类型，但struct里则是合适的类型方便调用：

// 这里定义长度主要是因为socket通讯等消息包假设采用固定长度来接收
const (
    typeSize   = 8
    md5Size    = 32
    pathSize   = 80
    bufferSize = 126
)

type msgBuffer struct {
    bufType  int
    bufMd5   string
    bufPath  string
}
// 
func (msgBuf *msgBuffer) NewMsg() []byte {

    bufType := make([]byte, typeSize)
    bufMd5 := make([]byte, md5Size)
    bufPath := make([]byte, pathSize)

    copy(bufType, utils.Int64ToByte(int64(msgBuf.bufType)))
    copy(bufMd5, []byte(msgBuf.bufMd5))
    copy(bufPath, []byte(msgBuf.bufPath))

    dataText := &poster.Mail {
        Type: bufType,
        Md5 : bufMd5,
        Path: bufPath,
    }

    data, err := proto.Marshal(dataText)
    checkError(err)
    return data
}

这个data就是可以随便传输的byte array了。最后接收方如下所示，就能将消息解包并且友好地调用了。（注意utils.FirstNull会自动截取从第一个byte开始连续的到最后一个对应的ASCII非0的字符段，因为假如设定了固定长度，而value的长度没有那么长，就会填null）。

func msgParser(data []byte) *msgBuffer {
    dataText := &poster.Mail{}
    err := proto.Unmarshal(data, dataText)
    checkError(err)

    msgType := utils.ByteToInt64(dataText.GetType())
    msgMd5 := string(dataText.GetMd5())
    msgPath := string(dataText.GetPath()[:utils.FirstNull(dataText.GetPath())])

    msg := &msgBuffer{int(msgType), msgMd5, msgPath}
    return msg
}

整个流程很简单，最麻烦的地方大概就是protobuf用出来并非那么方便。

（完）

本文来自：

查看原文：