OpenResty搭建游戏服务器（三）使用 Protobuf

lua 的 protobuf 库 之前一直用的 云风的pbc ，一直用的很嗨皮。

但这个库好像已经不怎么维护了，而我想要的是支持 proto3。

最终我找到 lua-protobuf 这个库。
 

1、下载库并将 pb.c 和 pb.h 编译成 pb.so

git clone https://github.com/starwing/lua-protobuf
cd lua-protobuf
gcc -O2 -shared -fPIC pb.c -o pb.so

如果报错，fatal error: lua.h: No such file or directory
则要通过 gcc -I 来指定 头文件查找路径

gcc -O2 -shared -fPIC pb.c -o pb.so -I /usr/local/openresty/luajit/include/luajit-2.1

2、把需要的文件放入openresty中

    把 “用于对数据进行encode、decode” 的 pb.so 文件放入 openresty 的 luaclib 。
    把 “用于编译 .proto 文件” 的 protoc.lua 文件放入 openresty的 lualib。（可选）

3、准备具体业务要用的协议文件（.proto文件）

    这里，为了先跑通流程，只定义登录需要的协议（两个.proto 文件）。

//账户实体

syntax = "proto3";
package entity;

message Account {
    string username = 1;
    string password = 2;
}

//登录请求和返回消息

syntax = "proto3";
package msg;

import "entity/account.proto";

message Login_C {
    entity.Account account = 1;
}

message Login_S {
    bool result = 1;
}

4、加载注册

    有两种使用方式，如下：

1）、先通过 protobuf官方的 protoc 将 .proto文件 编译为二进制文件（ .pb 或 .bytes，后缀不重要，由自己指定）, 然后以读二进制方式读取该文件，进行加载注册。

  protoc 下载地址，可以选择win、osx 或 linux的版本。

目录结构：

  

编译指令:

protoc -I ./protos -o ./output/proto.pb ./protos/entity/account.proto ./protos/msg/login.proto 

注意看 文档 ，
  -I （或 --proto_path）用于指定 .proto 文件中的 import 的查找路径。如果不指定则默认为 protoc 的当前目录

  -o  用于指定 二进制文件的输出路径。

  最后是 .proto源文件，可以同时将多个 .proto文件 编译为一个二进制文件。（windows下的 proroc.exe 用 xxx/*.proto 时会报错：*.proto: No such file or directory。这可能是一个bug，可以改用低版本的proroc.exe，或用脚本将所有.proto文件遍历出来再执行）

local path = ngx.config.prefix() .. "app/protobuf/proto.pb"

local file, msg = io.open(path, "rb")
if file ~= nil then
    local buffer = file:read("*a")
    pb.load(buffer)
    file:close()
else
    ngx.log(ngx.ERR, "读取文件失败: ", msg)
    return
end

2）、直接以读字符串方式读取 .proto文件，进行加载注册。（这种方式不推荐使用）

local paths = {
    --文件列表...
}

local p = protoc.new()
p.unknown_module = function(self, module_name) end
p.unknown_type = function(self, type_name) end
p.include_imports = true

for i, path in ipairs(paths) do
    local file, msg = io.open(path, "r")
    if file ~= nil then
        local str = file:read("*a")
        p:load(str)
        file:close()
    else
        ngx.log(ngx.ERR, "读取文件失败: ", msg)
        return
    end
end

    不推荐使用的原因是，实际上，它是先用 自己实现的 protoc.lua 将 .proto 字符串 编译为 二进制，再用 pb.load进行加载注册的。和第一种方式相比，这种方式相当于将编译放到了运行时，效率较低。另一方面，我希望尽可能少的依赖第三方库的功能，让该库只负担起pb编码解码的作用（毕竟第三方库不是完全可靠）。还有就是，编译时需要指定 import 的查找路径，我在该库的文档中未找到相关操作方法，试了半天也没解决import路径问题。既然不打算用这种方式，我也不想将更多时间浪费在这上边了。

5、编码解码

local data = {
    account = {
        username = "NRatel",
        password = "000000"
    }
}

local bytes = assert(pb.encode("msg.Login_C", data))
ngx.say(pb.tohex(bytes))
local data2 = assert(pb.decode("msg.Login_C", bytes))
ngx.say(serpent.block(data2))

6、结果