Lua 与 ObjC 的交互

1. 写在前面

很多时候我们都需要借助一些脚本语言来为我们实现一些动态的配置,那么就会涉及到如何让脚本语言跟原生语言交互的问题。平时在网上看得比较多的是使用JS(JavaScript)与iOS原生代码ObjC交互的文章。因为JS的解析器是iOS内部提供的(可以使用UIWebView或者JavaScriptCore.framework实现),所以使用JS来交互会感觉比较方便。

但是在这里,我想跟大家分享另外一种脚本语言的交互方式,就是使用Lua与原生的ObjC语言进行交互。Lua是一种轻量级的脚本语言,它的脚本解析器很小,编译出来只有100多kb,因此,作为一个内嵌的脚本解析器是首选的;而且Lua除了提供基本的脚本语言特性和系统功能外(IO读写),没有多余的功能性框架(JS解析器因为要配合Web的功能实现带有很多的工具库),这也是它轻量的表现。同时,提供了丰富的C Api来让其它的语言对其功能进行扩展,能够真正做到按需定制。

那么,这里所说到的C Api就是用于与ObjC交互的重点。因为ObjC本来就是C语言的超集,所以能够很方便的调用这些C Api,下面将一步一步实现交互的过程。

2. 下载和编译Lua解析器

首先,跳转到Lua官网的下载页将源码下载下来。然后解压下载包可以得到如下图所示的目录结构:

111804600-1fa7a76531138690

Lua源码目录结构

对应的目录说明如下表:

名称 说明
doc Lua相关的文档,包括了编译文档、接口文档等
Makefile 编译Lua使用,在这里我们不使用它来进行编译
README 关于Lua的说明文件
src Lua的源码文件

3. 编译Lua源码

在这里我们只需要src目录中的源码文件,先打开src目录,将Makefile、lua.c、luac.c三个文件删除掉,需要说明的是lua.c和luac.c文件是用于编译生成lua和luac两个命令不属于解析器的功能,如果不删除可能会导致XCode无法编译通过。

接下来打开XCode创建一个新的项目并把src目录拖入项目中。如下图所示:

121804600-364f34d7d650fab2

导入Lua源码到项目

然后Command+B进行编译,提示编译成功!

4. Lua C Api 与 栈

在开始实现Lua与OC交互之前先来了解两个非常重要的概念,一个是Lua的C Api,Lua的脚本解析器是使用C语言来编写的(基于C语言的源码跨平台特性,使得Lua可以在各种系统下面使用),因此它提供了丰富的C语言定义的接口来访问和操作Lua中的所有元素,掌握这些C Api可以更加灵活和方便地扩展Lua的功能,下面的交互实现正是使用这些C Api进行实现的。

另外一个就是 的概念,在Lua和C进行交互数据的时候会用到了一个栈的结构,栈中的每个元素都能保存任何类型的Lua值。要获取Lua中的一个值时,需要调用一个C Api函数,Lua就会将特定的值压入栈中,然后再通过相应的C Api将值取出来,如图所示:

131804600-3e645c88ed4d3b3f

C/C++获取Lua值

同样,要将一个值传给Lua时,需要先调用C Api将这个值压入栈,然后再调用C Api,Lua就会获取该值并将其从栈中弹出。 如图所示:

141804600-6b3ae0f1d72ccfb0

C/C++给Lua传值

这种设计方式主要是为了多种编程语言中统一数据交互中的存取方式,并且方便Lua中的垃圾回收机制的检测。

有了上述所说的概念,下面正式进入主题。

5. 初始化Lua环境

Lua环境的维护需要一个叫lua_State的结构体来支持,其贯穿了整个执行过程。因此,要使用Lua则需要先初始化一个lua_State结构体。修改ViewController的代码如下:

6. 关于栈操作的C Api

上面说到数据“栈”的概念,C Api中提供了很多操作栈的功能接口,通常可以分为四大类:入栈操作、查询操作、取值操作和其他操作。

6.1 入栈操作

表示要将本地的某个类型的值放到数据栈中,然后提供给Lua层来获取和操作。该类操作接口有如下定义:

从上面的接口方法定义可以看出来,不同的Lua类型对应着不通的入栈接口,包括了整型(Integer)、布尔类型(Boolean)、浮点数(Number)、字符串(String)、闭包(Closure)、用户自定义数据(Userdata)、空类型(Nil)以及线程(Thread)。需要注意的是,C Api没有提供直接入栈Table类型的接口(估计是该数据类型无法与本地结构进行对应),如果需要入栈一个Table类型,可以使用lua_createtable方法来入栈一个Table,调用该方法会在栈顶放入一个Table的引用。

可见,假如我们需要在原生代码中给Lua的一个全局变量a赋一个整型值,那么可以如下面代码的做法:

其中的lua_setglobal方法为设置全局变量的值,该方法会把数据栈顶的元素放入该方法第二个参数所指定的变量名对应的变量中,同时移除栈顶元素。如图:

151804600-9416fa7957a3e465

lua_setglobal示意图

6.2 查询操作

之前说到栈中的每个元素都可以为任意类型,那么,对于如何判断元素的类型就可以通过该类方法来实现。该类方法的定义如下:

同样查询操作也是提供了不同的方法来检测不同的类型。其中第二个参数表示要检测类型的元素处于栈中的哪个位置。

关于栈中位置在lua中有两种形式表示,第一种是正数表示法,1表示栈底元素(即最先入栈的元素),然后越往上的元素,索引值越大。另外一种是负数表示法,-1表示栈顶元素(即最后入栈的元素),然后越往下的元素,索引值越小。如图所示:

161804600-9a9409bc7aab5236

栈索引两种表示方法示意图

lua_isXXX系列方主要是判断栈中数据是否能够被转换为对应数据类型时使用,如lua_isstring方法则是判断栈中某个元素是否能够被转换为string类型,所以当栈中数据为number类型时,其返回值也为true。

如果要进行非转换的强类型判断,可以使用lua_type方法来获取栈中元素的类型,然后根据类型来获取值。如判断栈顶元素的类型:

6.3 取值操作

栈中的所有元素的获取都是通过该类方法来实现,通常该类方法跟在查询类方法后,当知道某个数据类型后,则调用对应数据类型的取值方法来获取元素。其方法定义如下:

取值操作的接口也相当简单,分别传入lua_State对象和栈索引即可。如果在调用时指定的类型跟栈中类型不同也不会有什么问题,接口会因为类型不正确而返回0或者NULL。

要注意的是该系列接口跟lua_isXXX系列接口一样,会对原始的类型进行转换输出,因此在做一些跟类型相关的操作时,最好时先判断类型再根据类型调用该方法取值,否则会导致一些意想不到的异常,如下面例子:

上面例子中的原意是要输出下面的内容:

但是实际上却是这样:

这是由于使用了lua_tostring把栈中的targetVar的值改变了导致的,所以类似这样的操作一定要谨慎。

6.4 其他操作

使用上述3部分的操作可以满足与栈中数据进行交互的大多数情况。如果需要更加灵活地对栈进行操作,例如拷贝栈中某个元素,交互栈中元素位置等等的操作可以使用下面所定义的接口:

其中lua_gettop为获取栈顶位置,也即是栈中元素的个数,其实这个方法在处理原生方法的传入参数时很有用,可以确认传入参数的个数。有时候也可以用它来输出各个状态下的栈元素变化,来确认自己在操作栈时是否存在问题。

lua_settop方法用于设置栈顶位置,如果新栈顶高于之前的栈顶则会push一些nil的元素来填充;如果新栈顶低于之前的栈顶则会丢弃新栈顶之上的所有元素。如图所示:

171804600-72a9c877ff2fda9f

lua_settop示意图

lua_pushvalue方法表示将栈中某个元素的副本压入栈顶。之前的栈元素不会发生变动。如图所示:

181804600-8d07d485cbe559c8

lua_pushvalue示意图

lua_remove方法用于移除指定索引上的元素,然后再该元素之上的所有元素会下移填补空缺(即元素的索引会发生变更)。如图所示:

191804600-1f64039b49ea115f

lua_remove示意图

lua_insert会将指定索引位置之上的所有元素上移来开辟一个新的位置。然后将栈顶元素插入到该位置。如图所示:

201804600-39f55a54383d68b6

lua_insert示意图

lua_replace方法会先弹出栈顶元素,然后将该元素覆盖到指定索引位置上。如图所示:

211804600-9c25186de8691996

lua_replace示意图

lua_pop方法会从栈顶弹出指定数量的元素。如图所示:

221804600-7e99d7279eb9e786

lua_pop示意图

了解了上面的栈操作方法后,下面就是要结合这些方法来实现交互的实际操作。

7. From OC to Lua

7.1 空值传递

使用lua_pushnil方法可以将任意一个Lua变量置空。如:

7.2 数值的传递

使用lua_pushinteger或者lua_pushnumber方法来将OC中的数值类型传递到Lua中指定的某个变量。如:

7.3 布尔值的传递

使用lua_pushboolean方法来实现,如:

7.4 字符串的传递

使用lua_pushstring方法可以传递字符串给Lua,要注意的是该方法接收的是一个c描述的字符串(即 char*)。如:

7.5 二进制数组的传递

二进制数组在Lua中其实与字符串的存储方式相同,但是OC中不能直接使用lua_pushstring来进行二进制数组的传递,可以使用lua_pushlstring方法来传递。如:

7.6 方法的传递

Lua中只能接受C定义的方法传入,并且方法的声明必须符合lua_CFunction函数指针的定义,即:

那么,传入方法则需要先定义一个C语言声明的方法,如:

方法里面简单地进行了一下信息打印,其中方法的返回值是一个整数,表明了该方法需要返回多少个值到Lua中(后续章节会进行返回值的相关演示),现在不需要返回值则为0。然后,再通过lua_pushcfunction方法将方法传入:

操作完成后,在Lua中就可以直接调用了:

如果定义的方法是允许接受参数的,那么可以从state参数里面获取传入的参数。拿上面的例子,例如方法接收一个名字的字符串参数,函数的代码则可以修改为:

然后在Lua中则可以这样调用:

如果定义的方法不是直接打印字符串,而是组合了字符串给Lua返回,那么定义的方法里面则需要配合’lua_pushXXXX’系列方法来进行返回值传递。需要注意的是:方法中return的数量要与push到栈中的值要一致,否则可能出现异常。那么,上面定义的函数可以做如下修改:

然后在Lua中则可以这样调用:

7.7 数组和字典的传递

在Lua中,数组(Array)和字典(Dictionary)都由一个Table类型所表示(在Lua看来数组其实也属于一种字典,只是它的key是有序并且为整数)。如:

上面的例子分别用了不带key的声明和带key的声明两种方式来创建Table类型。其中不带key的声明方式,解析器会默认为其创建一个key,该key是从1开始,由小到大进行分配,其等效于:

当然,两种方式是可以混合使用,如:

Table属于比较复杂的数据结构,因此提供操作它的C Api也比较复杂,下面将根据数组和字典分别讲述它们的传递方式。

7.7.1 数组传递

首先,需要将一个Table类型入栈,这样才能对其进行进一步的操作。由于没有pushtable这样的方法,但是可以使用lua_newtable来创建一个Table对象,并且该对象会自动放入栈顶位置。如:

然后对要传递的数组进行遍历,并通过lua_rawseti方法将元素值设置到Table中。如:

通过上面的代码就可以把一个数组传递给arrayVal变量。值得注意的是:lua_rawseti方法表示要栈顶的元素设置给指定的Table对象的指定索引。其中的第二个参数是指Table对象在栈中的位置,第三个参数是表示在Table中的索引,一般索引是从1开始算起,因此上面代码中的idx需要加1。经过这样的操作后,栈顶的元素会被移除。如下图所示:

231804600-ed859d8b0a082a6a

lua_rawseti示意图

7.7.2 字典传递

字典的传递同样需要先入栈一个Table:

然后对要传递的字典进行遍历,并通过lua_setfield方法将元素设置到Table中。如:

lua_setfieldlua_rawseti功能类型,都是把一个元素放入Table中,只是一个用于指定整数索引,一个是指定字符串索引。通过上面的方式就可以把字典传递给Lua了。

7.8 自定义数据传递

Lua中一个比较强大的地方是它可以将任意的类型(包括类对象)进行传递。特别是在提供原生处理方法时,需要用到一些特定的数据类型作为参数时,Lua就可以帮我们实现这一块的传递。

要想传递自定义的数据则必须要使用Lua提供的Userdata类型。该类型有两种引用方式,一种是强引用Userdata,由Lua的GC来负责该类型变量的生命周期。另外一种是弱引用Userdata,又称Light Userdata,该类型不被GC所管理,其生命周期由原生层来决定。下面来看一下两种方式是如何实现的。

首先我们来定义一个OC的User类:

然后,利用lua_newuserdata方法来创建一个强引用Userdata,并创建一个User对象赋值给新建的Userdata。如:

通过上面的代码就可以把User类实例封装成Userdata再传递给Lua。如果你要传递的对象并不需要Lua来管理生命周期,那么就可以创建一个弱引用的Userdata,如:

下面来看一个比较实际的例子,假设有一个提供给Lua调用的原生接口printUser,该接口会打印传入进来的用户信息,代码如下:

该方法通过lua_topointer方法来获取了一个Userdata数据类型并转换为User类实例对象然后打印其名称。接下来将其导出给Lua:

然后生成一个User对象,并调用该方法传入该用户对象。如:

上面的代码就是使用C Api来调用Lua的方法(下面的章节会详细讲述这块内容),通过OC代码创建了一个User对象并将其作为了参数传给了Lua的printUser方法。最终的输出信息如下:

从OC到Lua的所有类型的转换和交互基本上都涉及到了,下面章节将会详细描述从Lua到OC上的一些交互和数据交换。

8. From Lua to OC

8.1 获取数值

通过lua_tonumber方法可以获取某个数值变量的值。如:

上述代码中的lua_getglobal方法是用于获取全局变量的值,调用它会把一个值放入栈顶。然后再通过lua_tonumber把栈顶的值读取出来并打印。需要注意的是通过lua_getglobal获取得到的值,在栈中是不会自动清除,因此,在用完某个变量时记得把它从栈中清除掉,代码中是通过lua_pop把值弹出栈的。

8.2 获取布尔值

与获取数值相同,通过lua_toboolean方法来获取某个布尔变量的值。如:

8.3 获取字符串

lua_tostring方法来获取字符串变量的值。如:

8.4 获取二进制数组

lua_tolstring方法来获二进制数组变量的值。如:

8.5 方法的获取和调用

一般情况下,要获取Lua中的某个Function主要是用于对其进行调用。假设有一个Lua方法定义如下:

那么,对应OC中需要下面的代码来获取和调用它:

上述代码中的lua_pcall方法表示将栈中的元素视作Function来进行调用。其中第二个参数为传入参数的数量,必须与压栈的参数数量一致;第三个参数为返回值的数量,表示调用后其放入栈中的返回值有多少个。第四个参数是用于发生错误处理时的代码返回。其运行原理如下图所示:

241804600-c14e15dbb3ec4bec

lua_pcall原理示意图

对于带参数和返回值的方法,在获得方法对象后,需要调用lua_pushXXX系列方法来设置传入参数。可以参考下面例子:

假设有一个加法的Lua方法,其定义如下:

那么,OC中则可以进行下面操作来调用方法并传递参数,最终取得返回值然后打印到控制台:

8.6 Table的获取和遍历

Table的获取跟其他变量一样,一旦放入栈后可以根据需要通过调用lua_getfield方法来指定的key的值。如:

如果Table是声明时没有指定key,那么则需要调用lua_rawgeti来获取Table的值。如:

有时候,Table存储的信息会在函数体外被访问,那么我们需要对Table进行遍历然后把它放入一个字典中,然后提供给程序使用。代码如下:

上述代码利用lua_next方法来遍历Table的所有元素,该方法从栈顶弹出一个元素作为遍历Table的起始Key,然后把每个元素的Key和Value放入栈中。为了遍历所有元素所以起始的Key设置了一个nil值,证明要从Table最开始的Key进行遍历。如图:

251804600-4ffcc15ffe670483

lua_next原理示意图

值得注意的是,在获取Key值时,最好先判断Key的类型,然后再根据其对应类型调用相应的lua_toXXX方法。否则,因为lua_toXXX系列方法会对元素值进行类型转换,如整型的Key被lua_tostring转换为String后再给到lua_next进行遍历就会报找不到指定Key的错误。

8.7 获取自定义数据

利用lua_topointer方法来获取自定义数据,如:

9. 结语

Lua虽然小巧,但五脏俱全。最主要的是它提供了丰富又强大的C Api接口允许我们进行高度的定制和扩展。可利用这些扩展特性开发适合自己的一套脚本引擎。基于上面所讲的,鄙人开发了一个LuaScriptCore的开源桥接框架,简化Lua与各种平台的交互,有兴趣的同学可以了解一下。

最后,希望通过本篇文章能够让大家对OC与Lua之间的交互有更近一步的了解,创造更多的可能性。

1 1 收藏 评论

相关文章

可能感兴趣的话题



直接登录
跳到底部
返回顶部