Luaj学习笔记(二) - 在Lua中操作Java对象

Luaj学习笔记(二) - 在Lua中操作Java对象

前言

关于luajava中函数的使用说明，我并没有找到LuaJ的官方文档，但LuaJ为了兼容LuaJava所支持的Lua脚本，luajava库中的方法的参数用法都是一致的，因此可以一定程度的参考LuaJava的官方文档来学习LuaJ的使用。文章中引用的英文文档并不是LuaJ官方文档，仅做参考使用，这一点请一定要注意！

luajava库介绍

我们之所以选用由Java实现的解释器执行Lua脚本，最主要的原因就是看中LuaJ能将Java与Lua代码无缝连接，既能获得Java的性能又兼有了Lua脚本语言的灵活。而实现这一桥梁工作的则是LuaJ创建的一个名为 luajava 的Lua库。

LuaJ源码中org.luaj.vm2.lib.jse.LuajavaLib类中初始化时加载 luajava 库的源代码：

luajava提供了5种方法用以实现Lua脚本对Java类和对象的操作，方法名称在源码中的字符串数组定义如下图所示：

从源码中可以看到，luajava 所提供了5种方法分明名为： bindClas 、 newInstance 、 new 、 createProxy 、 loadLib 。

luajava库的方法

newInstance方法

newInstance方法帮助开发者通过Java类的全名创建一个新的Java对象并返回一个Java对象的引用，开发者可以在Lua脚本中以面向对象的方式操作该引用。

参数说明

newInstance 方法的使用有以下两种方式：

javaObject = luajava.newInstance(类名全称)
javaObject = luajava.newInstance(类名全称,[构造方法参数(可变参数)])

示例代码

Java代码：

package pers.landriesnidis.testluaj;

public class Dog {
    private String name;
    public Dog() {}
    public Dog(String name) {this.name = name;}
    public String getName() {return name;}
    public void setName(String name) {this.name = name;0}
}

Lua代码：

 --luajava.newInstance(类名全称)

 --创建一个java对象
 local dog = luajava.newInstance("pers.landriesnidis.testluaj.Dog")
 --调用dog的setName方法
 dog:setName("Jack")
 --调用dog的getName()方法
 print(dog:getName())

 --luajava.newInstance(类名全称,[构造方法参数(可变参数)])

 --创建一个java对象并为构造方法提供参数
 local dog = luajava.newInstance("pers.landriesnidis.testluaj.Dog","Jack")
 --调用dog的getName()方法
 print(dog:getName())

---

bindClass方法

bindClass方法的作用是检索与className对应的Java类，并返回一个可用于访问相应类中静态字段和静态方法的对象。

参数说明

使用的语法如下：

javaClass = luajava.bindClass(类名全称)

示例代码

Java代码：

package pers.landriesnidis.testluaj;

public class Test{
    public static void sayHello(){
        System.out.println("Hello,World!");
    }
}

Lua代码：

local javaClass = luajava.bindClass("pers.landriesnidis.testluaj.Test")
javaClass:sayHello()

---

new方法

new方法通过接受一个Java类实例化一个新的对象。他的工作原理与newInstance方法相近，不同的一点是new方法所接受的第一个参数是Java类的Lua实例（通过bindClass方法获得的Java类）。

通过LuaJ在实例化Java时的源代码可以看出new方法与newInstance方法之间的关系：

newInstance方法是通过包含完整类名的字符串查找到的对应Java类，而new则是从类实例中直接获取了对应Java类。

参数说明

使用的语法如下：

javaObject = luajava.new(类实例)
javaObject = luajava.new(类实例,[构造方法参数(可变参数)])

示例代码

--通过`bindClass`方法获得的Java类
Str = luajava.bindClass("java.lang.String")
--使用luajava.new()方法实例化Java对象
strInstance = luajava.new(Str)

---

createProxy方法

LuaJava官方文档对createProxy方法的说明：

We can also, instead of creating a Java object to be manipulated by Lua, create a Lua object that will be manipulated by Java. We can do that in LuaJava by creating a proxy to that object. This is done by the createProxy function.
The function createProxy returns a java Object reference that can be used as an implementation of the given interface.
createProxy receives a string that contain the names of the interfaces to be implemented, separated by a comma(,), and a lua object that is the interface implementation.

我觉得官方的解释也太过抽象，大致的意思就是createProxy方法可以用来实现Java接口中定义的方法。

参数说明

createProxy方法接收两个参数，分别是接口的全称和一个包含于接口相同方法的Lua对象。

proxy = createProxy(interfaceNames, luaObject)

示例代码

使用Lua创建一个 AWT窗体，在窗体上添加一个按钮并为按钮设置一个单击即退出的按钮监听事件。
Lua代码如下：

    frame = luajava.newInstance("java.awt.Frame", "createProxy test")  
    exit_bt = luajava.newInstance("java.awt.Button", "Exit")  
    frame:setSize(600,300)  

    BorderLayout = luajava.bindClass("java.awt.BorderLayout")  

    frame:add(BorderLayout.CENTER, exit_bt)
    frame:pack()  
    frame:show()  

    exit_cb = { actionPerformed=function (ev)  
            frame:setVisible(false)  
            frame:dispose()  
        end  
    }  
    exit_jproxy = luajava.createProxy("java.awt.event.ActionListener" ,exit_cb)  
    exit_bt:addActionListener(exit_jproxy)  

运行结果的截图如下：

---

loadLib方法

loadLib方法的用途类似于Lua中的loadLib函数。通过loadLib方法可以将开发者用Java编写的库加载到Lua中去。
LuaJava官方文档中对loadLib方法参数和返回值的说明：

What loadLib does is call a static function in a given class and execute a given method, which should receive LuaState as parameter. If this function returns a integer, LuaJava takes it as the number of parameters returned by the the function, otherwise nothing is returned.

在LuaJava中，loadLib所做的是在给定的类中调用静态函数并执行给定的方法，该方法应该接收LuaState作为参数。如果这个函数返回一个整数，LuaJava将它作为函数返回的参数数，否则什么也不返回。
LuaJava提供的loadLib方法的示例代码如下：

但LuaJ中并没有提供以上代码所用到的与LuaJava相仿相近的类型（LuaState、LuaException、LuaException、JavaFunction等），并且非常不幸的是我也没能找到LuaJ中是如何实现loadLib方法的资料和代码。
如果有关于loadLib方法的资料请留言或私信我，不足之处也欢迎在评论区斧正，交流。