Unity的uLua库添加lua-pb实现网络通信

为什么要添加lua-pb模块？

Unity项目中需要使用protocol buffer作为网络通信的序列化格式。uLua本身包含了一些protobuf的处理模块，比如sproto，pblua等等。但是实测下来发现这些预置的模块或多或少都有些严重的缺陷，比较严重的有如下几条：

• 有的模块不支持default关键字
• 有的模块解析proto之后会生成一个lua文件，但是如果proto文件很长，生成出来的lua文件会由于local变量太多而解析出错。

这些问题导致现有的模块不能满足项目开发的需求，只能寻求第三方的解决方案。
lua-pb模块是一个开源的protobuf的lua解析模块，功能比较齐全。于是决定把lua-pb模块集成到uLua中，替换掉ulua本身的解析模块。

---

修改ulua

下载uLua

uLua的源码可以从https://github.com/jarjin/ulua_runtime_project这个git仓库里clone到。

下载struct

lua-pb依赖三个lua的扩展库，lpeg，luabitop和struct，前两个已经包含在了ulua中，只需添加struct支持即可。
struct是lua的一个c扩展库，为lua提供了c struct的支持。
struct的下载地址是http://www.inf.puc-rio.br/~roberto/struct/。

修改uLua工程

不同平台下需要分别编译ulua，至少需要编译windows，mac，ios和android平台的版本。uLua的源码仓库内有每个平台工程的详细文档，需要按照文档操作。
windows，mac，ios和android使用了不同的工程和编译工具链来编译，所以需要分别添加struct到对应的工程中。
下面截图是mac平台的例子，其它的工程类似。

mac工程

编译

mac版本使用xcode编译，编译出来的是一个bundle。将这个bundle替换工程中的Plugins目录下原来的uLua.bundle就可以了。
ios版本一样使用xcode编译，编译出来的是一个静态库，静态库中需要包含armv7和arm64两个CPU架构。使用编译出来的静态库替换掉Plugins/iOS目录下原来的libulua.a文件就可以了。
android版本使用ndk编译，需要编译v7a和x86两个版本，编译出来的是个.so的动态库。替换掉Plugins/Android/libs对应目录下的旧文件就可以了。
windows版本在msys环境下编译，msys的下载地址参照ulua编译文档里的说明。需要编译x86和x64两个版本，替换掉Plugins目录下对应的ulua.dll就可以了。

修改uLua的C#源码

LuaDLL.cs:112的LuaDLL类中添加

[DllImport(LUADLL, CallingConvention = CallingConvention.Cdecl)]
public static extern int luaopen_struct(IntPtr L);

LuaScriptMgr.cs:213中LuaScriptMgr的构造函数中添加

LuaDLL.luaopen_struct(lua.L);

---

使用lua-pb

假如有如下的message定义在proto文件中

package Protocol;
message LOGIN_RESULT()
{
    optional int32 cmd_id = 1 [default = 100];
    required int32 result = 2;
}

可以按照如下测试代码在lua中处理消息的序列化和反序列化。序列化之后的字节流一般通过socket发送给服务器。

funciton ProtoTest()
    -- 序列化
    local sendMsg = Protocol.LOGIN_RESULT()
    sendMsg.result = 100
    local bytes = sendMsg:Serialize()
    
    -- 反序列化
    local recvMsg = Protocol.LOGIN_RESULT()
    recvMsg:Parse(bytes)
    print("received result" ... recvMsg.result)
end

---

总结

在ulua中，添加第三方的lua的c语言扩展库是比较简单的，感谢ulua的开发者的工作。
添加lua-pb需要改写ulua的源代码，更改之后的ulua源代码也一并上传到了github上，地址是https://github.com/cooado/ulua_runtime_project，有需要可以直接参考源码工程。

---

补充说明

uLua一直在更新，目前推荐的版本是toLua#。本文的内容可能不直接适用，但是原理是类似的。

---

（全文完）