引言:
假如我們要建立的skynet伺服器與客戶端的連線方式為長連線,且選擇了Google的Protobuf來定製我們的網路協議,那麼,接下來我們要解決的問題就是:如何在skynet框架中使用socket+protobuf。
API幾個常用的skynet介面:
* 輸出錯誤資訊: skynet.error(...)* 獲取本地服務控制代碼方式: skynet.localname(...)* 設定定時器方式: skynet.timeout(...)* skynet強制退出方式: skyname.abort()* 服務開始方式: skynet.start(...)* 服務登出方式: skynet.exit()* 傳送原始文字訊息方式: skynet.core.send(...)
protobuf在skynet中使用:由於protobuf的lua版本的支援存在著部分缺陷,為了避免踩坑,這裡我們直接使用雲風部落格中推薦的pbc動態proto解析庫。
資源下載:下載pbc:跟下載skynet原始碼一樣,透過git將pbc的原始碼克隆到本地:
bogon:project linshuhe$ git clone https://github.com/cloudwu/pbc.gitCloning into 'pbc'...remote: Counting objects: 1156, done.remote: Total 1156 (delta 0), reused 0 (delta 0), pack-reused 1156Receiving objects: 100% (1156/1156), 302.95 KiB | 310.00 KiB/s, done.Resolving deltas: 100% (682/682), done.Checking connectivity... done.
編譯併合入專案:
專案編譯:可以在pbc根目錄下執行make指令編譯專案:
linsh@ubuntu:/application/pbc$ sudo makecd 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.ocd build && gcc -O2 -fPIC -Wall -I.. -L. -o addressbook ../test/addressbook.c -lpbccd build && gcc -O2 -fPIC -Wall -I.. -L. -o pattern ../test/pattern.c -lpbccd build && gcc -O2 -fPIC -Wall -I.. -L. -o pbc ../test/pbc.c -lpbccd build && gcc -O2 -fPIC -Wall -I.. -L. -o float ../test/float.c -lpbccd build && gcc -O2 -fPIC -Wall -I.. -L. -o map ../test/map.c -lpbccd build && gcc -O2 -fPIC -Wall -I.. -L. -o test ../test/test.c -lpbccd build && gcc -O2 -fPIC -Wall -I.. -L. -o decode ../test/decode.c -lpbcprotoc -obuild/addressbook.pb test/addressbook.protoprotoc -obuild/descriptor.pb test/descriptor.protoprotoc -obuild/float.pb test/float.protoprotoc -obuild/test.pb test/test.proto
假如編譯結果報錯了:
make: protoc:命令未找到make: *** [build/addressbook.pb] 錯誤 127
這是因為當前環境還沒安裝 protobuf,安裝步驟如下:
指令安裝:
sudo apt-get install protobuf-c-compiler protobuf-compiler 1
查詢版本驗證完成:
linsh@ubuntu:/application/pbc$ protoc --version libprotoc 2.5.0 12
給大家推薦一個關於skynet專案實戰的一個訓練營 現在報名相當於免費,(後臺私信“skynet”獲取地址)主講內容:
多核併發程式設計訊息佇列。執行緒池actor訊息排程網路模組實現時間輪定時器實現lua/c/介面程式設計skynet程式設計精要demo演示actor程式設計思維更多skynet及c/c++ linux伺服器開發資料加群:812855908免費領取!
(包括C/C++,Linux,golang技術,Nginx,ZeroMQ,MySQL,Redis,fastdfs,MongoDB,ZK,流媒體,CDN,P2P,K8S,Docker,TCP/IP,協程,DPDK,ffmpeg等)
工具編譯:用終端進入pbc專案pbc/binding/lua53目錄下面編譯出protobuf.so:
cd pbc/binding/luasudo make
編譯成功的話,將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
編譯報錯:
在pbc/binding/lua目錄下編譯,出現以下錯誤:
linsh@ubuntu:/application/pbc/binding/lua$ sudo makegcc -O2 -fPIC -Wall -shared -o protobuf.so -I../.. -I/usr/local/include -L../../build pbc-lua.c -lpbcpbc-lua.c:4:17: fatal error: lua.h: 沒有那個檔案或目錄#include "lua.h" ^compilation terminated.make: *** [protobuf.so] 錯誤 1
報錯原因: 這裡因為沒有安裝 lua5.3,不能是lua5.2或是lua5.1等低版本,否則會報錯。因為pbc用到了lua_rotate這是lua5.3新增的型別。解決方案: 安裝一下 lua5.3 即可解決,步驟如下:
到lua官網下載lua5.3的安裝包:lua-5.3.0.tar.gz也可以使用命令列下載工具 axel:
linsh@ubuntu:/application/pbc/binding$ sudo axel http://www.lua.org/ftp/lua-5.3.0.tar.gz初始化下載: http://www.lua.org/ftp/lua-5.3.0.tar.gzFile size: 278045 bytes開啟輸出檔案 lua-5.3.0.tar.gz開始下載[ 0%] .......... .......... .......... .......... .......... [ 53.8KB/s][ 18%] .......... .......... .......... .......... .......... [ 73.1KB/s][ 36%] .......... .......... .......... .......... ....連線 3 結束 ,,,,,,,,,, ,,,,,,,,,, ,,,,,,,,,, ,,,,,,,,,, ,,,,...... [ 96.9KB/s][ 55%] .......... .......... .......... .......... .......... [ 92.5KB/s][ 73%] .......... .......... .......... ......連線 0 結束 ,,,,,,,,,, ,,,,,,,,,, ,,,,,,,,,, ,,,,,,.... ........連線 1 結束 ,,,,,,,,,, ,,,,,,,,,, ,,,,,,,,,, ,,,,,,,,,, ,,,,,,,,.. [ 80.5KB/s][ 92%] .......... .......... .271.5 千位元組 已下載,用時 6 秒。(43.52 千位元組/秒)
使用壓縮包進行解壓和安裝:先將下載好的檔案複製到usr/local/src目錄下
sudo cp lua-5.3.0.tar.gz /usr/local/src
依次執行以下指令:
sudo tar zxf lua-5.3.0.tar.gz cd lua-5.3.0/ sudo make linux test
建立軟連結,是lua可以在當前環境下隨處可用:
sudo ln -s /usr/local/src/lua-5.3.0/src/lua /usr/bin/lua
測試一下軟連線是否成功:
linsh@ubuntu:/usr/local/src/lua-5.3.0/src$ lua程式 'lua' 已包含在下列軟體包中:* lua5.2* lua5.1* lua50請嘗試:sudo apt-get install <選定的軟體包>
我也出現過這個問題,最後查到原因是因為新增軟連結時第一個地址(lua的安裝地址)/usr/local/src/lua-5.3.0/src/lua被我寫成了/usr/local/src/lua5.3.0/src/lua,解決問題和可以看到:
linsh@ubuntu:/usr/bin$ luaLua 5.3.0 Copyright (C) 1994-2015 Lua.org, PUC-Rio>
修改pbc/binding/lua/Makefile中lua庫的地址配置資訊LUADIR為當前lua安裝的地址:
LUADIR = /usr/local/src/lua-5.3.0/src 1
再次執行編譯指令,並查詢當前目錄下檔案的變化:
linsh@ubuntu:/application/pbc/binding/lua$ sudo makegcc -O2 -fPIC -Wall -shared -o protobuf.so -I../.. -I/usr/local/src/lua-5.3.0/src -L../../build pbc-lua.c -lpbclinsh@ubuntu:/application/pbc/binding/lua$ lsbuild_ios.sh Makefile parser.lua pbc-lua.c protobuf.lua protobuf.so README.md test2.lua test.lua testparser.lua
測試:
先在專案根目錄下建立一個protos資料夾,用來存放協議檔案,建立一個Person.proto協議檔案,內容如下:
sudo mkdir protos cd protos sudo vi Person.proto
協議檔案的內容如下:
package 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; }
將協議檔案到處為.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檔案。
在lua中註冊對應的協議檔案:引入protobuf.lua:
local pb = require "protobuf" 1
註冊.proto協議檔案所對應的.pb檔案,註冊方法有兩種:
方法一:直接註冊檔案:
pb.register_file "Person.pb"
方法二:透過io讀取檔案,然後再獲取文字內容進行註冊:
file = io.open("Person.pb","rb") buffer = file:read "*a" file:close() pb.register(buffer)
透過 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) ```
假如註冊的協議檔案依賴其他協議檔案,則依賴的協議檔案需要優先註冊,否則會出現 register fail 的報錯
執行正確的結果:
[:0100000c] 註冊協議檔案:Person.pb[:0100000c] 資料編碼:name=linsh,id=1
除外,雲風還自定義了一套協議格式sproto,據說比protobuf還要簡單。