Unity SLua加載lua文件的簡捷方案

作為一個Unity新手,在打包lua代碼的時候,遇到幾個棘手的問題:

  1. Resource.Load無法加載.lua格式的文件
  2. lua中的require/dofile/loadfile無法使用橘蜜,android中無法使用file read

講解決方案前蚤认,先附上兩個git倉庫及糾正一個網(wǎng)上文章的錯誤:
lua: https://github.com/lua/lua
slua: https://github.com/pangweiwei/slua

網(wǎng)上有關require順序描述的文章:http://blog.chinaunix.net/uid-552961-id-2736410.html
里面的require順序有誤稳摄,不是先從package.loaded中加載室囊,具體順序,請參考此文章秘噪,建議遇到問題狸吞,先看官網(wǎng)及源碼,最后再google, baidu指煎。


對于第一個問題蹋偏,有非常多種做法,這邊選用的是打包時至壤,將一個個lua文件copy到Resources/LuaScripts目錄(按照原有的目錄結構copy威始,項目本身的Lua代碼在Assets同層的LuaScripts目錄),并修改后綴為.txt像街,因為項目出demo比較急黎棠,做在了unity菜單上晋渺,簡單在項目editor中增加了生成->打包用Lua文件一項,后面需要統(tǒng)一使用python腳本編寫脓斩,以方便自動出包木西,下面是參考代碼:

    [MenuItem("XXXProj/生成/打包用lua文件")]
    public static void OnMenu_GenTarLuaFiles()
    {
        // Env.luaScriptDFirectoryName 為lua腳本目錄名, 項目中定義為LuaScripts
        // Env.luaScriptPath 為lua腳本目錄,在editor為全路徑随静,如:d:\project\program\client\LuaScripts, 在device上為Application.streamingAssets\LuaScripts

        // Join方法為項目特有方法八千,仿python的join設計,方便進行路徑拼接
        var targetRootDir = FileUtil.Join(Application.dataPath, "Resources", Env.luaScriptDirectoryName);
        if (!Directory.Exists(targetRootDir))
            Directory.CreateDirectory(targetRootDir);

        var origDirInfo = new DirectoryInfo(Env.luaScriptPath);
        FileUtil.ForeachFiles(origDirInfo, (dInfo) => // 項目特有方法燎猛,方便目錄遍歷
        {
            if (dInfo.Name.StartsWith("."))
                return false;

            return true;
        },
        (fInfo) =>
        {
            if (fInfo.Name.StartsWith("."))
                return;

            var inlPath = fInfo.FullName.Substring(Env.luaScriptPath.Length);
            var inlDir = FileUtil.DirName(inlPath);
            var targetDir = FileUtil.Join(targetRootDir, inlDir);
            if (!Directory.Exists(targetDir))
                Directory.CreateDirectory(targetDir);

            var targetPath = FileUtil.Join(targetRootDir, FileUtil.SplitExt(inlPath)[0] + ".txt");
            File.Copy(fInfo.FullName, targetPath, true);
        });

在生成后恋捆,進行打包,這樣可以在device中通過Resource.Load進行l(wèi)ua文件的讀入扛门。


對于第二個問題鸠信,之前沒有細看slua對package.searchers/package.loaders的修改部分代碼纵寝,想了非常多不太靠譜的方案论寨,后面再細看slua中的LuaState.init代碼的時候,發(fā)覺已經(jīng)做了這些工作了爽茴,只需要為你的LuaState設置一個loaderdelegate就OK葬凳,最終幾行代碼解決了lua require支持及c#中dofile/loadfile的問題,說解決方案前室奏,需要了解一下lua中的require機制火焰,直接看lua53中的loadlib.c中的ll_require代碼:

static int ll_require (lua_State *L) {
  const char *name = luaL_checkstring(L, 1);
  lua_settop(L, 1);  /* LOADED table will be at index 2 */
  lua_getfield(L, LUA_REGISTRYINDEX, LUA_LOADED_TABLE);
  lua_getfield(L, 2, name);  /* LOADED[name] */
  if (lua_toboolean(L, -1))  /* is it there? */
    return 1;  /* package is already loaded */
  /* else must load package */
  lua_pop(L, 1);  /* remove 'getfield' result */
  findloader(L, name);
  lua_pushstring(L, name);  /* pass name as argument to module loader */
  lua_insert(L, -2);  /* name is 1st argument (before search data) */
  lua_call(L, 2, 1);  /* run loader to load module */
  if (!lua_isnil(L, -1))  /* non-nil return? */
    lua_setfield(L, 2, name);  /* LOADED[name] = returned value */
  if (lua_getfield(L, 2, name) == LUA_TNIL) {   /* module set no value? */
    lua_pushboolean(L, 1);  /* use true as result */
    lua_pushvalue(L, -1);  /* extra copy to be returned */
    lua_setfield(L, 2, name);  /* LOADED[name] = true */
  }
  return 1;
}

可以看到,在5.3中的require實現(xiàn)胧沫,已經(jīng)非常清爽(5.1的也看過昌简,代碼寫得比較啰嗦),簡單概括就是:

  1. 確認package.loaded中是否已經(jīng)加載過此模塊绒怨,如果有纯赎,直接返回
  2. 如果沒有,通過findloader()查找到模塊對應的loader
  3. call loader(對于c就是調(diào)用entry function南蹂,lua即執(zhí)行chunk)犬金,將結果保存在package.loaded[name]中,如果call loader返回nil六剥,直接填充true晚顷,返回call loader結果

其中findloader看了一下實現(xiàn),里面會逐個取得package.searchers中的searcher進行l(wèi)oader search疗疟,打到后该默,返回loader,具體可以看loadlib.c中的實現(xiàn)策彤,5.1栓袖、5.2則是從package.loaders取得searcher顿膨,所以從命名來看,還是5.3合理叽赊。

說到這里恋沃,大家應該清楚怎么去做自己的require了,只需要在package.searchers中增加自己的searcher即可必指,SLua也是這么做的囊咏,看LuaState.init中的部分代碼:

            pushcsfunction(L, dofile);
            LuaDLL.lua_setglobal(L, "dofile");

            pushcsfunction(L, loadfile);
            LuaDLL.lua_setglobal(L, "loadfile");

            pushcsfunction(L, loader);
            int loaderFunc = LuaDLL.lua_gettop(L);

            LuaDLL.lua_getglobal(L, "package");
#if LUA_5_3
            LuaDLL.lua_getfield(L, -1, "searchers");
#else
            LuaDLL.lua_getfield(L, -1, "loaders");
#endif
            int loaderTable = LuaDLL.lua_gettop(L);

            // Shift table elements right
            for (int e = LuaDLL.lua_rawlen(L, loaderTable) + 1; e > 2; e--)
            {
                LuaDLL.lua_rawgeti(L, loaderTable, e - 1);
                LuaDLL.lua_rawseti(L, loaderTable, e);
            }
            LuaDLL.lua_pushvalue(L, loaderFunc);
            LuaDLL.lua_rawseti(L, loaderTable, 2);
            LuaDLL.lua_settop(L, 0);

slua已經(jīng)將loadfile, dofile都已經(jīng)替換成了自己的loadfile, dofile,內(nèi)部統(tǒng)一調(diào)用loader進行l(wèi)ua file load塔橡,同時將自己的loader插入到了package.searchers中的2位置上梅割,5.3的loader順序是(看loadlib.c中的createsearchertable()):{searcher_preload, searcher_Lua, searcher_C, searcher_Croot, NULL};,放在preload searcher前是合理的葛家,preload需要先被執(zhí)行户辞,這個是內(nèi)部庫searcher實現(xiàn),它應該是第一個被調(diào)用的癞谒。

看LuaState中的的loadfile/dofile實現(xiàn)底燎,都只會進行l(wèi)oader調(diào)用,也就確保了在lua中的"loadfile", "dofile"最終調(diào)用回了LuaState中的loader弹砚。

LuaState.loader調(diào)用的是LuaState.loadFile()方法双仍,在最終的loadFile實現(xiàn)中:
image.png

我們可以看到,SLua會先確認有沒有自定義的LoadDelegate桌吃,如果有就調(diào)用朱沃,沒有就進行通用處理,魔法就在這里了茅诱,我們實現(xiàn)一下自己的loader delegate即可逗物,簡單來說,require流程變成了下面這樣:

  1. require "a.b.c"
  2. 調(diào)用c實現(xiàn):ll_require()
  3. 逐個調(diào)用package.searchers中的searcher瑟俭,找到loader
  4. 到LuaState.loader()翎卓,static方法
  5. 到LuaState.loadFile()
  6. 確認有沒有l(wèi)oader delegate,有就調(diào)用尔当,得到byte[]莲祸,沒有則進行通用lua文件加載策略,得到byte[]
  7. 返回LuaState.loader()椭迎,對byte[]進行l(wèi)uaL_loadbuffer锐帜,得到chunk返回
  8. 回到ll_require()中,ll_require()執(zhí)行這個chunk畜号,并將此chunk執(zhí)行結果緩存到package.loaded[name]中缴阎,如果為nil,則存入true
  9. 返回chunk執(zhí)行結果給調(diào)用require "a.b.c"處
  10. 完成

整個流程弄清楚之后简软,我們只需要編寫一個loader即可蛮拔,參考的Loader代碼:

        // 代碼從項目的LuaEngine中摘取述暂,內(nèi)部方法統(tǒng)一"_"加大駝峰格式
        // _scriptRootPath為LuaEngine中緩存的腳本根目錄路徑,在Editor下為全路徑建炫,在Device模式下為"LuaScripts"
        // require的格式都為"a.b.c"畦韭,所以需要先進行replace操作,所有"."統(tǒng)一replace成"/"
        // 在editor模式下肛跌,簡單進行File.ReadAllBytes即可艺配,后綴還是.lua,在device模式下衍慎,進行資源加載转唉,資源已經(jīng)在上面有說,會copy到Resources/LuaScripts目錄中
        // lua文件加載這邊可以在loading時先加載到cache中稳捆,這樣游戲運行中赠法,require可以快一點,也不會出現(xiàn)卡頓乔夯,但lua文件cache在游戲后期也有可能高達十幾MB砖织,這個就交給大家權衡啦
        private byte[] _LoaderDelegate(string fn)
        {
            Log.Dbg<LuaMgr>("Load lua file:{0}", fn);
            return _LoadLuaBytes(fn);
        }

        private byte[] _LoadLuaBytes(string fn)
        {
            string assetPath = FileUtil.Join(_scriptRootPath, fn.Replace('.', '/'));
#if UNITY_EDITOR
            return File.ReadAllBytes(assetPath + ".lua");
#else
            var textAsset = ResMgr.LoadRes<TextAsset>(assetPath);
            return textAsset != null ? textAsset.bytes : null;
#endif

占用工作時間寫的筆記,比較亂驯嘱,將就看啦镶苞。

最后編輯于
?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末喳坠,一起剝皮案震驚了整個濱河市鞠评,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌壕鹉,老刑警劉巖剃幌,帶你破解...
    沈念sama閱讀 218,122評論 6 505
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異晾浴,居然都是意外死亡负乡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,070評論 3 395
  • 文/潘曉璐 我一進店門脊凰,熙熙樓的掌柜王于貴愁眉苦臉地迎上來抖棘,“玉大人,你說我怎么就攤上這事狸涌∏惺。” “怎么了?”我有些...
    開封第一講書人閱讀 164,491評論 0 354
  • 文/不壞的土叔 我叫張陵帕胆,是天一觀的道長朝捆。 經(jīng)常有香客問我,道長懒豹,這世上最難降的妖魔是什么芙盘? 我笑而不...
    開封第一講書人閱讀 58,636評論 1 293
  • 正文 為了忘掉前任驯用,我火速辦了婚禮,結果婚禮上儒老,老公的妹妹穿的比我還像新娘蝴乔。我一直安慰自己,他們只是感情好驮樊,可當我...
    茶點故事閱讀 67,676評論 6 392
  • 文/花漫 我一把揭開白布淘这。 她就那樣靜靜地躺著,像睡著了一般巩剖。 火紅的嫁衣襯著肌膚如雪铝穷。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,541評論 1 305
  • 那天佳魔,我揣著相機與錄音曙聂,去河邊找鬼。 笑死鞠鲜,一個胖子當著我的面吹牛宁脊,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播贤姆,決...
    沈念sama閱讀 40,292評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼榆苞,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了霞捡?” 一聲冷哼從身側響起坐漏,我...
    開封第一講書人閱讀 39,211評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎碧信,沒想到半個月后赊琳,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,655評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡砰碴,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,846評論 3 336
  • 正文 我和宋清朗相戀三年躏筏,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片呈枉。...
    茶點故事閱讀 39,965評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡趁尼,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出猖辫,到底是詐尸還是另有隱情酥泞,我是刑警寧澤,帶...
    沈念sama閱讀 35,684評論 5 347
  • 正文 年R本政府宣布住册,位于F島的核電站婶博,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜凡人,卻給世界環(huán)境...
    茶點故事閱讀 41,295評論 3 329
  • 文/蒙蒙 一名党、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧挠轴,春花似錦传睹、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,894評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至启上,卻和暖如春邢隧,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背冈在。 一陣腳步聲響...
    開封第一講書人閱讀 33,012評論 1 269
  • 我被黑心中介騙來泰國打工倒慧, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人包券。 一個月前我還...
    沈念sama閱讀 48,126評論 3 370
  • 正文 我出身青樓纫谅,卻偏偏與公主長得像,于是被迫代替她去往敵國和親溅固。 傳聞我的和親對象是個殘疾皇子付秕,可洞房花燭夜當晚...
    茶點故事閱讀 44,914評論 2 355

推薦閱讀更多精彩內(nèi)容

  • Lua 5.1 參考手冊 by Roberto Ierusalimschy, Luiz Henrique de F...
    蘇黎九歌閱讀 13,797評論 0 38
  • 第一篇 語言 第0章 序言 Lua僅讓你用少量的代碼解決關鍵問題。 Lua所提供的機制是C不擅長的:高級語言侍郭,動態(tài)...
    testfor閱讀 2,670評論 1 7
  • 指令集 lua_capture_error_log lua_use_default_type lua_malloc...
    吃瓜的東閱讀 12,000評論 0 2
  • ¥開啟¥ 【iAPP實現(xiàn)進入界面執(zhí)行逐一顯】 〖2017-08-25 15:22:14〗 《//首先開一個線程询吴,因...
    小菜c閱讀 6,419評論 0 17
  • 曾先生的書架上有很多書,那天我想挑一本來看看励幼。又不知從哪本看起汰寓。他見我的選擇困難癥犯了,便隨手遞給我一本李尚龍的《...
    依米Ariel閱讀 170評論 0 0