在这篇文章中,我们将带领您了解LuaJavaBridge-Lua与Java互操作的简单解决方案的全貌,包括lua和java的相关情况。同时,我们还将为您介绍有关C++程序嵌Lua(基于LuaBridg
在这篇文章中,我们将带领您了解LuaJavaBridge - Lua 与 Java 互操作的简单解决方案的全貌,包括lua和java的相关情况。同时,我们还将为您介绍有关C++ 程序嵌 Lua(基于 LuaBridge)、CCLuaObjcBridge - Lua 与 Objective-C 互操作的简单解决方案、cocos2d-x lua LuaJavaBridge、Cocos2d-x中LuaJavaBridge使用方法的知识,以帮助您更好地理解这个主题。
本文目录一览:- LuaJavaBridge - Lua 与 Java 互操作的简单解决方案(lua和java)
- C++ 程序嵌 Lua(基于 LuaBridge)
- CCLuaObjcBridge - Lua 与 Objective-C 互操作的简单解决方案
- cocos2d-x lua LuaJavaBridge
- Cocos2d-x中LuaJavaBridge使用方法
LuaJavaBridge - Lua 与 Java 互操作的简单解决方案(lua和java)
LuaJavaBridge - Lua 与 Java 互操作的简单解决方案
Table of Contents
- luaj 主要特征
- luaj 用法示例
-
luaj 实现原理
- 查找并调用指定的 Java 方法
- 检查调用结果,并从 Java 方法获取返回值
- 将 Lua function 作为参数传递给 Java 方法
- 在 Java 方法中调用 Lua function
-
GL 线程和 UI 线程的协调
- Lua function 的引用计数器
- 连接第三方 SDK 和 cocos2d-x 的中间层
- 安装 luaj
- luaj 方法参考
- 未来改进
- 关于 quick-cocos2d-x
最近在游戏里要集成中国移动的 SDK,而这些 SDK 都是用 Java 编写的。由于我们整个游戏都是使用 Lua 开发的,所以就面对 Lua 与 Java 互操作的问题。
传统做法是先用 C/C++ 借助 JNI(Java Native Interface)编写调用 Java 的接口函数,然后再将这些函数通过 tolua++ 导出给 Lua 使用。这种做法最大的问题就是太繁琐,而且稍微有一点点修改,就要重新编译,严重降低了开发效率。
我尝试写了几个接口函数后,发现 JNI 提供了完善的接口来操作 Java,比如查找特定的 Class、Method 等等。既然有这些东西,我想完全可以实现一个很薄的转接层。这个层会提供一些函数,让 Lua 代码可以直接调用到 Java 的方法。
经过一番努力,LuaJavaBridge(简称 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 来说已经完全满足需求了。
luaj 用法示例
下面的代码是我们游戏中实际使用的中国移动支付 SDK 调用代码,luaj 好不好用一目了然:
Lua 代码:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
--[[ 购买 1000 金币 Java 方法原型: public static void GameInterface_dobilling(final String billingIndex, final boolean useSms, final boolean isRepeated, final int luaFunctionId) ]] -- 用于处理支付结果的函数 local function callback(result) if result == "success" then game.state:increaseCoins(1000) game.state:save() end end -- 调用 Java 方法需要的参数 local args = { "001", -- billingIndex true, -- useSms true, -- isRepeated callback -- luaFunctionId } -- Java 类的名称 local className = "com/qeeplay/frameworks/ChinaMobile_SDK" -- 调用 Java 方法 luaj.callStaticmethod(className, "GameInterface_dobilling", args) |
上面的代码就不解释了,注释已经写得非常明白。
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 方法的参数类型和返回类型定义。例如前面示例代码中 GameInterface_dobilling() 方法的签名是 (Ljava/lang/String;ZZI)V 。关于 Java 方法签名的具体定义,可以参考:JNI Type Signatures。
由于签名写起来有点啰嗦,所以 luaj 可以根据调用参数自动猜测方法签名。示例代码中,luaj.callStaticmethod() 的第二个参数指定了要查找的方法名称,但并没有提供方法的签名,这就是利用了 luaj 的自动猜测签名功能。
示例代码一共指定了 4 个参数,分别是:字符串、布尔值、布尔值、Lua function。
1 2 3 4 5 6 7 |
-- 调用 Java 方法需要的参数 local args = { "001", -- billingIndex true, -- useSms true, -- isRepeated callback -- luaFunctionId } |
luaj 根据这 4 个参数,会构造出正确的 GameInterface_dobilling() 方法签名。注意 Lua function 是以整数的形式传入 Java 方法,所以 Java 方法的第四个参数是 int 类型)。
不幸的是 Lua 里没有办法准确判断一个数值是整数还是浮点数,所以 luaj 在猜测方法签名时,假定所有的数值都是浮点数。因此下面的代码第二个调用就会失败:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
local args = {1} -- 生成的方法签名是 (F)V --[[ Java 方法原型: public static void TestMethod1(final float integerValue) ]] -- 调用成功 luaj.callStaticmethod(className, "TestMethod1", args) --[[ Java 方法原型: public static void TestMethod2(final int integerValue) ]] -- 调用失败,正确的方法签名应该是 (I)V luaj.callStaticmethod(className, "TestMethod2", args) |
为此,luaj 允许开发者指定完整的方法签名。而且除了整数和浮点数的情况,在需要从 Java 方法获得返回值时,也需要开发者指定完整的方法签名。示例代码如下:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
local args ={"StringValue", 1, 3.14} --[[ Java 方法原型: public static int TestMethod3(final String stringValue, final int integerValue, final float floatValue) ]] -- 定义签名 -- 参数: [S]tring,[I]nteger,[F]loat -- 返回值: [I]nt local sig = "(Ljava/lang/String;IF)I" -- 调用方法并获得返回值 local ok, ret = luaj.callStaticmethod(className, "TestMethod3", args, sig) |
~
签名使用“(依次排列的参数类型)返回值类型”的格式,几个例子如下:
签名 |
解释 |
()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 类型,具体原因详见“将 Lua function 作为参数传递给 Java 方法”小节。
~
检查调用结果,并从 Java 方法获取返回值
luaj 调用 Java 方法时,可能会出现各种错误,因此 luaj 提供了一种机制让 Lua 调用代码可以确定 Java 方法是否成功调用。
luaj.callStaticmethod() 会返回两个值:
- 当成功时,第一个值为 true,第二个值是 Java 方法的返回值(如果有)。
- 当失败时,第一个值为 false,第二个值是错误代码。
下面的代码展示了如何检查返回结果和获得返回值:
Java 代码
1 2 3 4 |
public static int AddTwoNumbers(final int number1, final int number2) { return number1 + number2; } |
Lua 代码
1 2 3 4 5 6 7 8 9 |
local args = {2, 3} local sig = "(II)I" local ok, "AddTwoNumbers", 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 代码交互。
由于自己的项目暂时没更多需求,所以目前 luaj 只支持向 Lua function 传递单个字符串参数。
~
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() 方法的主要代码:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 |
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
第一步请参考:“中国移动游戏基地和短信支付 SDK”中间层源代码
第二步也相当简单,只需要在游戏的 onCreate() 中调用 中间层 class 的 setContext() 方法:
1 2 3 4 5 6 7 8 9 10 |
public class mygame extends Cocos2dxActivity { protected void onCreate(Bundle savedInstanceState) { ChinaMobile_SDK.setContext(this); // init sdk super.onCreate(savedInstanceState); } ... } |
~
做好一切准备工作后,在游戏的 Lua 代码里访问 SDK 功能就很简单了:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
local luaj = require("luaj") local className = "com/qeeplay/frameworks/ChinaMobile_SDK" -- 初始化 SDK local args = { CHINA_MOBILE_SP_APP_NAME, CHINA_MOBILE_SP_CP_NAME, CHINA_MOBILE_SP_TEL } luaj.callStaticmethod(className, "GameInterface_initializeApp", args) -- 支付 local function callback(result) if result == "success" then -- 支付成功 end end local args = { billingIndex, true, callback } luaj.callStaticmethod(className, args) -- 显示游戏基地界面 luaj.callStaticmethod(className, "GameCommunity_launchGameCommunity") -- 提交玩家的游戏成绩 local args = { "0", -- 排行榜Id newBestscores, -- 新的最佳成绩 } local sig = "(Ljava/lang/String;I)V" luaj.callStaticmethod(className, "GameCommunity_commitscoreWithRank", sig) |
~
安装 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:
1 2 3 4 5 6 |
LOCAL_SRC_FILES := ... \ luaj/jni/com_qeeplay_frameworks_LuaJavaBridge.cpp \ luaj/luabinding/LuaJavaBridge.cpp LOCAL_C_INCLUDES := ... \ luaj |
- 修改 AppDelegate.cpp,加入以下代码:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
#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,加入以下代码:
1 2 3 4 5 6 7 8 9 |
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 将被回收。
~
未来改进
因为我们自己的项目暂时还没有更复杂的需求,所以 luaj 目前的实现很简单。但要在这个基础上进行完善是很容易的事情,luaj 已经解决了几个关键性问题。
未来计划会增加的主要特性就是支持更多的类型,例如将一个以字符串为键名的 Lua table 以 Java Map 集合的形式传递给 Java。同样,从 Java 调用 Lua 函数时,也应该支持多个参数,以及更多的参数类型。
至于将 Java 对象传入 Lua,并在 Lua 中调用 Java 对象的方法,目前没这个打算。因为 luaj 的主要目的是为 cocos2d-x 游戏服务,而 cocos2d-x 的多线程模式要求 Lua 和 Java 代码必须在不同的线程里运行。如果在 Lua 中调用 Java 对象方法将面对许多复杂的问题。与其花大量时间去解决这个问题(还不一定能保证最后简单易用),不如简单写一个中间层。
最后,luaj 已经被集成到了 quick-cocos2d-x 这个基于 cocos2d-x 的快速游戏开发引擎中。quick-cocos2d-x 让开发者可以使用 Lua 语言开发高质量的商业游戏,同时又保持 cocos2d-x 的高性能、开放性、可扩展能力。并且 quick-cocos2d-x 使用最新的 LuaJIT 实现,可以让 Lua 脚本获得数倍到数十倍的性能提升。
惯例为广大程序猿送上福利美图一张 :-)
~
关于 quick-cocos2d-x
LuaJavaBridge 已经集成到 quick-cocos2d-x 这个开源项目中,用法说明 .
quick-cocos2d-x 是一个可以让您觉得“爽快”的 cocos2d-x 的扩展版。基于 cocos2d-x,完全的跨平台能力、优异的性能和可靠性。而 quick-cocos2d-x 在这一切的基础上,添加了完善的 Lua 脚本语言支持,让开发者可以使用 Lua 这种简单易用的脚本语言完成商业品质的移动游戏。
https://github.com/dualface/quick-cocos2d-x
- EOF -
C++ 程序嵌 Lua(基于 LuaBridge)
配置文件搞不定的,就得依赖脚本。C++ 程序想嵌点脚本,Lua 几乎是首选。
Lua 的源码自带 Makefile
,可以编译出静态库、解释器、编译器三个目标文件,作为宿主的 C++ 程序,除了要包含 Lua 头文件,还应该链接这个静态库。
如果 C++ 程序是由 CMake 来构建的,那么用 CMake 为 Lua 创建一个静态库,也不是什么难事。CMake 很好的解决了跨平台的问题。
其实脚本扩展的问题只有两个:一、怎么让 Lua 访问 C++ 对象?二、怎么让 C++ 访问 Lua 对象?当然所谓对象,是个宽泛的概念,包括变量、函数、类,等等。
通过 LuaBridge,可以很方便的解决这两个问题。
头文件
先交代一下头文件,后面就不提了。
首先包含 Lua 的几个头文件,因为是 C 代码,放在 extern "C"
里才能跟 C++ 程序混编。
extern "C" {
#include "lua.h"
#include "lualib.h"
#include "lauxlib.h"
} // extern "C"
其次是 LuaBridge 头文件,LuaBridge 跟 STL 一样,只有头文件,直接包含使用。
#include "LuaBridge/LuaBridge.h"
Lua 访问 C++
函数
C++ 函数 SayHello
「导出」为 Lua 函数 sayHello
,然后通过 luaL_dostring
执行 Lua 代码,调用这个函数。
void SayHello() {
std::cout << "Hello, World!" << std::endl;
}
int main() {
lua_State* L = luaL_newstate();
luaL_openlibs(L);
luabridge::getGlobalNamespace(L)
.addFunction("sayHello", SayHello);
luaL_dostring(L, "sayHello()");
lua_close(L);
}
输出:
Hello, World!
为 SayHello
加个参数:
void SayHello(const char* to) {
std::cout << "Hello, " << to << "!" << std::endl;
}
luabridge::getGlobalNamespace(L)
.addFunction("sayHello", SayHello);
luaL_dostring(L, "sayHello(''Lua'')");
输出:
Hello, Lua!
类
C++ 的类导出为 Lua 的表,类的成员函数对应于表的成员。假如有一个类 Line
,表示文本文件中的一行:
class Line {
public:
Line(const std::string& data)
: data_(data) {
}
size_t Length() const {
return data_.length();
}
private:
std::string data_;
};
构造函数
导出构造函数用 addConstructor
,导出成员函数还是用 addFunction
:
luabridge::getGlobalNamespace(L)
.beginClass<Line>("Line")
.addConstructor<void(*)(const std::string&)>()
.addFunction("getLength", &Line::Length)
.endClass();
构造函数无法取址,调用 addConstructor
时需传递模板参数以指明类型。
测试:
const char* str =
"line = Line(''test'')\n"
"print(line:getLength())\n";
luaL_dostring(L, str);
输出:
4
如果有多个构造函数,比如还有一个缺省构造函数:
Line::Line();
则只能导出一个。下面这种写法,第二个会覆盖第一个:
luabridge::getGlobalNamespace(L)
.beginClass<Line>("Line")
.addConstructor<void(*)(void)>() // 被下一句覆盖
.addConstructor<void(*)(const std::string&)>()
.endClass();
你不可能让同一个名字指代两件事情。
成员函数
考虑一个稍微复杂的成员函数,StartWith
判断一行文本是否以某个字符串打头,参数 ignore_spaces
决定是否忽略行首的空格。对实现不感兴趣的可以完全忽略。
bool Line::StartWith(const std::string& str,
bool ignore_spaces) const {
size_t i = 0;
if (ignore_spaces && !IsSpace(str[0])) {
for (; i < data_.size() && IsSpace(data_[i]); ++i) {
}
}
if (data_.size() < i + str.size()) {
return false;
}
if (strncmp(&data_[i], &str[0], str.size()) == 0) {
return true;
}
return false;
}
通过 addFunction
导出到 Lua:
addFunction("startWith", &Line::StartWith)
测试:
const char* str =
"line = Line('' if ...'')\n"
"print(line:startWith(''if'', false))\n"
"print(line:startWith(''if'', true))\n";
输出:
false
true
输出参数
现在为 StartWith
添加可选的输出参数,以便 ignore_spaces
为 true
时能够返回偏移信息(第一个非空字符的下标):
bool Line::StartWith(const std::string& str,
bool ignore_spaces,
int* off = NULL) const {
size_t i = 0;
if (ignore_spaces && !IsSpace(str[0])) {
for (; i < data_.size() && IsSpace(data_[i]); ++i) {
}
}
if (data_.size() < i + str.size()) {
return false;
}
if (strncmp(&data_[i], &str[0], str.size()) == 0) {
if (off != NULL) {
*off = static_cast<int>(i);
}
return true;
}
return false;
}
输出参数在 C/C++ 里是很常见的用法,可以让一个函数返回多个值。但是用 addFunction
导出的 StartWith
并不能被 Lua 调用,因为 Lua 没有输出参数。幸运的是,Lua 的函数可以有多个返回值,为了让 StartWith
返回多个值,我们得做一层 Lua CFunction
的包装。
// Lua CFunction wrapper for StartWith.
int Line::Lua_StartWith(lua_State* L) {
// 获取参数个数
int n = lua_gettop(L);
// 验证参数个数
if (n != 3) {
luaL_error(L, "incorrect argument number");
}
// 验证参数类型
if (!lua_isstring(L, 2) || !lua_isboolean(L, 3)) {
luaL_error(L, "incorrect argument type");
}
// 获取参数
std::string str(lua_tostring(L, 2));
bool ignore_spaces = lua_toboolean(L, 3) != 0;
// 转调 StartWith
int off = 0;
bool result = StartWith(str, ignore_spaces, &off);
// 返回结果
luabridge::push(L, result);
luabridge::push(L, off);
return 2; // 返回值有两个
}
类型为 int (*) (lua_State*)
的函数就叫 Lua CFunction
。改用 addCFunction
导出 Lua_StartWith
:
addCFunction("startWith", &Line::Lua_StartWith)
测试:
const char* str =
"line = Line('' if ...'')\n"
"ok, off = line:startWith(''if'', true)\n"
"print(ok, off)\n";
输出:
true 2
变参
既然已经做了 CFunction
的封装,不如做得更彻底一些。鉴于 Lua 对变参的良好支持,我们让 startWith
支持变参,比如既可以判断是否以 ''if''
打头:
line:startWith(true, ''if'')
也可以判断是否以 ''if''
或 ''else''
打头:
line:startWith(true, ''if'', ''else'')
为此,ignore_spaces
变成了第一个参数,后面是字符串类型的变参,具体实现如下:
int Line::Lua_StartWith(lua_State* L) {
int n = lua_gettop(L);
if (n < 3) {
luaL_error(L, "incorrect argument number");
}
if (!lua_isboolean(L, 2)) {
luaL_error(L, "incorrect argument type");
}
bool ignore_spaces = lua_toboolean(L, 2) != 0;
bool result = false;
int off = 0;
// 逐个比较字符串变参,一旦匹配就跳出循环。
for (int i = 3; i <= n; ++i) {
if (!lua_isstring(L, i)) {
break;
}
std::string str(lua_tostring(L, i));
if (StartWith(str, ignore_spaces, &off)) {
result = true;
break;
}
}
luabridge::push(L, result);
luabridge::push(L, off);
return 2;
}
测试:
const char* str =
"line = Line('' else ...'')\n"
"ok, off = line:startWith(true, ''if'', ''else'')\n"
"print(ok, off)\n";
输出:
true 2
执行 Lua 文件
前面示例执行 Lua 代码全部使用 luaL_dostring
,实际项目中,Lua 代码主要以文件形式存在,就需要 luaL_dofile
。
测试:
luaL_dofile(L, "test.lua);
文件 test.lua
的内容为:
line = Line('' else ...'')
ok, off = line:startWith(true, ''if'', ''else'')
print(ok, off)
输出:
true 2
C++ 访问 Lua
通过 getGlobal
函数可以拿到「全局」的 Lua 对象,类型为 LuaRef
。
int main() {
lua_State* L = luaL_newstate();
luaL_openlibs(L);
{ // 为了让 LuaRef 对象在 lua_close(L) 之前析构
const char* str =
"world = ''World''\n"
"sayHello = function(to)\n"
" print(''Hello, '' .. to .. ''!'')\n"
"end\n";
luaL_dostring(L, str);
using namespace luabridge;
LuaRef world = getGlobal(L, "world");
LuaRef say_hello = getGlobal(L, "sayHello");
say_hello(world.cast<const char*>());
}
lua_close(L);
}
输出:
Hello, World!
字符串
Lua 没有字符类型,也没有 Unicode
字符串(特指 wchar_t*
)。
bool IsSpace(char c) {
return c == '' '' || c == ''\t'';
}
luabridge::getGlobalNamespace(L)
.addFunction("isSpace", IsSpace);
luaL_dostring(L, "print(isSpace('' ''))");
luaL_dostring(L, "print(isSpace('' ''))");
luaL_dostring(L, "print(isSpace(''c''))");
输出:
true
true
false
如果 IsSpace
参数为 wchar_t
:
bool IsSpace(wchar_t c) {
return c == L'' '' || c == L''\t'';
}
在 Lua 里调用 isSpace('' '')
时,LuaBridge 便会断言失败:
Assertion failed: lua_istable (L, -1), file e:\proj\lua_test\third_party\include\luabridge\detail/Us
erdata.h, line 189
折中的办法是,为 IsSpace(wchar_t c)
提供一个 wrapper,专供 Lua 使用。
bool Lua_IsSpace(char c) {
return IsSpace((wchar_t)c);
}
luabridge::getGlobalNamespace(L)
.addFunction("isSpace", Lua_IsSpace);
当然前提是,Lua 代码调用 isSpace
时,只会传入 ASCII 字符。
错误处理
为了方便问题诊断和错误处理,有必要为内置的函数或宏做一些封装。
luaL_dostring
bool DoLuaString(lua_State* L,
const std::string& str,
std::string* error = NULL) {
if (luaL_dostring(L, str.c_str()) != LUA_OK) {
if (error != NULL) {
// 从栈顶获取错误消息。
if (lua_gettop(L) != 0) {
*error = lua_tostring(L, -1);
}
}
return false;
}
return true;
}
测试:故意调用一个不存在的函数 SayHello
(应该是 sayHello
)。
std::string error;
if (!DoLuaString(L, "SayHello(''Lua'')", &error)) {
std::cerr << error << std::endl;
}
输出(试图调用一个空值):
[string "SayHello(''Lua'')"]:1: attempt to call a nil value (global ''SayHello'')
luaL_dofile
与 luaL_dostring
的封装类似。
bool DoLuaFile(lua_State* L,
const std::string& file,
std::string* error = NULL) {
if (luaL_dofile(L, file.c_str()) != LUA_OK) {
if (error != NULL) {
// 从栈顶获取错误消息。
if (lua_gettop(L) != 0) {
*error = lua_tostring(L, -1);
}
}
return false;
}
return true;
}
luabridge::LuaRef
LuaRef world = getGlobal(L, "world");
if (!world.isNil() && world.isString()) {
// ...
}
LuaRef say_hello = getGlobal(L, "sayHello");
if (!say_hello.isNil() && say_hello.isFunction()) {
// ...
}
luabridge::LuaException
如果 Lua 代码有什么问题,LuaBridge 会引发 LuaException
异常,相关代码最好放在 try...catch
中。
try {
// ...
} catch (const luabridge::LuaException& e) {
std::cerr << e.what() << std::endl;
}
CCLuaObjcBridge - Lua 与 Objective-C 互操作的简单解决方案
ccluaObjcBridge - Lua 与 Objective-C 互操作的简单解决方案
-
- luaoc 的主要特征
- luaoc 用法示例
- 从 Objective-C 调用 Lua
- 参考
月初的时候,发了一篇关于 Lua 与 Java 互操作的文章,里面提到了我创建的 LuaJavaBridge 工具。现在,最新的 Lua 与 Objective-C 互操作工具也出来了。因为是专门针对 cocos2d-x 的,所以命名为 ccluaObjcBridge。
PS: 以前的 LuaJavaBridge 也会改名为 ccluaJavaBridge,并且参考现在 ccluaObjcBridge 的实现,做了不少改进,完成后也会发布。
ccluaObjcBridge(后文简称 luaoc)的功能就是从 Lua 里直接掉用“任意 Objective-C 类方法”。利用这个特性,封装各种 iOS 上的库简直碉堡了,堪称 cocos2d-x Lua 游戏开发的神器 ^_^
luaoc 的主要特征
- 可以从 Lua 调用 Objective-C Class Method
- 调用 Objective-C 方法时,支持 int/float/boolean/String/Lua function/Lua table 六种参数类型
- 可以将 Lua function 作为参数传递给 Objective-C,并让 Objective-C 保存 Lua function 的引用
- 可以从 Objective-C 调用 Lua 的全局函数,或者调用引用指向的 Lua function
主要功能和 luaj 是一样的,但相比老版本 luaj 做了一些针对 Objective-C 的调整。
luaoc 用法示例
下面的代码演示了如何调用 91 SDK:
Lua 代码:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
-- 注册回调函数,在玩家离开 91 平台界面时显示一个消息 -- PS: 91 SDK 的支付接口不会直接返回状态给客户端,支付需要在服务端验证 local function callback(event) if event == "SDKNDCOM_LEAVE_PLATFORM" then print(充值正在进行中,稍候您就能收到金币啦"end end luaoc.callStaticmethodSDKNdCom", registerScriptHandler" |
下面代码是 Objective-C 写的中间层,用来沟通 91 SDK 和 Lua 代码。
Objective-C 代码:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
+ NSDictionary *) payForCoins:)dict Nsstring *[dict objectForKey:@"orderId"]; if (!|| orderId length] == 0) CFUUIDRef theUUID CFUUIDCreateNULL); CFStringRef string CFUUIDCreateStringtheUUIDCFRelease[()string autorelease]; } int ; ([@"coins"]) [[] intValue} description @"description"description= @""; NdComPlatform defaultPlatform] NdUniPayForCoin:orderId needPayCoins:coins payDescription:]; return NSDictionary dictionaryWithObjectsAndKeys:orderId |
由于无法直接获取 Objective-C 方法的参数个数和类型,所以如果要从 Objective-C 方法里接收 Lua 传递的参数,那么只能以 NSDictionary 的形式。
上述代码中,Lua 端传递了一个包含 orderId 和 coins 的表格作为参数。这个表格会被 luaoc 自动转换为 NSDictionary 对象,并传入 payForCoins:(NSDictionary*) 方法。
不过从 Objective-C 返回值给 Lua 时,就可以返回各种类型的值。目前支持的值类型有 int/float/BOOL/Nsstring/NSDictionary。特别是可以返回 NSDictionary 类型后,Lua 代码从 Objective-C 端获取数据就简单很多了。
从 Objective-C 调用 Lua
由于 ccluaObjcBridge 已经集成到quick-cocos2d-x(一个基于 cocos2d-x 的 Lua 游戏引擎)中,所以从 Objective-C 调用 Lua 也更简单灵活:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
// functionId 是 Lua function 的引用 ID,参考 LuaJavaBridge 文章中的描述 // 1. 将引用 ID 对应的 Lua function 放入 Lua stack ccluaObjcBridge::pushLuaFunctionByIdfunctionId); // 2. 将需要传递给 Lua function 的参数放入 Lua stack ccluaValueDict item; ["title"ccluaValuestringValue("hello"); "coins"("success"booleanValueTRUEgetStack()->pushccluaValueDict// 3. 执行 Lua function executeFunction1// 4. 释放引用 ID releaseLuaFunctionByIdcallbackId); |
ccluaObjcBridge::getStack() 会返回一个 ccluaStack 对象的指针。
ccluaStack 是 quick-cocos2d-x 引入的新对象,封装了 Lua stack 的一些常用操作。例如要将值放入 Lua stack 就提供了下列方法,支持各种数据类型:
1 2 3 4 5 6 7 8 9 10 |
void pushInt(); pushFloatfloat floatValuepushBooleanbool boolValuepushString(const char* |
相比 LuaJavaBridge,ccluaObjcBridge 更容易使用、传递数据也更方便。以后 LuaJavaBridge 也会更名为 ccluaJavaBridge,并使用相同的值传递机制。
OC直接调用lua全局方法:cocos2d::ccluaEngine::defaultEngine()->executeGlobalFunction("luaGlobalfunctionOnPause");
参考
ccluaObjcBridge 和 LuaJavaBridge 是一脉相承,更详细的描述请参考《LuaJavaBridge - Lua 与 Java 互操作的简单解决方案》。
- 完 -
cocos2d-x lua LuaJavaBridge
cocos2d-x为我们封装了LuaJavaBridge,避免了jni的繁琐,现在可以轻松的实现lua和android端的互调了,引读
LuaJavaBridge - Lua 与 Java 互操作的简单解决方案
看个例子
1、lua调用android端
lua代码
--引入LuaJavaBridge local luaj = require "luaj" local className="com/lua/java/Test" --包名/类名 local args = { "hello android",callbackLua } local sigs = "(Ljava/lang/String;I)V" --传入string参数,无返回值 --luaj 调用 Java 方法时,可能会出现各种错误,因此 luaj 提供了一种机制让 Lua 调用代码可以确定 Java 方法是否成功调用。 --luaj.callStaticmethod() 会返回两个值 --当成功时,第一个值为 true,第二个值是 Java 方法的返回值(如果有) --当失败时,第一个值为 false,第二个值是错误代码 local ok,ret = luaj.callStaticmethod(className,"test",args,sigs) if not ok then item:setString(ok.."error:"..ret) end
android端的代码
package com.lua.java; /** * 引入Cocos2dxLuaJavaBridge */ import org.cocos2dx.lib.Cocos2dxLuaJavaBridge; public class Test { public static void test(final String param,final int luaFunc){ System.out.println("----传过来的参数----param:"+param); System.out.println("-------luaFunc:"+luaFunc); /** * 给lua返回一个字符串 */ Cocos2dxLuaJavaBridge.callLuaFunctionWithString(luaFunc,"success"); /** * 移除luaId */ Cocos2dxLuaJavaBridge.releaseLuaFunction(luaFunc); } }
2、android端调用lua
lua代码,调用的是全局函数
function testAndroid(parameters) print("--testAndroid--",parameters) cc.Director:getInstance():endToLua() end
android端
import org.cocos2dx.lib.Cocos2dxLuaJavaBridge;
/** * testAndroid lua中的方法名 * androidLua 传递给lua函数的参数值 */ Cocos2dxLuaJavaBridge.callLuaGlobalFunctionWithString("testAndroid","androidLua");
Cocos2d-x中LuaJavaBridge使用方法
android平台代码和Lua代码的交互均通过C++和Java交互,Lua再和C++交互
C++和Java的交互,可以参考 (*)
下面直接看用法:
lua调用java
lua中使用 luaj.callStaticMethod 来调用java静态方法:
使用场景例如提交统计,提交游戏分数
-- launch app
function JniUtil:callJavaBuyLife()
local argsJson = nil
local sigs = "()V"
local luaj = require "cocos.cocos2d.luaj"
local className = "org/cocos2dx/lua/AppActivity"
local ok,ret = luaj.callStaticMethod(className, "pay", {argsJson}, sigs)
if not ok then
print("==== luaj error ==== : ", ret)
return false
else
print("==== The JNI return is:", ret)
return ret
end
end
在AppActivity中,加入静态方法:
public static void pay() {
// ...
}
java调用lua
cocos2d-x提供了Cocos2dxLuaJavaBridge带有如下方法可以使用:
public static native int callLuaFunctionWithString(int luaFunctionId, String value); // 调用局部Lua-Function
public static native int callLuaGlobalFunctionWithString(String luaFunctionName, String value); // 调用全局Lua-Function
public static native int retainLuaFunction(int luaFunctionId); // retain一次Lua-Function
public static native int releaseLuaFunction(int luaFunctionId); // release掉Lua-Function
使用场景:例如我们在支付SDK中购买完了钻石后回调到游戏中
下面提供callLuaGlobalFunctionWithString用法:
function G_CallbackFromJava(msg)
if msg == "success" then
-- ...
end
end
Java中对这个全局函数直接调用他,如果G_CallbackFromJava里要涉及图形计算,需要启用OpenGL线程:
sInstance.runOnGLThread(new Runnable() {
@Override
public void run() {
Cocos2dxLuaJavaBridge.callLuaGlobalFunctionWithString("G_CallbackFromJava", "success");
}
});
添加import语句:
import org.cocos2dx.lib.Cocos2dxLuaJavaBridge;
下面提供callLuaFunctionWithString用法:
function JniUtil:callJavaCallbackLua(func)
local luaj = require "cocos.cocos2d.luaj"
local className = "org/cocos2dx/lua/AppActivity"
local args = { "callbacklua", func }
local sigs = "(Ljava/lang/String;I)V"
local ok = luaj.callStaticMethod(className,"callbackLua",args,sigs)
if not ok then
print("============= call callback error")
else
print("------------- call callback success")
end
end
某启用充值的地方,预先注册局部函数
local function onBack(msg)
self:resumeGame()
end
JniUtil:getInstance():callJavaCallbackLua(onBack)
Java中可以直接回调这个函数,也可以先保存下来这个注册的Lua局部函数,一般都是保存下来,等待启用SDK充值逻辑走完后再回调
static int luaFuncCallback = 0;
public static void callbackLua(final String tipInfo,final int luaFunc){
// 根据需要,看是否要retainLuaFunction
luaFuncCallback = luaFunc;
// tipInfo为Lua里传来的“callbacklua”这里没用
}
Java中充值后回调函数中调用游戏里的lua逻辑
sInstance.runOnGLThread(new Runnable() {
@Override
public void run() {
Cocos2dxLuaJavaBridge.callLuaFunctionWithString(luaFuncCallback, "success");
Cocos2dxLuaJavaBridge.releaseLuaFunction(luaFuncCallback);
}
});
今天关于LuaJavaBridge - Lua 与 Java 互操作的简单解决方案和lua和java的介绍到此结束,谢谢您的阅读,有关C++ 程序嵌 Lua(基于 LuaBridge)、CCLuaObjcBridge - Lua 与 Objective-C 互操作的简单解决方案、cocos2d-x lua LuaJavaBridge、Cocos2d-x中LuaJavaBridge使用方法等更多相关知识的信息可以在本站进行查询。
本文标签: