[程序] tolua中使用protobuf3—集成lua-protobuf

[复制链接]
星空 发表于 2019-3-15 14:24:39 | 显示全部楼层 |阅读模式
lua-protobuf最近项目中需要使用lua版本的protobuf库,在Github上找到了lua-protobuf用来替换tolua中自带的pbc库,替换的原因主要有以下:
3 L, R$ i; |' m. M% Q* A
  • 正如lua-protobuf作者所说: pbc返回的并不是纯粹的Lua表,使用不方便。
  • 项目使用protobuf3,pbc已经几年未更新,担心不能很好的支持或不支持protobuf3$ O1 }$ X8 h' R; ^  M+ s. v$ x5 v
但lua-protobuf实际上是一个纯C的protobuf协议实现,为了可以在tolua中使用,将tolua中pbc(pb.c),替换成lua-protobuf(pb.c和pb.h),然后编译成相应平台支持的库文件(win tolua.dll, android libtolua.so, mac tolua.bundle, ios libtolua.a)# {' P* f% s" v! T, T, v6 ~  O6 u) f
lua-protobuf pb.c中luaL_newlib为lua5.2版本才支持的语法,为了支持tolua的luajit(lua版本为5.1)在如下为止做了修改(如果lua版本小于5.2,则使用luaL_register方法,并且需要在C#中导入否则lua代码中不到pb模块):
$ Q1 X/ k6 T- f$ D修改为) M4 L7 v. U% F: |2 X5 g8 Q/ N$ u
1 H9 o3 T/ q, ]. C4 J/ x4 o( e0 @
  1. LUALIB_API int luaopen_pb_io(lua_State *L)
    & b: ?# Y# ?3 {6 {' Y9 v( R
  2. {% G7 @" p' B$ M$ ?4 R
  3.     // 。。。$ H) y. }8 ]$ |2 v1 |
  4.     if (LUA_VERSION_NUM < 502)
    % G+ P4 }4 _0 p* u* c
  5.     {
      O% J( w. H/ y& N
  6.          luaL_register(L, "pb.io", libs);. t. ?9 v# q( }5 Z$ e% ]
  7.     }
    7 ~/ ]" r- P; l9 U8 p* {/ h7 j
  8.     else, s$ o$ C7 w: _8 G' G
  9.     {" `* l8 Q: \6 }2 B
  10.         luaL_newlib(L, libs);. E! w% [7 ?) D. R3 w: ~$ z3 @
  11.     }* j0 i% p' h- d6 a1 g' |( `
  12.     return 1;% ]! Y6 f& E9 k) n& y
  13. }) ~  [& ?4 v7 X9 T  K. F+ @% k" r
  14. + E& J- f" @3 q/ l5 S% B& |# }
  15. LUALIB_API int luaopen_pb_conv(lua_State *L)
    # a! D5 j( K* M  b1 U; O
  16. {% N: p/ x; z3 J
  17.     // 。。。" L+ v+ F# G0 [4 T
  18.     if (LUA_VERSION_NUM < 502)( R5 m) a/ a) G" p  \0 D. L. l( Y3 b
  19.     {
    / F# \! X" j2 a0 ]
  20.          luaL_register(L, "pb.io", libs);( Z8 Z: u- y% P" J
  21.     }1 e  J2 n8 V/ X
  22.     else  ^6 C2 a# b+ A, Y4 r$ O
  23.     {( f, m2 J5 Z1 a0 P* I8 v
  24.         luaL_newlib(L, libs);
    ) J* I! {# n' H# D9 ^6 ]
  25.     }( Z; H' g' w# `. X5 t  N
  26.     return 1;
    ( Q3 V2 w0 k+ o, Z* Y+ s( Q
  27. }
    + f6 y- L2 B6 b

  28. & P. N; g/ x1 v) g" D
  29. LUALIB_API int luaopen_pb(lua_State *L)
    3 F$ D$ }7 Q' F
  30. {$ O* [5 t+ L4 G( h3 k! c$ x) ~
  31.     // 。。。
    1 J8 ^- |# ?) f- M
  32.     if (LUA_VERSION_NUM < 502)/ H! u2 r( @% P6 G" I
  33.     {" Y" I/ o" O  K. P
  34.          luaL_register(L, "pb", libs);
    ' C" T1 N0 N+ m3 N4 X+ r
  35.     }
    # v1 L8 V$ ~) g, h
  36.     else: `& s4 H; R: `! ?) _  C- X5 y
  37.     {
    + c6 p# }$ a; R
  38.         luaL_newlib(L, libs);/ F8 ]3 I7 ?2 E. a
  39.     }
    8 u$ I7 h% @( Z5 J, G$ y
  40.     return 1;
    ( c$ p9 t1 {  S; n) K2 P/ _+ t1 P
  41. }
复制代码
自编译tolua如何编译请参考
# k. p& ]9 O: T5 d4 x以下为上面文章补充:
1 e& y! {" L! @: w; yandroid如何编译各平台使用的库-以编译tolua为例中提到的' V" Q2 U* }9 X: u
  将ndk路径添加到mingw-32的环境变量PATH中
# o2 @: Y$ h& U; R6 S1 v, G! ~
可以打开mingw32.ini中MSYS2_PATH_TYPE=inherit的注释,表示使用windows系统配置的环境变量,这样将ndk路径配置到window环境变量中即可正常使用。- u8 l0 O2 ~; {: R- t! F
6 a! X1 c$ i4 @9 G, S& a
mingw-32.in完整配置i如下所示:, z3 Z# n, I4 o" V$ Y/ N
  1. MSYS2_PATH_TYPE=inherit, g: t# P4 H. s; j( s7 m* `5 y
  2. MSYSTEM=MINGW32
    9 p$ `) [& V  d2 s- m5 L$ A
复制代码
mac&ios
  • 在mac终端导航到tolua根目录中,直接在终端执行./build_osx.sh和./build_ios.sh即可
  • 如果执行.sh提示权限不足 可以在终端执行:chmod 777  tolua根目录 然后再次执行.sh脚本即可
  • 如果执行build_osx.sh时提示不在支持32位,请打开macnojit 在build Setting移除i386的支持即可
    2 `1 |' f4 Y: g5 x" r) ^
完成编译之后将tolua根目录中Plugins中对于的文件拷贝到Unity Plugins文件中进行替换,并且将lua_protobuf附带的protoc.lua(位于lua-protobuf文件夹)拷贝到工程中。( K  o% M* b% Q4 O/ W) f
导入lua-protobuf
8 i$ D. n8 t# X; }6 _在tolua C#部分 LuaDLL.cs中添加如下代码:
( _& ]5 Q2 o( D  d: U
3 S# H8 I. L; r: U
  1. [DllImport(LUADLL, CallingConvention = CallingConvention.Cdecl)]5 m5 N" ^; @7 l2 d  i; k$ S
  2. public static extern int luaopen_pb(IntPtr L);
    / L- `% z# K! o; R% n1 B

  3. 4 U& E$ C; W8 g
  4. [DllImport(LUADLL, CallingConvention = CallingConvention.Cdecl)]/ [$ X1 O6 B6 o/ I' E2 P) L
  5. public static extern int luaopen_pb_io(IntPtr L);2 e' d* F4 ]' H% F* R( P
  6. 0 u. j8 H, w# R8 j
  7. [DllImport(LUADLL, CallingConvention = CallingConvention.Cdecl)]% D% |1 I% t% P
  8. public static extern int luaopen_pb_conv(IntPtr L);
    ! A$ O% X2 I6 T! k$ [
  9. & J' _, Y* C  b9 b
  10. [DllImport(LUADLL, CallingConvention = CallingConvention.Cdecl)]5 h! i9 L4 C7 n$ `
  11. public static extern int luaopen_pb_buffer(IntPtr L);9 K5 M. J; _* T% ?$ a) F
  12. ' L5 W$ w( X$ |) {9 J
  13. [DllImport(LUADLL, CallingConvention = CallingConvention.Cdecl)]+ Q5 i9 V" H4 p  f. l9 D$ N
  14. public static extern int luaopen_pb_slice(IntPtr L);% [$ w2 b- E/ m# a6 ]
复制代码
并且在启动lua时,将上述模块导入即可:! i5 @2 B$ Q' b- H/ }' v
  1. void OpenLibs()5 V. O9 c2 y: {
  2. {
    5 H6 a3 G% S  ?( w! z
  3.        lua.OpenLibs(LuaDLL.luaopen_pb_io);
    : {1 c# }/ C# l4 l) X( c7 k; d( l
  4.        lua.OpenLibs(LuaDLL.luaopen_pb_conv);! M% h! z4 K0 h" f8 i
  5.        lua.OpenLibs(LuaDLL.luaopen_pb_buffer);
    & d5 o6 [: X3 f2 l  C3 H" f+ L/ E
  6.        lua.OpenLibs(LuaDLL.luaopen_pb_slice);
    * y& s+ D" K5 A; b! a) N- {
  7.        lua.OpenLibs(LuaDLL.luaopen_pb);
    . j4 m  g& |, X3 H
  8. " H; C& x5 _  ?
  9.        //其他的库1 r) ^* O; y3 K3 o' ?2 ~. M/ @
  10. }: _& L- R* H' {+ D- q$ S% h
复制代码
验证集成首先需要验证是否集成成功:
% ]  [" R6 F  c/ z/ J
# P' Z2 q7 k1 G, J6 N( Z/ }) S使用lua-protobuf作者提供的例子并且修改为proto3协议:
# I; ^1 k2 O2 C2 w4 w' I/ D- }# a. z+ Z4 B- i, F! b/ G3 ^2 a& j
  1. local pb = require "pb"
    ; d) X6 d2 Q7 F0 X, l
  2. local protoc = require "3rd/lua-protobuf/protoc"7 N2 o8 S  D" [( ]2 |1 J
  3. ; S: e+ L* [& X# ~' F  Q
  4. -- load schema from text
    9 k* U' i  }2 B7 Q
  5. assert(protoc:load [[
    4 f' D0 ~5 t& V2 a, H$ W4 t4 ~
  6.     syntax = "proto3";, Q( K4 |, x/ O+ @: D+ F4 P

  7. 0 u; R" F3 e3 p- Y
  8.     message Phone {
    : F. k4 i7 k& ?; X* G. A) ?
  9.         string name = 1;
    + _+ w/ v  ?" o: K* m) A# R
  10.         int64 phonenumber = 2;
    5 ?  c3 d! U. U
  11.     }
    3 v" j, c8 A9 |0 ~1 E" H1 m
  12.     message Person {% \: R: X- Y% d* o
  13.         string name = 1;' ]9 B4 A. c* A6 y  K9 R8 I" B
  14.         int32 age = 2;
    1 b( p1 e  b. X7 F
  15.         string address = 3;% s7 ]$ o; O/ B5 e' c% `
  16.         repeated Phone contacts = 4;
    5 R$ A0 S0 B& j1 I. M, v
  17.     } ]])! u) \/ X$ s+ W* k) \
  18. 1 z, }: w2 j9 H
  19. -- lua table data: ^$ p$ Z# ^8 D5 R: X
  20. local data = {4 l3 b' K5 N! d$ `+ S' J7 U
  21.     name = "ilse",- @9 D+ Y3 l4 s0 _+ T
  22.     age = 18,2 p5 i' i- r7 y. U2 Z, p- n* l
  23.     contacts = {+ n' b, K& V3 f: M
  24.         { name = "alice", phonenumber = 12312341234 },- ^' u# M6 y4 P9 V
  25.         { name = "bob", phonenumber = 45645674567 }
    9 V- F" O# e# f3 z; P; U# A2 i
  26.     }
    5 _3 C+ _% I! [" A# j
  27. }
    ; e' F& e& S* g. G. |% p

  28. 2 L1 L! U% ~# c4 j9 d: x$ I
  29. -- encode lua table data into binary format in lua string and return
    3 _* z) ], \. s' \) S% M
  30. local bytes = assert(pb.encode("Person", data))
    ! G1 D" _( D1 f4 ^
  31. print(pb.tohex(bytes))
    4 G7 |7 J' l( l, p2 L1 m* \* `
  32. -- and decode the binary data back into lua table' {# d4 _7 G- [; Z: f" j4 D
  33. local data2 = assert(pb.decode("Person", bytes))- l9 N' }$ [" K" \1 n$ D
  34. print(require "3rd/lua-protobuf/serpent".block(data2))6 n3 D8 {% W9 Y( F4 l

  35.   \7 F1 z1 S$ f: m  b$ X# n
复制代码
如果可以正常打印(最好在移动平台上也进行测试),则表示集成成功。* Z$ y  n  o( f# p: n* N
lua-protobuf基本用法首先可以使用上面的测试例子的用法:直接使用lua中字符串加载协议,优点为不用使用其额外的文件,缺点在与protobuf协议为服务端和客户端共同使用,修改不方便。% X* k2 |5 Y4 S- H2 I; M# d! p
lua-protobuf 使用说明中作者展示另一种使用方式,动态加载生成的二进制pb文件。小编推荐这种用法,并且在当前开发项目中进行了进一步的实践。7 l$ g$ T6 o  y. ?% B8 W
以下为具体的做法:
5 ~& b. b% U2 B7 k* ?7 \首先在protoc下载相应的版本protoc.exe版本,并且配置到环境变量中。
. W8 X9 `, m, @, O2 x+ }然后新建用于处理proto文件的目录:0 V* A, u2 u9 e+ \0 f- g. W7 V
目录结构如下:
0 k+ P& t1 Z5 b9 t% z& G
$ L& c) N( h- o4 y9 R- L %E6%89%A7%E8%A1%8Cbat%E5%89%8D-300x71.jpg 8 o* T4 Q& o. w
执行bat之后目录如下:: @9 R! k2 Q7 G% G5 k7 F

7 \; U. X5 ^& x0 n! t/ @' z %E6%89%A7%E8%A1%8Cbat%E4%B9%8B%E5%90%8E-300x97.jpg 0 L5 r+ Y6 Q+ V0 R
Proto的目录中存放了.proto协议文件,proto2pb.bat、proto2java.bat和proto2cs.bat为生成相对于代码的批处理目录,bat文件在生成对于的文件之后,将自动拷贝到对于的工程中。
3 Y6 Y$ P; F0 p1 h# x项目中proto协议设置在目前开发的项目中对于每一个请求返回消息流程对应一个proto协议文件,协议内部嵌套Request和Response,如果为服务端推送则只需要Response,如果不需要服务端返回则只需要Request& v2 ?/ y# f- p
% q( }. J& Y- F3 @7 \- C
以下具体的协议的实例(GetTableId.proto):9 c$ W- C* T& J
, q% T6 O  r; A7 p# ?; O
  1. syntax = "proto3";. ]# t* v! D5 g* x6 c- ~' R6 d4 \
  2. package Test;
    , L( z! ?5 Y$ O+ Q. T& O

  3. 6 c; `0 T# ^) ^* h6 @) {( H
  4. option java_package = "com.project.protocol";
    * ^2 A1 X$ _6 _2 A! l* V  }7 j
  5. option java_outer_classname = "GetGetTableIdOuter"; P; `' o; S5 c- e2 m
  6. message GetTableId {  d& ]7 H- a+ ~$ P& G  `
  7.     message Request{
    % a4 ]: j7 x2 j7 h4 m
  8.         string roomId = 1;% a7 X: X2 q- n% }' b# t5 }
  9.         int32 tableId = 2;
    4 ?: A) w7 |9 ?4 w* H, M' H2 k6 d
  10.     }0 D/ {- h9 p3 |- f6 V0 s
  11.     message Response {
    ( H6 x5 b! H+ @4 m" ~% @
  12.         string tableId = 1;
    & I5 z/ `  N9 Z0 P' J5 K
  13. }
复制代码
bat文件的源代码, `; H6 R/ f( o9 }" A
proto2pb.bat代码如下:
8 X! {* Y# y+ v' I7 z5 h' X( V
( B7 d! ^. L4 D) B- t
  1. @echo off
    # Q- i5 V5 v& W4 E1 w% v5 p
  2. cd Proto' N4 B& w" S6 p) `, }. x
  3. REM 生成二进制文件pb(首先删除在重新生成)1 p& O, m- ?: y# x& r/ `: _
  4. rd /s /q ..\pb
      P% p" F2 J$ C5 H( T. `
  5. md ..\pb
    " M8 G( C9 v. }3 D
  6. set pbPath=..\pb\
    * y$ l- p- o8 q- m( V
  7. set pb=.pb+ {# J0 r0 V; M) p2 s: r# c3 r
  8. for %%i in (*.*) do (3 q. z0 P* Z/ @6 o3 ?# f
  9.     echo %%i( l: W6 q: \! J% B
  10.     protoc -o %pbPath%%%i%pb% %%i
    5 h" k# k& l% r& M1 Y
  11. )2 E% ]+ [7 ?- p: L

  12. 3 c, j+ f! P/ y- N( B6 y
  13. echo pb create success
    4 i. O6 a, `7 P, J& k2 j
  14. echo./ _! y: s8 Z' L: Z

  15. 6 j* C- r: I0 E( N1 O, b/ Y' ^$ I
  16. cd ..\pb
    8 I8 q# k) P) Y3 S) o, i
  17. SetLocal EnableDelayedExpansion
    : P3 r; G! @( p
  18. REM 要查找的文件类型$ f+ \7 p; v9 j0 }3 J" d, L& z, @
  19. set ext=*.pb- o* G& o' A& L# R# f8 o
  20. REM 重新命名文件
    - U0 @0 y4 o, f* Y* h
  21. for /r %%a in (!ext!) do (
    3 C4 Y9 |" R! M' p: {' n- U
  22.     REM 文件名  p- ^" P8 Z/ C( G8 F' ]
  23.     set fn=%%~na
    ( N+ L3 ^8 C% p+ f* @3 Q3 x
  24.     REM 后缀6 W) N" b% S2 }3 ]8 d) y, b4 g' s( ^" ~
  25.     set en=%%~xa5 i- {/ |+ _3 d/ w  q/ d
  26.     REM 把字符串的最后4个字符赋值给变量hou6 i# e7 `6 B5 s/ d! ~3 z# P- G
  27.     set hou=!fn:~0,-6!- k! r8 }8 q/ k, ~" i* X; J
  28.     echo !hou!!en!3 G( W) d3 Q2 j# F" h$ I0 u/ I
  29.     rename "%%a" "!hou!!en!"! T) e, P: I, j& U6 R5 K, R. Y
  30. )
    2 l& C/ }0 i6 V
  31. echo pb rename success
    & _/ ?0 k; S" u$ x5 c; I7 \
  32. echo.* O0 x; E" f, F) n. i
  33. * o7 Y4 U  I7 z9 {. u' N
  34. REM 项目中pb文件存放目录
    7 V8 ^4 h: g/ H( [
  35. set destPath=E:\source\client\xxx\Assets\StreamingAssets\lua\pb
    . e, A' h. A% K8 H, R

  36.   W( h7 w" z, f- a  T9 s3 G" V7 _+ k
  37. rd /s /q %destPath%+ ~- {9 R+ A# ~& i
  38. md %destPath%; V* o: U3 H  A; S$ I
  39. $ t/ I6 A1 H8 K; |: B2 Y2 S
  40. echo copy to %destPath%" G) B7 K2 R  x0 f' `. ~
  41. xcopy ..\pb %destPath% /s /e
    8 j  P8 E2 X+ ^, {* o
  42. pause
    7 v! ^0 _! D6 F
  43. 1 E. O* X) h# B8 z
复制代码
proto2java.bat% k' F& \; t0 f3 o) W

. m- D- a4 v# }2 w+ g2 P
  1. @echo off
    ! v  |& n: H) j4 Q3 m* w

  2. $ O2 ]6 g! u& ?9 I; _3 R0 X
  3. cd Proto
    8 I+ T0 ?0 V7 d0 D2 T& k* C# j
  4. REM 生成java
    & y- Z* O6 N: \
  5. 7 _  A( a; L3 ?3 m
  6. rd /s /q ..\Java
    ! f! C; M, r' u: [* e, D0 ?6 d
  7. md ..\Java
    1 M0 N( r2 ?6 E! Q% w) R3 X. l
  8. $ `3 ~; r: a+ b: Z; O3 z  H7 J; u9 y
  9. set dest_path="..\Java"8 |5 g' D  f( P
  10. for %%i in (*.*) do (
    & T& O* K8 R1 ^1 E& [. X4 O
  11.     echo %%i- o$ D  r$ |- v+ E' Z; [8 a
  12.     protoc --java_out=%dest_path% %%i7 i: Z+ ~0 u+ T  S% @# C, P
  13. )* c/ ~2 S4 e- \( K* z* A

  14. 6 v- i3 S  H, f3 Z6 r: U
  15. echo java success. }& e7 u" ^$ j- t3 K) n
  16. 8 p) F# _5 r, A& {+ ^
  17. REM 拷贝文件& t  O1 K4 U' a# K. d( `$ z
  18. REM echo.
    9 p8 j1 m" _& _1 Z3 {/ p
  19. # P0 O; A/ t7 o) }! r
  20. set destPath=java代码目标目录
    . `" M6 \3 o: u# l* {% T
  21. rd /s /q %destPath%5 o  H  m" Z: A) `
  22.   M2 }2 B% M6 W% l% m7 E! v) W/ |' L
  23. md %destPath%
    - k1 @* p; [* b1 Y8 R& ?
  24. echo copy to %destPath%
    . T$ m6 ~8 G; s- |& n  s% `7 A" |
  25. xcopy ..\pb %destPath% /s /e; T% |" @3 P8 I# @. b6 k* Z
  26. pause3 g! N2 c4 n+ ~$ U9 G) B6 V4 N
  27. ; c' L- e! R+ `% |5 O0 K! H
复制代码
proto2cs.bat2 u( g9 Q$ K) w6 H* q/ o

  e2 x* M6 c8 G* m
  1. @echo off/ t$ m5 y9 s0 y/ |( S! r+ ~

  2. 3 i% `$ |/ a$ y% O" A
  3. cd Proto
    $ t+ L, v1 n2 S. y: l
  4. REM 生成java
    / z) Z' e* Y- {& \4 n
  5. ( @( m/ y: @7 v; G
  6. rd /s /q ..\Java
    6 ^7 j- a+ M3 ?
  7. md ..\Java
    + _) y0 l9 V' X6 J. F9 M. S: [
  8. 1 h6 A7 _5 ?* m9 N% b7 n
  9. set dest_path="..\Java"
    2 C* ?/ R) m0 Z+ X- W
  10. for %%i in (*.*) do (
    ) b0 K* O  X( y1 j, ^# ^
  11.     echo %%i. j% c* G0 g1 I+ e! L  l& ?8 A
  12.     protoc --csharp_out=%dest_path% %%i3 C1 k4 I  P( o6 b: b
  13. )
    3 a" j7 t: I% ^+ q
  14. ) P5 n: R  C% N% a' I5 N( y
  15. echo java success
    $ K* Q- x# h! U# l6 q) f
  16. . U% Y* X3 P6 a
  17. REM 拷贝文件
    4 l3 c/ }* @! n; p" d
  18. REM echo.
    / C2 d* ^5 b! W# l* Z
  19. 6 q8 I, y+ f* J8 t" _& z9 Q. t
  20. set destPath=java代码目标目录
    & @" ^1 H! E3 g
  21. rd /s /q %destPath%
      D% @; ]) _, j& S  m, K
  22. ; y0 H! o+ |! C8 W0 U
  23. md %destPath%7 S" u- M: |8 q
  24. echo copy to %destPath%- c  X7 \. K4 B9 r
  25. xcopy ..\pb %destPath% /s /e
    ' r8 ~) p) ^8 a4 ~# P3 f8 K
  26. pause/ c$ v# s! U2 |; q) p9 a7 J
  27. ; X9 t) P/ T2 {7 \9 @
复制代码
( b# `1 `( A& p7 Z# D7 A* Q
2 v. |6 a5 V8 D( w# d- O
哎...今天够累的,签到来了游戏源码下载...
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则