iOS与JavaScript交互二: JavaScriptCore

简介

iOS 7.0开始,iOS加入了JavaScriptCore框架。用Objective-CWebKitJavaScript引擎封装了一下,提供了简单快捷的方式与JavaScript交互。

JavaScriptCore使用

NSHipster中文版的Java​Script​Core
iOS7 新JavaScriptCore框架入门介绍

简要介绍JavaScriptCore

#ifndef JavaScriptCore_h
#define JavaScriptCore_h

#include <JavaScriptCore/JavaScript.h>
#include <JavaScriptCore/JSStringRefCF.h>

#if defined(__OBJC__) && JSC_OBJC_API_ENABLED

#import "JSContext.h"
#import "JSValue.h"
#import "JSManagedValue.h"
#import "JSVirtualMachine.h"
#import "JSExport.h"

#endif
#endif /* JavaScriptCore_h */

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

JSVirtualMachine

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

/*!
@interface
@discussion An instance of JSVirtualMachine represents a single JavaScript "object space"
 or set of execution resources. Thread safety is supported by locking the
 virtual machine, with concurrent JavaScript execution supported by allocating
 separate instances of JSVirtualMachine.
*/
NS_CLASS_AVAILABLE(10_9, 7_0)
@interface JSVirtualMachine : NSObject

翻译这段描述:

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

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

JSContext

JSContext是为JavaScript的执行提供运行环境,所有的JavaScript的执行都必须在JSContext环境中。JSContext也管理JSVirtualMachine中对象的生命周期。每一个JSValue对象都要强引用关联一个JSContext。当与某JSContext对象关联的所有JSValue释放后,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结合UIWebView,才会使用到JavaScript,那在一个虚拟的环境里运行JS有什么意义。所以,后面我是用方式3来创建JSContext

JSValue

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

JSManagedValue

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

JSExport

JSExport是一个协议类,但是该协议并没有任何属性和方法。我们可以自定义一个协议类,继承自JSExport。无论我们在JSExport里声明的属性,实例方法还是类方法,继承的协议都会自动的提供给任何JavaScript代码。我们只需要在自定义的协议类中,添加上属性和方法就可以了。

使用

本地HTML
<!DOCTYPE html>
<html lang="zh-cn">
<head>
    <meta charset="UTF-8">
    <title>Title</title>

    <script>
        function loadURL(url) {
            var iFrame;
            iFrame = document.createElement("iframe");
            iFrame.setAttribute("src", url);
            iFrame.setAttribute("style", "display:none;");
            iFrame.setAttribute("height", "0px");
            iFrame.setAttribute("width", "0px");
            iFrame.setAttribute("frameborder", "0");
            document.body.appendChild(iFrame);
            // 发起请求后这个iFrame就没用了,所以把它从dom上移除掉
            iFrame.parentNode.removeChild(iFrame);
            iFrame = null;
        }

        function asyncAlert(content) {
            setTimeout(function(){
                alert(content);
            },1);
        }
        
        function showAlertClick() {
            showAlert();
        }
        
        function alertWithString(content) {
            asyncAlert(content);
            document.getElementById("returnValue").value = content;
        }
        
        function callMethodClick() {
            setColor();
        }
        
        function callMethodWithObjectClick() {
            bridge.setColorWithRGB(20, 180, 250, 0.5);
        }

    </script>
</head>
<body>

    <input type="button" value="OC调用JS" onclick="showAlertClick()">
    <input type="button" value="JS直接调用OC" onclick="callMethodClick()">
    <input type="button" value="JS通过对象调用OC" onclick="callMethodWithObjectClick()">

</body>
</html>
加载WebView
- (void)loadWebView {
    self.webView = [[UIWebView alloc] initWithFrame:self.view.bounds];
    self.webView.delegate = self;
    
    NSURL *indexURL = [[NSBundle mainBundle] URLForResource:@"index1" withExtension:@"html"];
    NSURLRequest *request = [NSURLRequest requestWithURL:indexURL];
    [self.webView loadRequest:request];
    [self.view addSubview:self.webView];
}
获取JSContext

实现UIWebViewDelegate协议方法- (void)webViewDidFinishLoad:(UIWebView *)webView

#pragma mark - UIWebViewDelegate
- (void)webViewDidFinishLoad:(UIWebView *)webView {
    JSContext *context = [self.webView valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"];
    [self showAlertWithContext:context];
    [self setColorWithContext:context];
    [self setColorByInterfaceWithContext:context];
}
OC调用JS
  • UIWebView调用JS方法
[context evaluateScript:@"alertWithString('OC调用JS方法')"];
  • JSContext调用JS方法
- (void)showAlertWithContext:(JSContext *)context {
    context[@"showAlert"] = ^(){
        dispatch_async(dispatch_get_main_queue(), ^{
            NSString *jsStr = [NSString stringWithFormat:@"alertWithMessage('%@')", @"OC调用JS方法"];
            [self.webView stringByEvaluatingJavaScriptFromString:jsStr];
        });
    };
}
JS调用OC
  • JS直接调用方法
    这种方式是通过block的方式。
- (void)setColorWithContext:(JSContext *)context {
    context[@"setColor"] = ^() {
        dispatch_async(dispatch_get_main_queue(), ^{
            UIColor *color = [UIColor colorWithRed:arc4random()%256/255.0f green:arc4random()%256/255.0f blue:arc4random()%256/255.0f alpha:0.5];
            self.navigationController.navigationBar.backgroundColor = color;
        });
    };
}
  • JS通过对象调用方法
    先声明一个继承自JSExport的协议,声明方法。
#import <Foundation/Foundation.h>
#import <JavaScriptCore/JavaScriptCore.h>

@protocol JSBridge <JSExport>

// - (void)goURL:(NSString *)URL; 一个参数
// 当方法有两个或两个以上参数时,OC方法与JS方法保持一致
JSExportAs(setColorWithRGB, - (void)setColorWithRGB:(int)red green:(int)green blue:(int)blue alpha:(double)alpha);

@end

Controller遵守协议实现方法。

- (void)setColorWithRGB:(int)red green:(int)green blue:(int)blue alpha:(double)alpha {
    dispatch_async(dispatch_get_main_queue(), ^{
        UIColor *color = [UIColor colorWithRed:red/255.0f green:green/255.0f blue:blue/255.0f alpha:alpha];
        self.navigationController.navigationBar.backgroundColor = color;
    });
}

JSContext注册对象:

- (void)setColorByInterfaceWithContext:(JSContext *)context {
    // 当前JSContext注册对象
    context[@"bridge"] = self;
}
效果

WKWebView与JavaScriptCore

由于WKWebView不支持通过如下的KVC的方式创建JSContext,所以WKWebView中如何实现OCJS交互可以看前面这篇文章iOS与JavaScript交互三: MessageHandler

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

推荐阅读更多精彩内容