消息包处理
gtcp
模块提供了简单轻量级数据交互协议,效率非常高,协议格式如下:
- 数据长度:默认为
16位
(2字节
),用于标识该消息体的数据长度,单位为字节,不包含自身的2字节; - 数据字段:变长,根据数据长度可以知道,数据最大长度不能超过
0xFFFF = 65535 bytes = 64 KB
;
简单协议由gtcp
封装实现,如果开发者客户端和服务端如果都使用gtcp
模块来通信则无需关心协议实现,专注数据
字段封装/解析实现即可。如果涉及和其他开发语言对接,则需要按照该协议实现对接即可,由于简单协议非常简单轻量级,因此对接成本很低。
https://godoc.org/github.com/gogf/gf/net/gtcp
type Conn
func (c *Conn) SendPkg(data []byte, option ...PkgOption) error
func (c *Conn) SendPkgWithTimeout(data []byte, timeout time.Duration, option ...PkgOption) error
func (c *Conn) SendRecvPkgWithTimeout(data []byte, timeout time.Duration, option ...PkgOption) ([]byte, error)
func (c *Conn) RecvPkg(option ...PkgOption) (result []byte, err error)
func (c *Conn) RecvPkgWithTimeout(timeout time.Duration, option ...PkgOption) ([]byte, error)
可以看到,消息包方法命名是在原有的基本连接操作方法中加上了Pkg
关键词便于区分。
// 数据读取选项
type PkgOption struct {
HeaderSize int // 自定义头大小(默认为2字节,最大不能超过4字节)
MaxDataSize int // (byte)数据读取的最大包大小,默认最大不能超过2字节(65535 byte)
Retry Retry // 失败重试策略
}
这个示例比较简单,执行后,输出结果为:
receive: [50]
receive: [51]
...
大多数场景下,我们需要对发送的消息能自定义数据结构,开发者可以利用数据
字段传递任意的消息内容实现。
以下是一个简单的自定义数据结构的示例,用于客户端上报当前主机节点的内存及CPU使用情况,示例代码位于:
在该示例中,数据
字段使用了JSON
数据格式进行自定义,便于数据的编码/解码。
实际场景中,开发者往往需要自定义包解析协议,或者采用较通用的
protobuf
二进制包封装/解析协议。
-
数据结构定义。
package types import "github.com/gogf/gf/frame/g" type NodeInfo struct { Cpu float32 // CPU百分比(%) Host string // 主机名称 Ip g.Map // IP地址信息(可能多个) MemUsed int // 内存使用(byte) MemTotal int // 内存总量(byte) Time int // 上报时间(时间戳) }
gtcp_monitor_server.go
服务端。
gtcp_monitor_client.go
客户端。
package main import ( "encoding/json" "github.com/gogf/gf/frame/g" "github.com/gogf/gf/net/gtcp" "github.com/gogf/gf/os/glog" "github.com/gogf/gf/os/gtime" "github.com/gogf/gf/geg/net/gtcp/pkg_operations/monitor/types" ) func main() { // 数据上报客户端 conn, err := gtcp.NewConn("127.0.0.1:8999") if err != nil { panic(err) } defer conn.Close() // 使用JSON格式化数据字段 info, err := json.Marshal(types.NodeInfo{ Cpu : float32(66.66), Host : "localhost", Ip : g.Map { "etho" : "192.168.1.100", "eth1" : "114.114.10.11", }, MemUsed : 15560320, MemTotal : 16333788, Time : int(gtime.Timestamp()), }) if err != nil { panic(err) } // 使用 SendRecvPkg 发送消息包并接受返回 if result, err := conn.SendRecvPkg(info); err != nil { if err.Error() == "EOF" { glog.Println("server closed") } } else { glog.Println(string(result)) } }
- 执行后
- 客户端输出结果为: