iOS下JS与OC互相调用(四)--JavaScriptCore

前面讲完拦截URL的方式实现JS与OC互相调用,终于到JavaScriptCore了。它是从iOS7开始加入的,用 Objective-C 把 WebKit 的 JavaScript 引擎封装了一下,提供了简单快捷的方式与JavaScript交互。 

关于JavaScriptCore的使用有两篇很好的文章: 

NSHipster中文版的Java​Script​Core 

iOS7 新JavaScriptCore框架入门介绍

看了上述两篇文章,对JavaScriptCore应该已经基本了解了。我就简要介绍一下,然后用代码来实际操作了。先上最终实现的效果:

1、简要介绍JavaScriptCore

JavaScriptCore是一个iOS 7 新添加的框架,使用前需要先导入JavaScriptCore.framework。 

然后我们在JavaScriptCore.h中可以看到,该框架主要的类就只有五个:

* 1.1 JSVirtualMachine * 

JSVirtualMachine看名字直译是JS 虚拟机,也就是说JavaScript是在一个虚拟的环境中执行,而JSVirtualMachine为其执行提供底层资源。

翻译这段描述:一个JSVirtualMachine实例,代表一个独立的JavaScript对象空间,并为其执行提供资源。它通过加锁虚拟机,保证JSVirtualMachine是线程安全的,如果要并发执行JavaScript,那我们必须创建多个独立的JSVirtualMachine实例,在不同的实例中执行JavaScript。

通过alloc/init就可以创建一个新的JSVirtualMachine对象。但是我们一般不用新建JSVirtualMachine对象,因为创建JSContext时,如果我们不提供一个特性的JSVirtualMachine,内部会自动创建一个JSVirtualMachine对象。

* 1.2 JSContext * 

JSContext是为JavaScript的执行提供运行环境,所有的JavaScript的执行都必须在JSContext环境中。JSContext也管理JSVirtualMachine中对象的生命周期。每一个JSValue对象都要强引用关联一个JSContext。当与某JSContext对象关联的所有JSValue释放后,JSContext也会被释放。 

创建一个JSContext对象的方式有:

// 1.这种方式需要传入一个JSVirtualMachine对象,如果传nil,会导致应用崩溃的。JSVirtualMachine *JSVM = [[JSVirtualMachine alloc] init];

JSContext *JSCtx = [[JSContext alloc] initWithVirtualMachine:JSVM];// 2.这种方式,内部会自动创建一个JSVirtualMachine对象,可以通过JSCtx.virtualMachine// 看其是否创建了一个JSVirtualMachine对象。JSContext *JSCtx = [[JSContext alloc] init];// 3. 通过webView的获取JSContext。JSContext *context = [self.webView valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"];

上面推荐的两篇文章以及网上介绍JavaScriptCore的文章多是通过1和2这两种方式创建JSContext,然后执行JavaScript,演示JavaScriptCore。我一直有疑问,如果不是HTML结合OC,才会使用到JavaScript,那在一个虚拟的环境里运行JS有上面意义。 

所以,后面我是用方式3来创建JSContext。

* 1.3 JSValue * 

JSValue都是通过JSContext返回或者创建的,并没有构造方法。JSValue包含了每一个JavaScript类型的值,通过JSValue可以将Objective-C中的类型转换为JavaScript中的类型,也可以将JavaScript中的类型转换为Objective-C中的类型。 

上述两篇文章中均有OC、JSValue、JavaScript的类型对应关系表。 

* 1.4 JSManagedValue * 

JSManagedValue主要用途是解决JSValue对象在Objective-C 堆上的安全引用问题。把JSValue 保存进Objective-C 堆对象中是不正确的,这很容易引发循环引用,而导致JSContext不能释放。 

这个类主要是将JSValue对象转换为JSManagedValue的API,而且也不常用,就不做具体介绍了。以后遇到使用场景再补充。

* 1.5 JSExport * 

JSExport是一个协议类,但是该协议并没有任何属性和方法。 

怎么使用呢? 

我们可以自定义一个协议类,继承自JSExport。无论我们在JSExport里声明的属性,实例方法还是类方法,继承的协议都会自动的提供给任何 JavaScript 代码。 

So,我们只需要在自定义的协议类中,添加上属性和方法就可以了。

2、代码操作展示

因为该系列主要是JS与OC互调,所以主要介绍如何用JavaScriptCore实现JS与OC互调。

2.1 创建UIWebView,并加载本地HTML。

这步跟 文章(一)中的步骤一是一样的。

self.webView = [[UIWebView alloc] initWithFrame:self.view.frame];

    self.webView.delegate = self;

    NSURL *htmlURL = [[NSBundle mainBundle] URLForResource:@"index.html" withExtension:nil];//    NSURL *htmlURL = [NSURL URLWithString:@"http://www.baidu.com"];    NSURLRequest *request = [NSURLRequest requestWithURL:htmlURL];

    // 如果不想要webView 的回弹效果    self.webView.scrollView.bounces = NO;

    // UIWebView 滚动的比较慢,这里设置为正常速度    self.webView.scrollView.decelerationRate = UIScrollViewDecelerationRateNormal;

    [self.webView loadRequest:request];

    [self.view addSubview:self.webView];

HTML的内容也大致一样,不过JS的调用有些区别,更简单了。

functionshareClick(){ share('测试分享的标题','测试分享的内容','url=http://www.baidu.com');

}functionshareResult(channel_id,share_channel,share_url){    var content = channel_id+","+share_channel+","+share_url;

    asyncAlert(content);

    document.getElementById("returnValue").value = content;

}functionlocationClick(){    getLocation();

}functionsetLocation(location){    asyncAlert(location);

    document.getElementById("returnValue").value = location;

}

更详细的可以看demo中的HTML源码,demo地址在文章末。

2.2 添加JS要调用的原生OC方法

在HMTL加载成功的回调方法- (void)webViewDidFinishLoad:(UIWebView *)webView中添加要调用的原生OC方法。

#pragma mark - UIWebViewDelegate- (void)webViewDidFinishLoad:(UIWebView *)webView

{

    NSLog(@"webViewDidFinishLoad");

    [self addCustomActions];

}

将所有要添加的功能方法,集中到一个方法addCustomActions中,便于维护。

#pragma mark - private method-(void)addCustomActions{

    JSContext *context = [self.webView valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"];

    [self addScanWithContext:context];

    [self addLocationWithContext:context];

    [self addSetBGColorWithContext:context];

    [self addShareWithContext:context];

    [self addPayActionWithContext:context];

    [self addShakeActionWithContext:context];

    [self addGoBackWithContext:context];

}

然后每一个小功能独立开来,这样修改和解决Bug的时候能够快速定位到某个功能。

- (void)addShareWithContext:(JSContext *)context

{

    __weak typeof(self) weakSelf = self;

    context[@"share"] = ^() {

        NSArray *args = [JSContext currentArguments];

        if (args.count < 3) {

            return ;

        }

        NSString *title = [args[0] toString];

        NSString *content = [args[1] toString];

        NSString *url = [args[2] toString];

        // 在这里执行分享的操作...        // 将分享结果返回给js        NSString *jsStr = [NSString stringWithFormat:@"shareResult('%@','%@','%@')",title,content,url];

        [[JSContext currentContext] evaluateScript:jsStr];

    };

}

注意: 

* 1.JS要调用的原生OC方法,可以在viewDidLoad webView被创建后就添加好,但最好是在网址加载成功后再添加,以避免无法预料的乱入Bug。 

* 2.block 中的执行环境是在子线程中。奇怪的是竟然可以更新部分UI,例如给view设置背景色,调用webView执行js等,但是弹出原生alertView就会在控制台报子线程操作UI的错误信息。 

* 3.避免循环引用,因为block 会持有外部变量,而JSContext也会强引用它所有的变量,因此在block中调用self时,要用__weak 转一下。而且在block内不要使用外部的context 以及JSValue,都会导致循环引用。如果要使用context 可以使用[JSContext currentContext]。当然我们可以将JSContext 和JSValue当做block的参数传进去,这样就可以使用啦。

2.3 OC调用JS方法

OC调用JS方法就有多种方式了。首先介绍使用JavaScriptCore框架的方式。 

* 方式1 * 

使用JSContext的方法-evaluateScript,可以实现OC调用JS方法。 

下面是一个调用JS中payResult方法的示例代码:

NSString *jsStr = [NSString stringWithFormat:@"payResult('%@')",@"支付成功"];

[[JSContext currentContext] evaluateScript:jsStr];

* 方式2 * 

使用JSValue的方法-callWithArguments,也可以实现OC调用JS方法。 

下面这个示例代码依然是调用JS中的payResult:

JSContext *context = [self.webView valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"];

[context[@"payResult"] callWithArguments:@[@"支付弹窗"]];

当然,如果是在执行原生OC方法之后,想要在OC执行完操作后,将结果回调给JS时,可以这样写:

- (void)addPayActionWithContext:(JSContext *)context

{

    context[@"payAction"] = ^() {

        NSArray *args = [JSContext currentArguments];

        if (args.count < 4) {

            return ;

        }

        NSString *orderNo = [args[0] toString];

        NSString *channel = [args[1] toString];

        long long amount = [[args[2] toNumber] longLongValue];

        NSString *subject = [args[3] toString];

        // 支付操作        NSLog(@"orderNo:%@---channel:%@---amount:%lld---subject:%@",orderNo,channel,amount,subject);

        // 将支付结果返回给js        [[JSContext currentContext][@"payResult"] callWithArguments:@[@"支付成功"]];

    };

}

* 方式3 *以前介绍过的,利用UIWebView的API。

NSString *jsStr = [NSString stringWithFormat:@"payResult('%@')",@"支付成功"];

[weakSelf.webView stringByEvaluatingJavaScriptFromString:jsStr];

3、补充介绍JavaScriptCore

好处:使用JavaScriptCore,JS调用Native方法时,参数的传递更方便,不用担心特殊符号的转换问题。 

不好的地方:只能使用在iOS 7以上。这点我相信现在基本没有多少应用还兼容iOS 6了吧,我去年在做这个功能的时候,还要兼容iOS 6 �� �� 。

先把JS与OC互调部分的介绍完了,这里再补充一些关于JavaScriptCore的相关知识。 

在OC中如何往JS环境中添加一个变量,便于后续在JS中使用呢?

JSContext *context = [[JSContext alloc] init];

[context evaluateScript:@"var arr = [3, 4, 'abc'];"];

而用到实际的UIWebView上,可以这样:

JSContext *context = [self.webView valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"];

[context evaluateScript:@"var arr = [3, 4, 'abc'];"];

当上面这两行代码执行完后,我点击HTML中的按钮

functionshowArr(){

    asyncAlert(arr);

}functionasyncAlert(content) {

    setTimeout(function(){

              alert(content);

        },1);

}

直接输出arr,结果是这样的:

如果我们在OC中想要取出arr,只需要这样:

JSValue *value = context[@"arr"];

OC中的block可以传入到JavaScript中,这样就创建了一个新的JS方法。我们上面的JS调用OC方法,就是利用的这个实现的。

关于JSExport如何使用? 

JSExport 主要是用于将OC中定义的Model类等引入到JavaScript中,便于在JS中使用这种对象和对象的属性、方法。 

JSExport的大致使用流程是: 

1.创建一个自定义协议XXXExport 继承自JSExport。 

2.在自定义的XXXExport中添加JS里需要调用的属性和方法。 

3.在自定义的Model类中实现XXXExport中的属性的get/set方法以及定义的方法。 

4.通过JSContext将Model类或者Model类的实例插入到JavaScript中。

当然,我们也可以给已经存在的类动态添加协议,来使其可以供JS 使用。这些示例和示例代码,在文章NSHipster中文版的Java​Script​Core 和 JavaScriptCore框架在iOS7中的对象交互和管理中有很详细的介绍和使用展示。

WKWebView 与JavaScriptCore

关于WKWebView 与JavaScriptCore,由于WKWebView 不支持通过如下的KVC的方式创建JSContext:

JSContext *context = [self.webView valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"];

那么就不能在WKWebView中使用JavaScriptCore了。 

而且,WKWebView中有OC 和JS交互的方式,更easy 、更简洁,因此也用不着使用JavaScriptCore。 

WKWebView中如何实现OC与JS交互可以看前面这篇文章:iOS下JS与OC互相调用(三)–MessageHandler

UIWebView利用JavaScriptCore来实现交互的示例工程:JS_OC_JavaScriptCore

Have Fun!

版权声明:本文为博主原创文章,转载请注明出处。 https://blog.csdn.net/u011619283/article/details/52311143

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,132评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,802评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,566评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,858评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,867评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,695评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,064评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,705评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,915评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,677评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,796评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,432评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,041评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,992评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,223评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,185评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,535评论 2 343

推荐阅读更多精彩内容

  • 随着H5技术的兴起,在iOS开发过程中,难免会遇到原生应用需要和H5页面交互的问题。其中会涉及方法调用及参数传值等...
    Chris_js阅读 3,056评论 1 8
  • OC与JS交互之JavaScriptCore 本文摘抄自:https://hjgitbook.gitbooks.i...
    大冲哥阅读 1,017评论 0 1
  • 本博客主要分以下几个方面来介绍iOS中的JavaScriptCore JavaScriptCore简介 JavaS...
    dullgrass阅读 4,265评论 1 38
  • 前言 Web 页面中的 JS 与 iOS Native 如何交互是每个 iOS 猿必须掌握的技能。而说到 Nati...
    幽城88阅读 2,194评论 1 8
  • 前不久一口气买了八九本书也计划着每周一点一点看完还有两三本吧 已经迫不及待又想买新书了凑单的时候反复纠结最后选了这...
    Mangobb阅读 467评论 0 1