Quick-Cocos2dx-Community 中的 protoc-gen-lua 使用说明

背景

google的黑科技protobuffer开源以后，在游戏的客户端与服务器通讯中得到了广泛的应用。但是官方一直没有提供lua的支持。

protoc-gen-lua 是最早实现pb for lua的项目。不过原作者很久没维护了，历时遗留的嵌套问题也没有去合并社区的修正方案。风云的pbc项目也是lua的protobuffer解决方案之一，但是它的用户接口与官方用法差异较大。

两种方案各有优势，Quick-Cocos2dx-Community 选择集成 protoc-gen-lua， 最重要的一点还是与Google官方pb用法规范上保持较好的一致性，这更有利于pb其它版本的老司机转到lua pb的使用上来，也有利于自定义需求的修改。

版本说明

Quick-Cocos2dx-Community 从 3.6.4开始集成 protoc-gen-lua 方案，并做以下修正：

1. 修正了 protoc-gen-lua 嵌套问题。
2. 添加通过message:DescriptorType()获取子类的真实名称。
3. 修正main function has more than 200 local variables错误。

对应的protobuffer版本为2.6.1。

protoc-gen-lua-mac.zip

protoc-gen-lua-win32.zip

安装

1. 安装Python 2.x, Windows下请安装32位的python。
2. 如果已通过pip安装了protobuffer的python插件，请先卸载掉，以保证版本匹配。
3. 解压protoc-gen-lua.zip，进入python目录. 启动控制台，运行python setup.py install，安装protobuffer的python包。

zip包自带了protobuf-2.6.1编译后的"compiler"，并以放置在python插件目录下，以保证python插件安装成功。

proto 转化为 lua

protoc-gen-lua是以插件的形式，配合google官方的protoc来实现.proto文件转换为lua文件，引擎中只需要转换出来lua文件，配合runtime进行编解码。

定义的.proto文件全部放在proto下，然后双击运行buildproto.bat，对应的lua文件生成在output目录下。

如RoomInfo.proto生成RoomInfo.lua。

引擎中的使用

把"GetRoom_pb.lua"、"ResultInfo_pb.lua"、"RoomInfo_pb.lua"拷贝到src/app/pb文件夹。

引用

require "pb"
require("app.pb.ResultInfo_pb")
require("app.pb.RoomInfo_pb")
require("app.pb.GetRoom_pb")

序列化与反序列化测试

    --序列化GetRoomRequest---------------------------------------
    local roomIdList = {1,2,3}
    local getRoomRequest = GetRoom_pb.GetRoomRequest()--#pbTips
    --循环体
    table.foreach(roomIdList, function(roomId)
        --房间编号
        table.insert(getRoomRequest.roomId,roomId)
    end)
    local data = getRoomRequest:SerializeToString()

    --反序列化GetRoomRequest
    local getRoomRequestPaser = GetRoom_pb.GetRoomRequest()--#pbTips
    getRoomRequestPaser:ParseFromString(data)
    dump(getRoomRequestPaser)


    --序列化GetRoomResponse----------------------------------------
    local getRoomResponse = GetRoom_pb.GetRoomResponse()
    getRoomResponse.result = ResultInfo_pb.SUCCESS
    --循环的嵌套消息
    for i=1,2 do
        local room = getRoomResponse.room:add()
        room.id = "1000"..i
        room.name = "小黑屋-"..i
        room.taskType = RoomInfo_pb.MAINLINE
    end
    local data = getRoomResponse:SerializeToString()

    --反序列化GetRoomResponse
    local getRoomResponsePaser = GetRoom_pb.GetRoomResponse()
    getRoomResponsePaser:ParseFromString(data)
    -- dump(getRoomResponsePaser)
    -- dump(getRoomResponsePaser.room)
    local room1 = getRoomResponsePaser.room[1]
    dump(room1)
    local room2 = getRoomResponsePaser.room[2]
    dump(room2)