golang二进制协议接口映射

原文链接：石匠1号的Blog

在写服务器程序时，特别是业务向的服务（比如游戏服务器），经常会遇到处理许多客户端协议的情况，如果是http服务，那么定义好处理接口，剩下的交给web服务器就可以了。但是二进制协议就没有这么方便了。

通常的自定义二进制协议规则都是固定长度消息头+变长消息体构成，在消息头中会有消息长度，消息id等字段。（基于TCP流式协议），服务器接收到客户端消息后，首先读取消息头，解析得到消息长度，再按照指定长度获取到完整的消息体的二进制数据。

在写具体业务逻辑时，需要面临从网络层获取到的原始数据，怎么映射到内存数据结构并调用相应处理接口的问题。前面所说的二进制消息体的格式多种多样，大家都有自己的做法，这里以protobuf为例，构建服务器端接收到原始数据后，通过消息id映射生成对应的protobuf结构体，并调用处理接口。

golang种有一个reflect包，可以对类型进行反射，动态生成相应结构体，具体做法就是，将protobuf消息结构通过interface类型和消息id注册到一个自定义map中，在map中保存结构体的类型，具体如下：

type MessageHandler func(msgid uint16, msg interface{})

type MessageInfo struct {
    msgType    reflect.Type
    msgHandler MessageHandler
}

var (
    msg_map = make(map[uint16]MessageInfo)
)

func RegisterMessage(msgid uint16, msg interface{}, handler MessageHandler) {
    var info MessageInfo
    info.msgType = reflect.TypeOf(msg.(proto.Message))
    info.msgHandler = handler
    msg_map[msgid] = info
}

然后从底层网络获取到原始二进制协议数据后，通过消息id在map中找到对应的类型信息并动态创建出结构体类型来解析二进制数据，具体如下：

func HandleRawData(msgid uint16, data []byte) error {
    if info, ok := msg_map[msgid]; ok {
        msg := reflect.New(info.msgType.Elem()).Interface()
        err := proto.Unmarshal(data, msg.(proto.Message))
        if err != nil {
            return err
        }
        info.msgHandler(msgid, msg)
        return err
    }
    return errors.New("not found msgid")
}

这里利用了reflect的反射机制，动态获取类型并创建了protobuf结构体，然后通过proto.Umarshal接口解析二进制消息体，最后调用msgHandler进行处理。这里的msgHandler是一个消息处理接口类型，每个消息都按照规范定义自己的处理函数，在程序启动的时候将消息，protobuf结构体和处理函数都统一注册，如下：

const (
    MsgID_Test1 = iota
    MsgID_Test2
)

func MessageHandler_Test1(msgid uint16, msg interface{}) {
    p := msg.(*pb.MsgTest1)
    fmt.Println("message handler msgid:", msgid, " body:", p)
}

func MessageHandler_Test2(msgid uint16, msg interface{}) {
    p := msg.(*pb.MsgTest2)
    fmt.Println("message handler msgid:", msgid, " body:", p)
}

func RegistMsg() {
    RegisterMessage(MsgID_Test1, &pb.MsgTest1{}, MessageHandler_Test1)
    RegisterMessage(MsgID_Test2, &pb.MsgTest2{}, MessageHandler_Test2)
}

此处注册函数使用的是protobuf消息体的指针类型，所以reflect类型反射的时候，需要通过类型的Elem()函数得到指针的基类型，再动态创建类型。

这样处理之后，每次新增协议只需要在RegistMsg函数里面新加一行即可，不需要每个协议再单独处理二进制协议转换，结构体映射等重复而繁杂的事情。

代码在： https://github.com/pertgame/gmsg-framework