Skynet 服务器开发（四）使用pbc(protobuf)

最新推荐文章于 2024-04-29 15:43:21 发布

省粮

最新推荐文章于 2024-04-29 15:43:21 发布

阅读量1k

点赞数

分类专栏： skynet

skynet 专栏收录该内容

5 篇文章 0 订阅

订阅专栏

引言：

假如我们要建立的skynet服务器与客户端的连接方式为长连接，且选择了Google的Protobuf来定制我们的网络协议，那么，接下来我们要解决的问题就是：如何在skynet框架中使用socket+protobuf。

API

几个常用的skynet接口：

* 输出错误信息： skynet.error(...)
* 获取本地服务句柄方式： skynet.localname(...)
* 设置定时器方式： skynet.timeout(...)
* skynet强制退出方式： skyname.abort()
* 服务开始方式： skynet.start(...)
* 服务注销方式： skynet.exit()
* 发送原始文本消息方式： skynet.core.send(...)

更多skynet.lua的API解析可以参考：skynet API：skynet.lua

protobuf在skynet中使用：

一、 linux 环境安装protobuf

$ sudo apt-get install protobuf-c-compiler protobuf-compiler

输入protoc --version
libprotoc 2.5.0

二、安装protobuf环境，安装步骤如下：

1. 下载protobuf

protobuf下载页面 https://github.com/protocolbuffers/protobuf/releases/tag/v2.5.0
在此页面选择合适的版本，我选择的是最新的2.5.0

2. 解压

tar -zxf protobuf-2.5.0.tar.gz

3. 跳转到解压后的目录

cd protobuf-2.5.0

4. 设置编译目录

./configure --prefix=/usr/local/protobuf
/usr/local/protobuf/ 为自己配置的编译安装目录

5. 安装

还是在解压的目录下进行

make

make check
make install

6. 配置环境变量

sudo vim .bash_profile

7. 添加配置文件

export PROTOBUF=/usr/local/protobuf
export PATH=$PROTOBUF/bin:$PATH

PS: 如果第七步数据保存不了可以先切换到root 用户进行保存

sudo -i

8. 使配置文件生效

source .bash_profile

9. 测试安装结果

输入protoc --version
看到如下结果表示安装成功：

~ maerfeifei$ protoc --version
libprotoc 3.5.0

二、使用pbc动态proto解析库

由于protobuf的lua版本的支持存在着部分缺陷，为了避免踩坑，这里我们直接使用云风博客中推荐的pbc动态proto解析库。

1、资源下载：

下载pbc：跟下载skynet源码一样，通过git将pbc的源码克隆到本地：

$ cd skynet/3rd/
$ git clone https://github.com/cloudwu/pbc.git

Cloning into 'pbc'...
remote: Counting objects: 1156, done.
remote: Total 1156 (delta 0), reused 0 (delta 0), pack-reused 1156
Receiving objects: 100% (1156/1156), 302.95 KiB | 310.00 KiB/s, done.
Resolving deltas: 100% (682/682), done.
Checking connectivity... done.

编译并合入项目：

2、项目编译：
可以在pbc根目录下运行make指令编译项目：

linsh@ubuntu:/application/pbc$ sudo make
cd build && ar rc libpbc.a ../build/o/context.o ../build/o/varint.o ../build/o/array.o ../build/o/pattern.o ../build/o/register.o ../build/o/proto.o ../build/o/map.o ../build/o/alloc.o ../build/o/rmessage.o ../build/o/wmessage.o ../build/o/bootstrap.o ../build/o/stringpool.o ../build/o/decode.o
cd build && gcc -O2 -fPIC -Wall -I.. -L. -o addressbook ../test/addressbook.c -lpbc
cd build && gcc -O2 -fPIC -Wall -I.. -L. -o pattern ../test/pattern.c -lpbc
cd build && gcc -O2 -fPIC -Wall -I.. -L. -o pbc ../test/pbc.c -lpbc
cd build && gcc -O2 -fPIC -Wall -I.. -L. -o float ../test/float.c -lpbc
cd build && gcc -O2 -fPIC -Wall -I.. -L. -o map ../test/map.c -lpbc
cd build && gcc -O2 -fPIC -Wall -I.. -L. -o test ../test/test.c -lpbc
cd build && gcc -O2 -fPIC -Wall -I.. -L. -o decode ../test/decode.c -lpbc
protoc -obuild/addressbook.pb test/addressbook.proto
protoc -obuild/descriptor.pb test/descriptor.proto
protoc -obuild/float.pb test/float.proto
protoc -obuild/test.pb test/test.proto

3、修改LUADIR

protobuf 需要找到lua5.3的目录，skynet 本身就包含了lua5.3，所以指定到正确的目录skynet/3rd/lua

将pbc/binding/lua53/makefile中的LUADIR改为../../../lua

4、修改CFLAGS

在 pbc/binding/lua53/makefile 的变量 CFLAGS 中加入 -undefined dynamic_lookup

防止出错 Undefined symbols for architecture x86_64:，源文件中是没有这个选项的，虽然在后面的用例中可以正常的执行，但可能这不一定是好的方案。

5、工具编译：
用终端进入pbc项目pbc/binding/lua53目录下面编译出protobuf.so：

cd pbc/binding/lua53
sudo make

linsh@ubuntu:/application/pbc/binding/lua$ sudo make
gcc -O2 -fPIC -Wall -shared -o protobuf.so -I../.. -I/usr/local/src/lua-5.3.0/src -L../../build pbc-lua.c -lpbc
linsh@ubuntu:/application/pbc/binding/lua$ ls
build_ios.sh Makefile parser.lua pbc-lua.c protobuf.lua protobuf.so README.md test2.lua test.lua testparser.lua

可以看到多出了一个protobuf.so输出文件。

6、整合protobuf.so 和protobuf.lua 到pbc中

编译成功的话，将protobuf.so放在config文件中lua_cpath项配置的目录下面，同时将protobuf.lua放在config文件lua_path配置的目录下，就可以调用protobuf中的库方法。我当前项目这两项的配置如下：

lua_path = root.."lualib/?.lua;"..root.."lualib/?/init.lua"
lua_cpath = root .. "luaclib/?.so"

则移动文件命令可以如下：

sudo cp protobuf.so /application/skynet/luaclib
sudo cp protobuf.lua /application/skynet/lualib

三、测试

1、生成proto文件

先在项目根目录下创建一个protos文件夹，用来存放协议文件，创建一个Person.proto协议文件，内容如下：

sudo mkdir protos
cd protos
sudo vi Person.proto

协议文件的内容如下：

packae cs;
message Person {
required string name = 1;
required int32 id = 2; // Unique ID number for this person.
optional string email = 3;
enum PhoneType {
MOBILE = 0;
HOME = 1;
WORK = 2;
}
message PhoneNumber {
required string number = 1;
optional PhoneType type = 2 [default = HOME];
}
repeated PhoneNumber phone = 4;
}

2、将协议文件导出为.pb格式：

linsh@ubuntu:/application/skynet/protos$ sudo protoc --descriptor_set_out Person.pb Person.proto
linsh@ubuntu:/application/skynet/protos$ ls
Person.pb Person.proto

目录下多出了一个对应的.pb文件。

3、使用.pb 文件

在lua中注册对应的协议文件：

引入protobuf.lua：

local pb = require "protobuf"

注册.proto协议文件所对应的.pb文件，注册方法有两种：

方法一：直接注册文件：

pb.register_file "Person.pb"

方法二：通过io读取文件，然后再获取文本内容进行注册：

file = io.open("Person.pb","rb")
buffer = file:read "*a"
file:close()
pb.register(buffer)

4、完整用例
通过 encode 和 decode 两个接口来实现编码和解码，完整测试脚本：

local skynet = require "skynet"
local protobuf = require "protobuf"

skynet.start(function()
protobuf.register_file "./protos/Person.pb"
skynet.error("注册协议文件：Person.pb")
stringbuffer = protobuf.encode("cs.Person",
{
name = "linsh",
id = 1,
})
local data = protobuf.decode("cs.Person",stringbuffer)
skynet.error("数据编码：name="..data.name..",id="..data.id)
end)

运行正确的结果：

[:0100000c] 注册协议文件：Person.pb
[:0100000c] 数据编码：name=linsh,id=1

除外，云风还自定义了一套协议格式sproto，据说比protobuf还要简单。

参考：

cocos2dx和skynet通信
lua-protobuf 使用说明
lua pbc
pbc/binding/lua/README.md
skyne use pbc protobuf
---------------------
作者：河乐不为
来源：CSDN
原文：https://blog.csdn.net/linshuhe1/article/details/70186603
版权声明：本文为博主原创文章，转载请附上博文链接！