Java与lua互相调用简单教程

在某些业务场景下，我们可能会遇到 lua 中要调用 java 代码情况，当然这个用 JNI 肯定是可以做到的，但是有更加方便的办法：LuaJavaBridge（LuaJava）和 LuaJ。

luaj 主要特征

• 可以从 Lua 调用 Java Class Static Method
• 调用 Java 方法时，支持 int/float/boolean/String/Lua function 五种参数类型
• 可以将 Lua function 作为参数传递给 Java，并让 Java 保存 Lua function 的引用
• 可以从 Java 调用 Lua 的全局函数，或者调用引用指向的 Lua function

luaj 的功能很简单，但对于集成各种 SDK 来说已经完全满足需求了。

基于 Spring Boot + MyBatis Plus + Vue & Element 实现的后台管理系统 + 用户小程序，支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能

• 项目地址：https://gitee.com/zhijiantianya/ruoyi-vue-pro
• 视频教程：https://doc.iocoder.cn/video/

luaj 用法示例

Java 方法原型：

publicstaticfloatgetNum(floatn){
returnn;
}

lua 调用示例：

--Java类的名称
localclassName="com/xttblog/Test"
--调用的Java方法名
localmethod='getNum'
--调用Java方法需要的参数
localn=10
localargs={
n
}
--调用Java方法
local_,testStaticMethod=luaj.callStaticMethod(className,method,args)

基于 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 实现的后台管理系统 + 用户小程序，支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能

• 项目地址：https://gitee.com/zhijiantianya/yudao-cloud
• 视频教程：https://doc.iocoder.cn/video/

luaj 实现原理

luaj 的核心目标有两个：从 Lua 调用 Java, 从 Java 调用 Lua。整理出来就是如下几点

• 查找并调用指定的 Java 方法
• 检查调用结果，并从 Java 方法获取返回值
• 将 Lua function 作为参数传递给 Java 方法
• 在 Java 方法中调用 Lua function

查找并调用指定的 Java 方法

JNI 提供了 FindClass() 方法用于查找指定的 Class，所以 luaj.callStaticMethod() 的第一个参数就是要调用的 Java Class 的完整类名称（类名称中的“.”要替换为“/”）。

找到指定 Class 后，利用 JNI 的 GetStaticMethodID() 方法就可以找到这个类的指定静态方法，前提是要提供静态方法的名称和签名。

所谓签名，就是指Java方法的参数类型和返回类型定义。方法的签名就是类似(Ljava/lang/String;ZZI)V这样的一串描述，通过字节码方式可以查看，如下示例：

关于 Java 方法签名的具体定义，可以参考：JNI Type Signatures。

这里要说的是 luaj 可以根据调用参数自动猜测方法签名所以示例中我们并没有写签名。

示例中指定参数：

localargs={n}

luaj 根据这 个参数，会构造出正确的方法签名。

注意：这里要说的是 Lua 里没有办法准确判断一个数值是整数还是浮点数，所以 luaj 在猜测方法签名时，假定所有的数值都是浮点数。所以下面调用会报错：

publicstaticintgetNum(intn){
returnn;
}

--Java类的名称
localclassName="com/xttblog/Test"
--调用的Java方法名
localmethod='getNum'
--调用Java方法需要的参数
localn=10
localargs={
n
}
--调用Java方法
local_,testStaticMethod=luaj.callStaticMethod(className,method,args)

这样是不行的，所以这个时候我们要自己定义签名。

下面给出正确的示例

publicstaticintgetNum(intn){
returnn;
}
--Java类的名称
localclassName="com/xttblog/Test"
--调用的Java方法名
localmethod='getNum'
--调用Java方法需要的参数
localn=10
localargs={
n
}
--定义签名--参数:[I]nteger--返回值:[I]nt
localsig="(I)I"
--调用Java方法
local_,testStaticMethod=luaj.callStaticMethod(className,method,args，sig)

签名使用“(依次排列的参数类型)返回值类型”的格式，几个例子如下：

签名解释
()V 参数：无，返回值：无
(I)V 参数：int，返回值：无
(Ljava/lang/String;)Z 参数：字符串，返回值：布尔值
(IF)Ljava/lang/String;参数：整数、浮点数，返回值：字符串

这里列出不同类型对应的 Java 签名字符串：

类型名类型
I整数，或者Luafunction
F浮点数
Z布尔值
Ljava/lang/String;字符串
VVoid空，仅用于指定一个Java方法不返回任何值

Java 方法里接收 Lua function 的参数必须定义为 int 类型

从 Java 方法获取返回值

luaj 会检查调用结果，并从 Java 方法获取返回值。

luaj 调用 Java 方法时，可能会出现各种错误，因此 luaj 提供了一种机制让 Lua 调用代码可以确定 Java 方法是否成功调用。

luaj.callStaticMethod()会返回两个值：

• 当成功时，第一个值为 true，第二个值是 Java 方法的返回值（如果有）。
• 当失败时，第一个值为 false，第二个值是错误代码。

下面的代码展示了如何检查返回结果和获得返回值：

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不支持的参数类型或返回值类型
-2无效的签名
-3没有找到指定的方法
-4Java方法执行时抛出了异常
-5Java虚拟机出错
-6Java虚拟机出错

将 Lua function 作为参数传递给 Java 方法

Lua 虚拟机中，Lua function 以值的形式保存。但这个值无法直接给 Java 用，所以 luaj 做了一个 Lua function 引用表。当一个 Lua function 传递给 Java 时，这个 function 对应的值会被存在引用表中，并获得一个唯一的引用 ID （整数）。Java 代码拿到这个引用 ID 后，就可以很方便的调用该 Lua function 了。

所以 Java 方法里接收 Lua function 的参数必须定义为 int 类型。

示例：

publicstaticintgetNum(intn){
returnn;
}

localfunctioncallback(result)
---方法内容
end
--Java类的名称
localclassName="com/xttblog/Test"
--调用的Java方法名
localmethod='getNum'
--调用Java方法需要的参数
localargs={
callback
}
--定义签名--参数:[I]nteger--返回值:[I]nt
localsig="(I)I"
--调用Java方法
local_,testStaticMethod=luaj.callStaticMethod(className,method,args，sig)

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

‍然后直接把 lua 代码当做 String 字符串内嵌到 Java 代码中：

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

也可以创建一个 login.lua 脚本，内容如下：

--无参函数
functionhello()
print'hello'
end
--带参函数
functiontest(str)
print('datafromjavais:'..str)
return'haha'
end

然后，Java先载入login.lua脚本并编译，然后再获取指定名称的函数，无参的直接使用call()方法调用，带参的需要通过invoke(LuaValue[])传入参数表：

StringluaPath="res/lua/login.lua";//lua脚本文件所在路径
Globalsglobals=JsePlatform.standardGlobals();
//加载脚本文件login.lua，并编译
globals.loadfile(luaPath).call();
//获取无参函数hello
LuaValuefunc=globals.get(LuaValue.valueOf("hello"));
//执行hello方法
func.call();
//获取带参函数test
LuaValuefunc1=globals.get(LuaValue.valueOf("test"));
//执行test方法,传入String类型的参数参数
Stringdata=func1.call(LuaValue.valueOf("I'amfromJava!")).toString();
//打印lua函数回传的数据
Logger.info("datareturnfromluais:"+data);

运行结果如下：

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