luaJavaBridge详解
cocos2d-x技术群新群：117871561
c++技术交流群：593010226
此文章献给 苦于接sdk的猿类（参考某技术人员的博客）
要实现java与lua的相互操作 传统做法是先用 C/C++ 借助 JNI（Java Native Interface）编写调用 Java 的接口函数，然后再将这些函数通过 tolua++ 导出给 Lua 使用。这种做法最大的问题就是太繁琐，而且稍微有一点点修改，就要重新编译，严重降低了开发效率，我们可以用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代码示例(根据自己项目中爱贝支付简化版举例 )
java方法原型
//传入用户id,购买房卡数量，房卡价格，lua回调方法的引用（用于java调用lua）
public static void IaPay(finnal string Userid,final int count, final float Price ，final int luaFunc)
lua部分
--用于处理支付结果的回调函数
local function payCallBack(result)
if type(result) == "string" and result =="true"
then
updateBean()
end
end
调用java方法
function IaPay()
--args是调用java方法需要的参数
local args = {1,"234",5.0,payCallBack}
--sigs是方法的此签名
local sig = "(ILjava/lang/String;IFI)V"
--bridge_calss是调用java方法所在的java类 com.org.thirdParty中间的 . 换成 /
local bridge_class = "com/org/thirdParty"
--此处是调用java的静态方法iaPay
local ok,ret = luaj.callStaticMethod(bridge_class," IaPay",args,sigs)
end
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 方法的参数类型和返回类型定义。例如前面示例代码中 IaPay() 方法的签名是 "(ILjava/lang/String;IFI)V" 。
示例代码一共指定了 4 个参数，分别是：字符串、整型、浮点型、Lua function。
luaj 根据这 4 个参数，会构造出正确的 IaPay()方法签名。注意 Lua function 是以整数的形式传入 Java 方法，所以 Java 方法的第四个参数是 int 类型）。
签名使用“(依次排列的参数类型)返回值类型”的格式，几个例子如下：
签名
解释
()V
参数：无，返回值：无
(I)V
参数：int，返回值：无
(Ljava/lang/String;)Z
参数：字符串，返回值：布尔值
(IF)Ljava/lang/String;
参数：整数、浮点数，返回值：字符串
这里列出不同类型对应的 Java 签名字符串：
类型名
类型
I
整数，或者 Lua function
F
浮点数
Z
布尔值
Ljava/lang/String;
字符串
V
Void 空，仅用于指定一个 Java 方法不返回任何值
Java 方法里接收 Lua function 的参数必须定义为 int 类型
检查调用结果，并从 Java 方法获取返回值
luaj 调用 Java 方法时，可能会出现各种错误，因此 luaj 提供了一种机制让 Lua 调用代码可以确定 Java 方法是否成功调用。
luaj.callStaticMethod() 会返回两个值：
当成功时，第一个值为 true，第二个值是 Java 方法的返回值（如果有）。
当失败时，第一个值为 false，第二个值是错误代码。
下面的代码展示了如何检查返回结果和获得返回值：
Java 代码1
public static int AddTwoNumbers(final int number1, final int number2)
{ return number1 + number2;}
Lua 代码
local args = {2, 3}
local sig = "(II)I"
local ok, ret = luaj.callStaticMethod(className, "AddTwoNumbers", args, sig)
if not ok
then
print("luaj error:", ret)else print("ret:", ret)
-- 输出 ret: 5
end
错误代码定义如下：
错误代码
描述
-1
不支持的参数类型或返回值类型
-2
无效的签名
-3
没有找到指定的方法
-4
Java 方法执行时抛出了异常
-5
Java 虚拟机出错
-6
Java 虚拟机出错
~
将 Lua function 作为参数传递给 Java 方法
很多时候，我们需要一种方法让 Java 代码可以向 Lua 代码传递一些消息。例如在大部分游戏平台的 SDK 中，涉及支付的部分都是异步操作的。在支付操作结束后，Java 代码需要通知 Lua 支付成功与否。
Lua 虚拟机中，Lua function 以值的形式保存。但这个值无法直接给 Java 用，所以 luaj 做了一个 Lua function 引用表。当一个 Lua function 传递给 Java 时，这个 function 对应的值会被存在引用表中，并获得一个唯一的引用 ID （整数）。Java 代码拿到这个引用 ID 后，就可以很方便的调用该 Lua function 了。
回顾最开始的示例代码，GameInterface_doBilling() 函数用于接收 Lua function 的参数就是 int 类型。因为实际传入 Java 函数的值是 Lua function 的引用 Id。
~
在 Java 方法中调用 Lua function
在 Java 代码中拿到 Lua function 的引用 ID 后，就可以很方便的调用该 Lua function 了：
1
LuaJavaBridge.callLuaFunctionWithString(luaFunctionId, "hello");
这里出现的 LuaJavaBridge 是 luaj 的 Java 部分定义的工具 class。 callLuaFunctionWithString() 方法可以将一个字符串参数传递给指定的 Lua function。
LuaJavaBridge 还提供了 callLuaGlobalFunctionWithString() 方法，可以直接调用 Lua 中指定名字的全局函数。这样可以在没有 Lua function 引用 ID 的情况下和 Lua 代码交互。
GL 线程和 UI 线程的协调
cocos2d-x for Android 运行在多线程环境下，所以在 Lua 和 Java 交互时需要注意选择适当的线程。
~
cocos2d-x 在 Android 上以两个线程来运行，分别是负责图像渲染的 GL 线程和负责 Android 系统用户界面的 UI 线程。
在 cocos2d-x 启动后，Lua 代码将由 GL 线程调用，因此从 Lua 中调用的 Java 方法如果涉及到系统用户界面的显示、更新操作，那么就必须让这部分代码切换到 UI 线程上去运行。
反之亦然，从 Java 调用 Lua 代码时，需要让这个调用在 GL 线程上执行，否则 Lua 代码虽然执行了，但会无法更新 cocos2d-x 内部状态。
下面是 GameInterface_doBilling() 方法的主要代码：
public static void GameInterface_doBilling(final String billingIndex, final boolean useSms, final boolean isRepeated, final int luaFunctionId)
{
context.runOnUiThread(new Runnable()
{
@Override
public void run()
{
GameInterface.doBilling(useSms, isRepeated, billingIndex, new BillingCallback()
{
... @Override
public void onBillingSuccess()
{
context.runOnGLThread(new Runnable(
{
@Override
public void run()
{
LuaJavaBridge.callLuaFunctionWithString(luaFunctionId, "success"); LuaJavaBridge.releaseLuaFunction(luaFunctionId); } }); } ... }); } });}
方法中，构造了一个 Runnable 对象，用来包装需要执行的 Java 代码。这个 Runnable 对象被指定运行在 UI 线程上。这样当调用 GameInterface.doBilling() 方法时就可以正确显示出支付界面。
当用户支付成功后，GameInterface.doBilling() 会调用 BillingCallback.onBillingSuccess() 方法。这个方法里构造了另一个 Runnable 对象，包装了调用 Lua function 的代码。
看上去代码不少，实际上就是在两个线程间互相切换。确保 Lua function 跑在 GL 线程，Java 代码跑在 UI 线程。
Lua function 的引用计数器
Lua 虚拟机具有自动垃圾回收机制。Lua function 既然是值，那么在没有被使用时自然会被回收掉。所以 luaj 提供了 retainLuaFunction() 和 releaseLuaFunction() 两个函数用于增减 Lua function 的引用计数。
将一个 Lua function 以引用 ID 的形式传入 Java 时，luaj 会自动增加引用 ID 的计数器，所以在 Java 方法里可以放心的异步调用 Lua function。但在不需要使用该 Lua function 后，一定要调用 releaseLuaFunction() 减少该引用 ID 的计数器。当计数器为 0 时，会自动释放该 Lua function。
如果了解 cocos2d-x 中 CCObject 的 autorelease 机制，那么对引用计数应该很熟悉，两者是完全相同的实现机制。
~
连接第三方 SDK 和 cocos2d-x 的中间层
虽然 luaj 可以让开发者从 Lua 中直接调用 Java 代码。但大部分第三方 SDK 在初始化时都需要指定当前应用程序的 Activity 对象，并且还要切换不同线程，所以对于大多数第三方 SDK，我们仍然要写一个中间层用于 Lua 和 Java 的交互。
与使用 JNI 做中间层相比，配合 luja 的中间层是使用 Java 来编写的，不但更简单明了，而且处理线程切换也非常简单。
~
要实现一个中间层，只有两个步骤：
实现供 luaj 调用的 Java 接口
修改游戏的 Java 入口文件，将应用程序的 Activity 对象传入 SDK
第二步也相当简单，只需要在游戏的 onCreate() 中调用 中间层 class 的 setContext() 方法：
public class mygame extends Cocos2dxActivity {
protected void onCreate(Bundle savedInstanceState) {
ChinaMobile_SDK.setContext(this); // init sdk
super.onCreate(savedInstanceState);
}
...
}
安装 luaj
luaj 分为三个部分：
LuaJavaBridge.java, com_qeeplay_frameworks_LuaJavaBridge.h/.cpp - 供 Java 端使用的工具类，包含 Java 接口定义文件和 JNI 实现。
LuaJavaBridge.h/.cpp - 供 Lua 端使用的工具类。
luaj.lua - LuaJavaBridge 的 Lua 包装，提供更简单和灵活的接口。
下载地址：
Java/C++ 部分源代码
Lua 部分源代码
~
步骤：
将 LuaJavaBridge.java 添加到 Android 项目中；
修改 proj.android/jni/Android.mk：
LOCAL_SRC_FILES := ... \ luaj/jni/com_qeeplay_frameworks_LuaJavaBridge.cpp \ luaj/luabinding/LuaJavaBridge.cppLOCAL_C_INCLUDES := ... \ luaj
修改 AppDelegate.cpp，加入以下代码：
#if (CC_TARGET_PLATFORM == CC_PLATFORM_ANDROID)
#include "LuaJavaBridge.h"
#endif
bool AppDelegate::applicationDidFinishLaunching()
{
...
CCLuaEngine* pEngine = CCLuaEngine::defaultEngine();
CCScriptEngineManager::sharedManager()->setScriptEngine(pEngine);
#if (CC_TARGET_PLATFORM == CC_PLATFORM_ANDROID)
LuaJavaBridge_luabinding_open(pEngine->getLuaState());
#endif
...
}
修改proj.android/jni/hellocpp/main.cpp，加入以下代码：
jint JNI_OnLoad(JavaVM *vm, void *reserved){ ... LuaJavaBridge_setJavaVM(vm); return JNI_VERSION_1_4;}
luaj 方法参考
[Lua] luaj.callStaticMethod(className, methodName, args, methodSig)
调用指定的 Java class static method，允许传入 int/float/boolean/string/function 五种类型的参数。
[Java] LuaJavaBridge.callLuaFunctionWithString(int luaFunctionId, String value)
调用引用 ID 指向的 Lua function，并传入一个字符串作为参数。
[Java] LuaJavaBridge.callLuaGlobalFunctionWithString(int luaFunctionId, String value)
调用指定名字的 Lua 全局函数，并传入一个字符串作为参数。
[Java] LuaJavaBridge.retainLuaFunction(int luaFunctionId)
增加引用 ID 的计数，确保 Lua function 不会被 Lua 虚拟机自动回收。
[Java] LuaJavaBridge.releaseLuaFunction(int luaFunctionId)
减少引用 ID 的计数，当计数等于 0 时，引用 ID 指向的 Lua function 将被回收。
