Golang + Protobuf 构造通讯协议

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还的去下载编译安装配置了。

(完)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342

推荐阅读更多精彩内容