在Java方法中調(diào)用Lua function

luaj 主要特征

luaj 用法示例

luaj 實現(xiàn)原理

查找并調(diào)用指定的 Java 方法

從 Java 方法獲取返回值

將 Lua function 作為參數(shù)傳遞給 Java 方法

在某些業(yè)務(wù)場景下，我們可能會遇到 lua 中要調(diào)用 java 代碼情況，當然這個用 JNI 肯定是可以做到的，但是有更加方便的辦法：LuaJavaBridge（LuaJava）和 LuaJ。

luaj 主要特征

可以從 Lua 調(diào)用 Java Class Static Method

調(diào)用 Java 方法時，支持 int/float/boolean/String/Lua function 五種參數(shù)類型

可以將 Lua function 作為參數(shù)傳遞給 Java，并讓 Java 保存 Lua function 的引用

可以從 Java 調(diào)用 Lua 的全局函數(shù)，或者調(diào)用引用指向的 Lua function

luaj 的功能很簡單，但對于集成各種 SDK 來說已經(jīng)完全滿足需求了。

基于 Spring Boot + MyBatis Plus + Vue & Element 實現(xiàn)的后臺管理系統(tǒng) + 用戶小程序，支持 RBAC 動態(tài)權(quán)限、多租戶、數(shù)據(jù)權(quán)限、工作流、三方登錄、支付、短信、商城等功能

luaj 用法示例

Java 方法原型：

publicstaticfloatgetNum(floatn){
returnn;
}

lua 調(diào)用示例：

--Java類的名稱
localclassName="com/xttblog/Test"
--調(diào)用的Java方法名
localmethod='getNum'
--調(diào)用Java方法需要的參數(shù)
localn=10
localargs={
n
}
--調(diào)用Java方法
local_,testStaticMethod=luaj.callStaticMethod(className,method,args)

基于 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 實現(xiàn)的后臺管理系統(tǒng) + 用戶小程序，支持 RBAC 動態(tài)權(quán)限、多租戶、數(shù)據(jù)權(quán)限、工作流、三方登錄、支付、短信、商城等功能

luaj 實現(xiàn)原理

luaj 的核心目標有兩個：從 Lua 調(diào)用 Java, 從 Java 調(diào)用 Lua。整理出來就是如下幾點

查找并調(diào)用指定的 Java 方法

檢查調(diào)用結(jié)果，并從 Java 方法獲取返回值

將 Lua function 作為參數(shù)傳遞給 Java 方法

在 Java 方法中調(diào)用 Lua function

查找并調(diào)用指定的 Java 方法

JNI 提供了 FindClass() 方法用于查找指定的 Class，所以 luaj.callStaticMethod() 的第一個參數(shù)就是要調(diào)用的 Java Class 的完整類名稱（類名稱中的“.”要替換為“/”）。

找到指定 Class 后，利用 JNI 的 GetStaticMethodID() 方法就可以找到這個類的指定靜態(tài)方法，前提是要提供靜態(tài)方法的名稱和簽名。

所謂簽名，就是指Java方法的參數(shù)類型和返回類型定義。方法的簽名就是類似(Ljava/lang/String;ZZI)V這樣的一串描述，通過字節(jié)碼方式可以查看，如下示例：

關(guān)于 Java 方法簽名的具體定義，可以參考：JNI Type Signatures。

這里要說的是 luaj 可以根據(jù)調(diào)用參數(shù)自動猜測方法簽名所以示例中我們并沒有寫簽名。

示例中指定參數(shù)：

localargs={n}

luaj 根據(jù)這 個參數(shù)，會構(gòu)造出正確的方法簽名。

注意：這里要說的是 Lua 里沒有辦法準確判斷一個數(shù)值是整數(shù)還是浮點數(shù)，所以 luaj 在猜測方法簽名時，假定所有的數(shù)值都是浮點數(shù)。所以下面調(diào)用會報錯：

publicstaticintgetNum(intn){
returnn;
}

--Java類的名稱
localclassName="com/xttblog/Test"
--調(diào)用的Java方法名
localmethod='getNum'
--調(diào)用Java方法需要的參數(shù)
localn=10
localargs={
n
}
--調(diào)用Java方法
local_,testStaticMethod=luaj.callStaticMethod(className,method,args)

這樣是不行的，所以這個時候我們要自己定義簽名。

下面給出正確的示例

publicstaticintgetNum(intn){
returnn;
}
--Java類的名稱
localclassName="com/xttblog/Test"
--調(diào)用的Java方法名
localmethod='getNum'
--調(diào)用Java方法需要的參數(shù)
localn=10
localargs={
n
}
--定義簽名--參數(shù):[I]nteger--返回值:[I]nt
localsig="(I)I"
--調(diào)用Java方法
local_,testStaticMethod=luaj.callStaticMethod(className,method,args，sig)

簽名使用“(依次排列的參數(shù)類型)返回值類型”的格式，幾個例子如下：

簽名解釋
()V 參數(shù)：無，返回值：無
(I)V 參數(shù)：int，返回值：無
(Ljava/lang/String;)Z 參數(shù)：字符串，返回值：布爾值
(IF)Ljava/lang/String;參數(shù)：整數(shù)、浮點數(shù)，返回值：字符串

這里列出不同類型對應的 Java 簽名字符串：

類型名類型
I整數(shù)，或者Luafunction
F浮點數(shù)
Z布爾值
Ljava/lang/String;字符串
VVoid空，僅用于指定一個Java方法不返回任何值

Java 方法里接收 Lua function 的參數(shù)必須定義為 int 類型

從 Java 方法獲取返回值

luaj 會檢查調(diào)用結(jié)果，并從 Java 方法獲取返回值。

luaj 調(diào)用 Java 方法時，可能會出現(xiàn)各種錯誤，因此 luaj 提供了一種機制讓 Lua 調(diào)用代碼可以確定 Java 方法是否成功調(diào)用。

luaj.callStaticMethod()會返回兩個值：

當成功時，第一個值為 true，第二個值是 Java 方法的返回值（如果有）。

當失敗時，第一個值為 false，第二個值是錯誤代碼。

下面的代碼展示了如何檢查返回結(jié)果和獲得返回值：

publicstaticintAddTwoNumbers(finalintnumber1,finalintnumber2){
returnnumber1+number2;
}

Lua代碼

localargs={2,3}
localsig="(II)I"
localok,ret=luaj.callStaticMethod(className,"AddTwoNumbers",args,sig)

ifnotokthen
print("luajerror:",ret)
else
print("ret:",ret)--輸出ret:5
end

錯誤代碼定義如下：

錯誤代碼描述
-1不支持的參數(shù)類型或返回值類型
-2無效的簽名
-3沒有找到指定的方法
-4Java方法執(zhí)行時拋出了異常
-5Java虛擬機出錯
-6Java虛擬機出錯

將 Lua function 作為參數(shù)傳遞給 Java 方法

Lua 虛擬機中，Lua function 以值的形式保存。但這個值無法直接給 Java 用，所以 luaj 做了一個 Lua function 引用表。當一個 Lua function 傳遞給 Java 時，這個 function 對應的值會被存在引用表中，并獲得一個唯一的引用 ID （整數(shù)）。Java 代碼拿到這個引用 ID 后，就可以很方便的調(diào)用該 Lua function 了。

所以 Java 方法里接收 Lua function 的參數(shù)必須定義為 int 類型。

示例：

publicstaticintgetNum(intn){
returnn;
}

localfunctioncallback(result)
---方法內(nèi)容
end
--Java類的名稱
localclassName="com/xttblog/Test"
--調(diào)用的Java方法名
localmethod='getNum'
--調(diào)用Java方法需要的參數(shù)
localargs={
callback
}
--定義簽名--參數(shù):[I]nteger--返回值:[I]nt
localsig="(I)I"
--調(diào)用Java方法
local_,testStaticMethod=luaj.callStaticMethod(className,method,args，sig)

另外，LuaJ 也很好用。只需引入 pom。

?然后直接把 lua 代碼當做 String 字符串內(nèi)嵌到 Java 代碼中：

StringluaStr="print'hello,world!'";
Globalsglobals=JsePlatform.standardGlobals();
LuaValuechunk=globals.load(luaStr);
chunk.call();

也可以創(chuàng)建一個 login.lua 腳本，內(nèi)容如下：

--無參函數(shù)
functionhello()
print'hello'
end
--帶參函數(shù)
functiontest(str)
print('datafromjavais:'..str)
return'haha'
end

然后，Java先載入login.lua腳本并編譯，然后再獲取指定名稱的函數(shù)，無參的直接使用call()方法調(diào)用，帶參的需要通過invoke(LuaValue[])傳入?yún)?shù)表：

StringluaPath="res/lua/login.lua";//lua腳本文件所在路徑
Globalsglobals=JsePlatform.standardGlobals();
//加載腳本文件login.lua，并編譯
globals.loadfile(luaPath).call();
//獲取無參函數(shù)hello
LuaValuefunc=globals.get(LuaValue.valueOf("hello"));
//執(zhí)行hello方法
func.call();
//獲取帶參函數(shù)test
LuaValuefunc1=globals.get(LuaValue.valueOf("test"));
//執(zhí)行test方法,傳入String類型的參數(shù)參數(shù)
Stringdata=func1.call(LuaValue.valueOf("I'amfromJava!")).toString();
//打印lua函數(shù)回傳的數(shù)據(jù)
Logger.info("datareturnfromluais:"+data);

運行結(jié)果如下：

hello
datafromjavais:I'amfromJava!
八月07,2022525下午com.tw.login.tools.Loggerinfo
信息: lua return data：haha

審核編輯：劉清