随着xlua的开源,其在项目中的使用也越来越广泛。游戏开发中我们经常会使用第三方库如,json解析,网络协议等等,目前xlua目前内置的扩展库:
1、针对luajit的64位整数支持;
2、函数调用耗时以及内存泄漏定位工具;
3、用于支持ZeroBraneStudio的luasocket库;
4、tdr 4 lua;
随着使用项目的增加以及项目使用的深入程度,仅有这几个扩展已经没法满足项目组了,而由于各个项目对扩展差异化比较大,以及手机平台对安装包大小的敏感,XLua是无法通过预集成去满足这些需求,结合官网的例程记录下自己扩展的步骤以及遇到的错误
我的环境大概如下:
windows操作系统,
xlua最新源码(版本105),
vs2015,cmake(3.13),
第三方扩展源码(提前下载好rapidjson)
步骤
1、安装cmake(根据自己电脑配置选择合适的版本)
cmake安装之后最好重启下电脑,即便环境变量已经配置好,但是有时还是会不识别
根据例子修改CMakeLists.txt文件,接入扩展
把xLua的C源码包解压到你Unity工程的Assets同级目录下。
2、在CMakeLists.txt加入扩展
下载lua-rapidjson代码,按你的习惯放置。本教程是把rapidjson头文件放到$UnityProj\build\lua-rapidjson\include目录下,
而扩展的源码rapidjson.cpp放到$UnityProj\build\lua-rapidjson\source目录下(注:$UnityProj指的是你工程的目录)
xLua的各平台Plugins编译使用cmake编译,好处是所有平台的编译都写在一个makefile,大部分编译处理逻辑是跨平台的。
xLua配套的CMakeLists.txt为第三方扩展提供了扩展点(都是list):
THIRDPART_INC:第三方扩展的头文件搜索路径。
THIRDPART_SRC:第三方扩展的源代码。
THIRDPART_LIB:第三方扩展依赖的库。
如下是rapidjson的加
#begin lua-rapidjson
set (RAPIDJSON_SRC lua-rapidjson/source/rapidjson.cpp)
set_property(
SOURCE ${RAPIDJSON_SRC}
APPEND
PROPERTY COMPILE_DEFINITIONS
LUA_LIB
)
list(APPEND THIRDPART_INC lua-rapidjson/include)
set (THIRDPART_SRC ${THIRDPART_SRC} ${RAPIDJSON_SRC})
#end lua-rapidjson
3、修改执行bat文件
比如windows 64位lua53版本是make_win64_lua53.bat,android的luajit版本是make_android_luajit.sh,要编译哪个版本就执行相应的脚本即可。
执行完编译脚本会自动拷贝到plugin_lua53或者plugin_luajit目录,前者是lua53版本放置路径,后者是luajit。
配套的android脚本是在linux下使用的,脚本开头的NDK路径要根据实际情况修改。双击执行结果如下图:
然后把生成的plugin_lua53/Plugins/x86_64/xlua.dll 直接覆盖unity项目的Assets/Plugins/x86_64/xlua.dll
4、c#集成
所有lua的C扩展库都会提供个luaopen_xxx的函数,xxx是动态库的名字,比如lua-rapidjson库该函数是luaopen_rapidjson,这类函数由lua虚拟机在加载动态库时自动调用,而在手机平台,由于ios的限制我们加载不了动态库,而是直接编译进进程里头。
为此,XLua提供了一个API来替代这功能(LuaEnv的成员方法):
public void AddBuildin(string name, LuaCSFunction initer)
name:buildin模块的名字,require时输入的参数;
initer:初始化函数,原型是这样的public delegate int lua_CSFunction(IntPtr L),必须是静态函数,而且带MonoPInvokeCallbackAttribute属性修饰,这个api会检查这两个条件。
我们以luaopen_rapidjson的调用来看看怎么使用。
扩展LuaDLL.Lua类,用pinvoke把luaopen_rapidjson导出到C#,然后写一个符合lua_CSFunction定义的静态函数,你可以在里头做写初始化工作,比如luaopen_rapidjson的调用,以下是完整代码:
namespace LuaDLL
{
public partial class Lua
{
[DllImport(LUADLL, CallingConvention = CallingConvention.Cdecl)]
public static extern int luaopen_rapidjson(System.IntPtr L);
[MonoPInvokeCallback(typeof(LuaDLL.lua_CSFunction))]
public static int LoadRapidJson(System.IntPtr L)
{
return luaopen_rapidjson(L);
}
}
}
然后在lua虚拟机创建时调用AddBuildin:
luaenv.AddBuildin("rapidjson", LuaDLL.Lua.LoadRapidJson);
例子测试代码
local rapidjson = require('rapidjson')
local t = rapidjson.decode('{"a":123}')
print(t.a)
t.a = 456
local s = rapidjson.encode(t)
print('json', s)
当以上步骤都完成时重启unity报错了,报错信息如下:
这是因为我下载的xlua版本是104的,生成的xlua.dll是105版本的,去官网下载最新的xlua源码替换下就好了