原生實現C#和Lua相互呼叫-Unity3D可用

爆走de蘿蔔發表於2022-04-17
C#Unity3D

引言

    本篇簡單介紹如何在C#中執行Lua指令碼，傳遞資料到Lua中使用，以及Lua中呼叫C#匯出的方法等。在Unity中開發測試，並打IL2CPP的Android包在模擬器上執行通過。Lua版本使用的是Lua5.1.5。

一、編譯Lua動態連結庫

    1. 編譯Windows下使用的DLL檔案

        使用VS2015建立一個空的動態連結庫專案，刪除裡面預設建立的幾個檔案(如果想自定義擴充可用保留)，然後把Lua的原始碼拷貝進來，新增到專案工程中，編譯巨集需要配置LUA_BUILD_AS_DLL和_CRT_SECURE_NO_WARNINGS。然後就可以編譯x86和x64的DLL動態庫，整體步驟簡單易操作。

    2. 編譯Android下使用的SO檔案

        通過NDK編譯Android需要的so動態庫，因此需要手寫Application.mk和Android.mk兩個mk檔案，下面是我使用的兩個檔案的內容，建立放在上面VS的工程裡面即可，路徑是在lua原始碼src的上一層目錄。

# Application.mk
APP_PLATFORM = android-23
APP_ABI := armeabi-v7a arm64-v8a
APP_STL := stlport_shared

# Android.mk
LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)
MY_FILES_PATH  :=  $(LOCAL_PATH)/src
MY_FILES_SUFFIX := %.c
MY_UN_INCLUDE := %lua.c %luac.c
# 遞迴遍歷目錄下的所有的檔案
rwildcard=$(wildcard $1$2) $(foreach d,$(wildcard $1*),$(call rwildcard,$d/,$2))
# 獲取相應的原始檔
MY_ALL_FILES := $(foreach src_path,$(MY_FILES_PATH), $(call rwildcard,$(src_path),*.*) ) 
MY_SRC_LIST  := $(filter $(MY_FILES_SUFFIX),$(MY_ALL_FILES)) 
MY_SRC_LIST  := $(filter-out $(MY_UN_INCLUDE),$(MY_SRC_LIST)) 
MY_SRC_LIST  := $(MY_SRC_LIST:$(LOCAL_PATH)/%=%)
LOCAL_SRC_FILES = $(MY_SRC_LIST)
#列印編譯資訊
$(warning 'src_list='$(LOCAL_SRC_FILES))
LOCAL_MODULE    := CSharpLua
LOCAL_LDLIBS += -ldl
LOCAL_CFLAGS := $(L_CFLGAS)
include $(BUILD_SHARED_LIBRARY)

    將上面的mk檔案放置完成後，開啟CMD命令列，執行ndk編譯。由於並不是在Android的jni專案目錄，因此執行命令會有所不同，可以使用下面的命令執行生成，等待ndk執行完成後就生成了需要的so庫。

ndk-build NDK_PROJECT_PATH=. APP_BUILD_SCRIPT=./Android.mk NDK_APPLICATION_MK=./Application.mk

二、編寫C#使用的API

    1. 動態連結庫在Unity中的存放位置。

        在Unity專案Assets目錄裡面建立Plugins目錄，用於存放不同平臺的DLL庫。Windows需要的DLL存放的目錄為Assets/Plugins/x86和Assets/Plugins/x86_64；Android需要的SO檔案存放的目錄為Assets/Android/[libs/arm64-v8a]括號裡面的目錄其實就是上面NDK編譯後生成的路徑。

    2. 編寫C#的API[LuaDll.cs]

        大部分的動態庫中的介面直接使用以下這種方式即可使用，使用IntPtr來表示lua_State*物件，傳入引數char*可用使用byte[]或者string，但是會有一點點區別。

[DllImport("CSharpLua", EntryPoint = "luaL_newstate")]
public static extern IntPtr luaL_newstate();
[DllImport("CSharpLua", EntryPoint = "luaL_openlibs")]
public static extern void luaL_openlibs(IntPtr L);
[DllImport("CSharpLua", EntryPoint = "luaL_loadbuffer")]
public static extern int luaL_loadbuffer(IntPtr L, byte[] buff, uint size, string name);
[DllImport("CSharpLua", EntryPoint = "lua_call")]
public static extern void lua_call(IntPtr L, int nargs, int nresults);
[DllImport("CSharpLua", EntryPoint = "lua_pcall")]
public static extern int lua_pcall(IntPtr L, int nargs, int nresults, int errfunc);

　

 3.需要注意的幾個地方

        1. 返回char*時，不可直接使用string替換，否則呼叫會導致崩潰，因此需要像下面程式碼展示的那樣進行一下轉換才可以使用。

[DllImport("CSharpLua", EntryPoint = "lua_tolstring")]
private static extern IntPtr _lua_tolstring(IntPtr L, int idx, ref uint size);
public static string lua_tolstring(IntPtr L, int idx, ref uint size)
{
    IntPtr buffer = _lua_tolstring(L, idx, ref size);
    return Marshal.PtrToStringAnsi(buffer);
}

　　2. C#函式傳遞給Lua使用時，需要使用delegate委託型別。

public delegate int LuaFunction(IntPtr L);
[DllImport("CSharpLua", EntryPoint = "lua_pushcclosure")]
public static extern void lua_pushcclosure(IntPtr L, LuaFunction func, int idx);
public static void lua_pushcfunction(IntPtr L, LuaFunction func)
{
   lua_pushcclosure(L, func, 0);
}

　　3. 在lua原始碼中定義的巨集程式碼是無法使用的，會提示找不到，需要在C#中手動實現，例如下面展示的2個巨集。

#define lua_setglobal(L,s)  lua_setfield(L, LUA_GLOBALSINDEX, (s))
#define lua_getglobal(L,s)  lua_getfield(L, LUA_GLOBALSINDEX, (s))
[DllImport("CSharpLua", EntryPoint = "lua_getfield")]
public static extern void lua_getfield(IntPtr L, int idx, string s);
public static void lua_getglobal(IntPtr L, string s)
{
   lua_getfield(L, LUA_GLOBALSINDEX, s);
}
[DllImport("CSharpLua", EntryPoint = "lua_setfield")]
public static extern void lua_setfield(IntPtr L, int idx, string s);
public static void lua_setglobal(IntPtr L, string s)
{
   lua_setfield(L, LUA_GLOBALSINDEX, s);
}

　　4. 如需要將C#的類例項物件即userdata傳遞給lua，需要在C#中轉換成IntPtr後傳遞，Lua返回的則需要通過IntPtr轉換回C#的例項物件。

[DllImport("CSharpLua", EntryPoint = "lua_pushlightuserdata")]
public static extern void _lua_pushlightuserdata(IntPtr L, IntPtr p);
public static void lua_pushlightuserdata<T>(IntPtr L, T p)
{
    IntPtr obj = Marshal.GetIUnknownForObject(p);
    _lua_pushlightuserdata(L, obj);
}
[DllImport("CSharpLua", EntryPoint = "lua_touserdata")]
public static extern IntPtr _lua_touserdata(IntPtr L, int idx);
public static T lua_touserdata<T>(IntPtr L, int idx)
{
   IntPtr p = _lua_touserdata(L, idx);
   return (T)Marshal.GetObjectForIUnknown(p);
}

三、C#與Lua的相互呼叫舉例

    1. C#中建立Lua環境

IntPtr L = LuaDll.luaL_newstate();
LuaDll.luaL_openlibs(L);

　　2. 載入Lua程式碼並執行，呼叫Lua的函式及向Lua傳遞引數。

var data = Resources.Load<TextAsset>(lua_file);
int rc = LuaDll.luaL_loadbuffer(L, data.bytes, (uint)data.bytes.Length, lua_file);
rc = LuaDll.lua_pcall(L, 0, 0, 0)
LuaDll.lua_getglobal(L, "main");
// 傳遞引數
LuaDll.lua_pushinteger(L, 3333);
LuaDll.lua_pushnumber(L, 3.3);
// 執行main方法
int i = LuaDll.lua_pcall(L, 2, 0, 0);

　　3. 將C#函式提供給Lua使用，需要使用靜態方法參考上面LuaFunction的定義。

LuaDll.lua_pushcfunction(L, LuaPrint);
LuaDll.lua_setglobal(L, "print");
[MonoPInvokeCallback]   // 這個主要是在Android上需要。
static int LuaPrint(IntPtr L)
{
  Debug.Log(".....");
  return 0;
}

　　4. Lua程式碼呼叫C#方法並提供回撥，由C#函式呼叫。

static int FindAndBind(IntPtr L)
{
   GameObject go = LuaDll.lua_touserdata<GameObject>(L, 1);
   string path = LuaDll.lua_tostring(L, 2);
   // 這裡將lua的函式放到LUA_REGISTRYINDEX上
   int idx = LuaDll.luaL_refEx(L);
   Transform t = go.transform.Find(path);
   Button btn = t.GetComponent<Button>();
   btn.onClick.AddListener(delegate() {
     // 從LUA_REGISTRYINDEX棧獲取lua的函式進行執行。
     LuaDll.lua_rawgeti(L, LuaDll.LUA_REGISTRYINDEX, idx);
     LuaDll.lua_pcall(L, 0, 0, 0);
   });
   return 0;
}

四、總結

    總體來說互動呼叫還是比較的簡單方便，跟使用C/C++與Lua互動差不多。我僅僅簡單使用Lua原始碼進行編譯動態庫使用，可以方便的替換各個版本的lua進行使用。C#匯出方法給Lua使用也相對簡單，但是Unity中使用Lua的時候，不可能每個類例如GameObject、Transform等都手動寫匯出的程式碼給Lua使用。這塊就可以去看tolua、xlua的實現，需要考慮很多東西。

 

相關文章