文档章节

使用LuaScriptCore来让Lua与iOS进行交互

vimfung
 vimfung
发布于 2016/12/13 11:51
字数 1416
阅读 1611
收藏 26

可能有一些人对lua并不是太熟悉,它其实跟JavaScript、Ruby、Python等同为脚本语言。但是更加轻量,更加简洁,没有任何多余的功能。这也使得它可以根据自己的需要来进行定制。例如作为应用的配置文件,又或者是游戏的脚本引擎等等。

由于它的轻量,因此它要写更多的代码来实现自己所需的功能,有时候还需要使用Lua提供的C Api来进行功能扩展,对于移动设备来说更是如此,例如:访问定位、照相机等等。

而且Lua的C Api相对来说不容易理解和掌握,需要投入一定的时间去学习和累积这方面的经验。而LuaScriptCore就是为了解决这些问题而诞生,他简化了扩展Lua的难度,让开发者可以通过自己熟悉的语言来扩展Lua,完美解决Lua与原生代码之间的通讯问题。

目前的LuaScriptCore版本为1.2.1,它支持iOS、Android、OSX平台,最新版本中还加入了对Unity3D的支持。日后可能会加入更多的平台的支持,让其在各个平台下都能够更加方便地扩展和操作Lua。下面我来举一个例子,就是Lua作为iOS应用的配置文件,让视图可以根据配置文件指定的颜色,来变更视图的背景颜色:

  • 首先我们先到Github上(或者码云上下载LuaScriptCore

  • 根据LuaScriptCore上的iOS集成文档将其集成到项目中。

  • 然后在ViewController导入头文件"LuaScriptCore.h",并在viewDidLoad方法中对LuaScriptCore进行初始化,如下面所示:

#import "ViewController.h"
#import "LuaScriptCore.h"

@interface ViewController ()

@property (nonatomic, strong) LSCContext *context;

@end

@implementation ViewController

- (void)viewDidLoad
{
    [super viewDidLoad];

    self.context = [[LSCContext alloc] init];
}

@end
  • 添加一个叫做config.lua的配置文件,并在上面添加一个叫backgroundColor的变量,并初始化为红色,如:

添加lua配置文件

  • 然后在viewDidLoad方法中使用LSCContext来执行该脚本,如:
[self.context evalScriptFromFile:@"config.lua"];
  • 再通过LSContext获取lua里面的背景颜色变量backgroundColor并更改ViewController的view的背景颜色,如:
LSCValue *value = [self.context evalScriptFromString:@"return backgroundColor"];
if (value.valueType == LSCValueTypeNumber)
{
        NSInteger color = [value toInteger];
        self.view.backgroundColor = [UIColor colorWithRed:(color >> 16 & 0xff) / 255.0
                                                    green:(color >> 8 & 0xff)  / 255.0
                                                     blue:(color & 0xff) / 255.0
                                                    alpha:1.0];
}

然后编译运行应用,则可以看到视图背景色变成了红色,如下图所示:

这样,一个简单的lua交互例子就完成了。如果你需要动态修改配置文件,可以通过自己的数据器下发Lua配置文件到App,然后再读取新的配置文件里面的值就可以实现动态更新了(如果是整个App的风格配置处理过程也基本一样^_^)。

接下来我们来看一下LuaScriptCore的一个比较强大的用法,那就是直接将OC中定义的类映射到Lua中进行使用。还是拿上面的例子来进行改造,我们新建一个叫Config的类型,该类型继承LSCObjectClass类(注:必须继承该类型)。代码如下:

//----------------- Config.h ----------------------
#import "LSCObjectClass.h"
#import <UIKit/UIKit.h>

/**
 配置类
 */
@interface Config : LSCObjectClass

/**
 背景颜色
 */
@property (nonatomic) NSInteger backgroundColor;

/**
 初始化

 @param view 视图对象
 @return 配置对象
 */
- (instancetype)initWithView:(UIView *)view;

@end

//----------------- Config.m ----------------------

@interface Config ()

/**
 视图对象,不导出到lua的属性要加下划线
 */
@property (nonatomic, strong) UIView *_view;

@end

@implementation Config

- (instancetype)initWithView:(UIView *)view
{
    if (self = [super init])
    {
        self._view = view;
    }
    return self;
}

- (void)setBackgroundColor:(NSInteger)backgroundColor
{
    _backgroundColor = backgroundColor;
    self._view.backgroundColor = [UIColor colorWithRed:(_backgroundColor >> 16 & 0xff) / 255.0
                                                 green:(_backgroundColor >> 8 & 0xff)  / 255.0
                                                  blue:(_backgroundColor & 0xff) / 255.0
                                                 alpha:1.0];
}

@end

然后修改config.lua文件,增加一个初始化配置的方法,如所示:

function initWithConfig( config )

    config:setBackgroundColor(0xffff00);

end

上面的Lua代码中的initWithConfig带有一个config参数,该参数就是OC中定义的Config类型,在方法中会对config的背景颜色进行更改。

那么,viewDidLoad中同样要进行相应的代码修改,如下所示:

- (void)viewDidLoad
{
    [super viewDidLoad];

    self.context = [[LSCContext alloc] init];
    [self.context registerModuleWithClass:[Config class]];

    self.config = [[Config alloc] initWithView:self.view];
    [self.context evalScriptFromFile:@"config.lua"];

    [self.context callMethodWithName:@"initWithConfig" arguments:@[self.config]];
}

可以看到,LSCContext初始化后,又调用了registerModuleWithClass方法,该方法是告诉Lua要注册一个Config的类型,这样才能够让Lua识别OC中定义的类(关于更多关于类型定义的内容可以参考LuaScriptCore的文档)。

然后要先调用evalScriptFormFile来执行config.lua脚本(这步很重要,必须要先执行lua文件,否则定义的方法是不生效的),再通过callMethodWithName方法来调用其initWithConfig的方法,并将config对象传给Lua进行操作。

然后编译运行就可以看到视图变成黄色了,如图所示:

可以看到LuaScriptCore可以很方便地将Lua与原生代码结合起来使用,节省了学习Lua的C Api所需要的时间,让App可以做得更加动态化(Lua脚本的更新可以使应用动态地更新)。上面的两个例子只是抛砖引玉,相信聪明你们利用LuaScriptCore创造到更多有趣好玩的东西。

最后,我想说的是LuaScriptCore是我写的^_^,该项目完全开源,有兴趣或者有疑问的同学可以给我发邮件,谢谢支持~~

© 著作权归作者所有

vimfung

vimfung

粉丝 61
博文 59
码字总数 85338
作品 4
广州
技术主管
私信 提问
加载中

评论(9)

李宏鸢
李宏鸢
6666 终于不用 lua push到c++ 然后再jni调java 或者 objc了
vimfung
vimfung 博主

引用来自“每天多一点”的评论

集成后会多大?对包大小比较敏感...
初略估算是会在500K左右😊
每天多一点
每天多一点
集成后会多大?对包大小比较敏感...
vimfung
vimfung 博主

引用来自“vimfung”的评论

引用来自“红薯”的评论

开源项目扔到 git.oschina.net 呗

@红薯 已经是放到git.oschina.net了,两边同步更新^_^

引用来自“红薯”的评论

主要是文中的链接都是 github 的,很多人访问会很慢 :)
😁已替换成码云上的链接
vimfung
vimfung 博主

引用来自“李宏鸢”的评论

Lua 和 objc 的粘合层?
是的😊
李宏鸢
李宏鸢
Lua 和 objc 的粘合层?
红薯
红薯

引用来自“vimfung”的评论

引用来自“红薯”的评论

开源项目扔到 git.oschina.net 呗

@红薯 已经是放到git.oschina.net了,两边同步更新^_^
主要是文中的链接都是 github 的,很多人访问会很慢 :)
vimfung
vimfung 博主

引用来自“红薯”的评论

开源项目扔到 git.oschina.net 呗

@红薯 已经是放到git.oschina.net了,两边同步更新^_^
红薯
红薯
开源项目扔到 git.oschina.net 呗
LuaScriptCore v2.0.0 发布,移动端 Lua 桥接框架

LuaScriptCore旨在能够在多种平台上方便地使用Lua。其提供了与各种平台的功能交互,让开发者无须关心Lua与各个平台之间是实现交互的细节,只需要根据自己的业务需求,使用LuaScriptCore提供的...

vimfung
2017/12/05
1K
1
LuaScriptCore v1.3.1,移动端 Lua 桥接框架

LuaScriptCore旨在能够在多种平台上方便地使用Lua。其提供了与各种平台的功能交互,让开发者无须关心Lua与各个平台之间是实现交互的细节,只需要根据自己的业务需求,使用LuaScriptCore提供的...

vimfung
2017/04/19
1K
1
LuaScriptCore v1.3.4 发布,移动端 Lua 桥接框架

LuaScriptCore旨在能够在多种平台上方便地使用Lua。其提供了与各种平台的功能交互,让开发者无须关心Lua与各个平台之间是实现交互的细节,只需要根据自己的业务需求,使用LuaScriptCore提供的...

vimfung
2017/06/12
314
0
LuaScriptCore v1.3.0,移动端 Lua 桥接框架

LuaScriptCore旨在能够在多种平台上方便地使用Lua。其提供了与各种平台的功能交互(目前支持iOS、Android以及OS X),让开发者无须关心Lua与各个平台之间是实现交互的细节,只需要根据自己的...

vimfung
2017/03/11
785
7
LuaScriptCore v1.2.1,移动端 Lua 桥接框架

LuaScriptCore旨在能够在多种平台上方便地使用Lua。其提供了与各种平台的功能交互(目前支持iOS、Android以及OS X),让开发者无须关心Lua与各个平台之间是实现交互的细节,只需要根据自己的...

vimfung
2016/11/25
951
0

没有更多内容

加载失败,请刷新页面

加载更多

Eureka应用注册与集群数据同步源码解析

在之前的EurekaClient自动装配及启动流程解析一文中我们提到过,在构造DiscoveryClient类时,会把自身注册到服务端,本文就来分析一下这个注册流程 客户端发起注册 boolean register() t...

Java学习录
26分钟前
5
0
Java描述设计模式(15):责任链模式

本文源码:GitHub·点这里 || GitEE·点这里 一、生活场景描述 1、请假审批流程 公司常见的请假审批流程:请假天数 当 day<=3 天,项目经理审批当 3<day<=5 天,部门经理审批当 day>5 天...

知了一笑
36分钟前
6
0
总结:数组与链表

1、内存申请:数组在内存上是连续的空间;链表,内存地址上可以是不连续的。 2、查询速度:数组可以随机访问,链表必须顺序访问,即从首个元素开始遍历,逐个查找,所以数组查询很快。 3、写入...

浮躁的码农
45分钟前
6
0
HashMap源码分析

read

V丶zxw
今天
5
0
Python字符串或JSON字符串转字典dict、列表list

有3种方法 1、使用ast模块 >>> import ast>>> s = '["test",1]'>>> ast.literal_eval(s)['test',1]>>> s = '{"test":1}'>>> ast.literal_eval(s){'test': 1} 2、eval函数,这个......

编程老陆
今天
7
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部