技术改变生活

Technology changes life,Life-long learning

iOS - OC 与 JS 交互六种方式总结

序言

在 APP 中,免不了与 H5页面打交道,所以掌握 与 JS 交互就显的至关重要,本文总结了常见的与 JS 交互方式。

一 UIWebView 拦截 URL
1.1 JS 调用原生 OC

注意事项

1.JS中的firstClick,在拦截到的url scheme全都被转化为小写。
2.html 中需要设置编码,否则中文参数可能会出现编码问题。
3.JS用打开一个iFrame的方式替代直接用document.location的方式,以避免多次请求,被替换覆盖的问题

1.2 OC 调用 JS

在 OC 原生中

注意:该方法会同步返回一个字符串,因此是一个同步方法,可能会阻塞主线程。

在 html 文件中

早期的JS与原生交互的开源库很多都是用得这种方式来实现的,例如:PhoneGap、WebViewJavascriptBridge

效果图

《iOS - OC 与 JS 交互六种方式总结》
js_oc_intercept_url.gif
二 WKWebView拦截 URL
2.1 JS调用 OC

使用WKNavigationDelegate中的代理方法,拦截自定义的 URL 来实现 JS 调用 OC 方法。

注意点

如果实现了这个代理方法,就必须得调用decisionHandler这个 block,否则会导致 app 奔溃。block 参数是一个枚举值,WKNavigationActionPolicyCancel代表取消加载,相当于UIWebView的代理方法return NO的情况;WKNavigationActionPolicyAllow代表允许加载,相当于UIWebView的代理方法中 return YES的情况。

关于如何区分执行不同的OC 方法,也与UIWebView的处理方式一样,通过URL 的host 来区分执行不同的方法:

2.2 OC 调用 JS 方法

JS 调用OC 方法后,有的操作可能需要将结果返回给JS。这时候就是OC 调用JS 方法的场景。
WKWebView 提供了一个新的方法evaluateJavaScript:completionHandler:,实现OC 调用JS 等场景。

注意点

evaluateJavaScript:completionHandler:没有返回值,JS 执行成功还是失败会在completionHandler 中返回。所以使用这个API 就可以避免执行耗时的JS,或者alert 导致界面卡住的问题。

运行结果

《iOS - OC 与 JS 交互六种方式总结》
JS_OC_WK_URL.gif
三 JavaScriptCore (UIWebView)
3.1 JS 调用原生 OC

在iOS 7之后,apple添加了一个新的库JavaScriptCore,用来做JS交互,因此JS与原生OC交互也变得简单了许多。

首先导入JavaScriptCore库, 然后在OC中获取JS的上下文。

再然后定义好JS需要调用的方法,例如JS要调用share方法:
则可以在UIWebView加载url完成后,在其代理方法中添加要调用的share方法:

3.2 OC 调用 JS

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

  • 方式一

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

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

效果图

《iOS - OC 与 JS 交互六种方式总结》
js_oc_javaScriptCore.gif
四 MessageHandler(WKWebView)

使用WKWebView的时候,如果想要实现JS调用OC方法,除了拦截URL之外,还有一种简单的方式。那就是利用WKWebView的新特性MessageHandler来实现JS调用原生方法。

4.0 怎么使用MessageHandler?

创建WKWebViewConfiguration对象,配置各个API对应的MessageHandler。

WKUserContentController对象可以添加多个scriptMessageHandler。

然后在界面即将显示的时候添加MessageHandler

需要注意的是addScriptMessageHandler很容易引起循环引用,导致控制器无法被释放,所以需要移除MessageHandler

4.1 实现协议方法 – JS调用 OC

这里实现了两个协议<WKUIDelegate,WKScriptMessageHandler>WKUIDelegate是因为我在JS中弹出了alert 。WKScriptMessageHandler是因为我们要处理JS调用OC方法的请求。

WKScriptMessage有两个关键属性namebody
因为我们给每一个OC 方法取了一个name,那么我们就可以根据name 来区分执行不同的方法。body 中存着JS 要给OC 传的参数。

关于参数body 的解析,我就举一个body中放字典的例子,其他的稍后可以看demo。
解析JS 调用OC 实现分享的参数:

message.boby 就是JS 里传过来的参数。我们不同的方法先做一下容错性判断。然后正常取值就可以了。

4.2 处理HTML中JS调用

下面只列举一个shareClick()方法,其他看Demo

4.3 OC调用JS

这里使用WKWebView 实现OC 调用JS方法与之前说的文章一样,通过
- evaluateJavaScript:completionHandler:

4.4 使用MessageHandler的好处
  • 1.在JS中写起来简单,不用再用创建URL的方式那么麻烦了。
  • 2.JS传递参数更方便。使用拦截URL的方式传递参数,只能把参数拼接在后面,如果遇到要传递的参数中有特殊字符,如&、=、?等,必须得转换,否则参数解析肯定会出错。

效果图如下图所示

《iOS - OC 与 JS 交互六种方式总结》
JS_OC_WK_MessageHandler.gif
五 WebViewJavascriptBridge(UIWebView)

详情看下面文章链接
iOS下 JS 与 OC 互相调用(五) – UIWebView+WebViewJavascriptBridge

六 WebViewJavascriptBridge(WKWebView)

详情看下面文章链接
iOS下 JS 与 OC 互相调用(六) – WKWebView+WKWebViewJavascriptBridge


详细讲解请看下面文章

iOS下 JS 与OC 互相调用(一) – UIWebView 拦截 URL
iOS下 JS 与OC 互相调用(二) – JavaScriptCore
iOS 下 JS 与 OC 互相调用(三) – WKWebView 拦截 URL
iOS下JS与OC互相调用(四)-MessageHandler
iOS下 JS 与 OC 互相调用(五) – UIWebView+WebViewJavascriptBridge
iOS下 JS 与 OC 互相调用(六) – WKWebView+WKWebViewJavascriptBridge

原文始发于:iOS – OC 与 JS 交互六种方式总结

点赞