客户端与JS交互

JavaScript014

客户端与JS交互,第1张

客户端在做完基本UI界面之后,往往都会向JS与客户端交互上发展,简单来说就是:客户端调用JS方法,JS调用客户端方法,这样做对app灵活性方面有了极大提升。

网上比较好用的第三方框架很多,比较典型的有 webviewJavaScriptBridge ,苹果自iOS7之后推出的一款框架叫 JavaScriptCore

JavaScriptCore 是在webview的didFinishLoad里面注入JS语句,完成两端的相互调用,我查过一些资料,对这个框架用着不舒服,于是就转向了 webviewJavaScriptBridge ,下面我就着重记录一下自己在开发这块功能时候的笔记和想法。

webviewJavaScriptBridge 兼容iOS6之前和之后,同样也兼容了iOS8推出的 WKWebView ,我想用过 WKWebView 的人都知道它比之 UIWebView 的优势, webviewJavaScriptBridge 能兼容 WKWebView 是再好不过了。

往简单了说, webviewJavaScriptBridge 的使用主要是靠 WKWebViewJavascriptBridge 来连接OC端(也即客户端)与JS端,这里我们需要配合服务端来做,规定好方法名,调用 registerHandler 和 callHandler 就可以了。

[self.bridge setWebViewDelegate:self]这个可要可不要,有时候可能需要在webview代理方法中处理一些UI上的显示问题,所以我这里保留了。但是这样的话就可能造成循环引用,因为self持有webview,而webview又持有self,所以我在这里用了weak修饰webview就可以了。

简单来说,在客户端只需要在合适的地方调用

两端的调用总体来说就是这样,是不是很方便呢?注意要和前端同事协调好方法名

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

注意事项

在 OC 原生中

在 html 文件中

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

效果图

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

注意点

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

JS 调用OC 方法后,有的操作可能需要将结果返回给JS。这时候就是OC 调用JS 方法的场景。

WKWebView 提供了一个新的方法 evaluateJavaScript:completionHandler: ,实现OC 调用JS 等场景。

注意点

运行结果

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

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

再然后定义好JS需要调用的方法,例如JS要调用share方法:

则可以在UIWebView加载url完成后,在其代理方法中添加要调用的share方法:

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

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

效果图

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

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

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

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

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

WKScriptMessage 有两个关键属性 name 和 body 。

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

关于参数body 的解析,我就举一个body中放字典的例子,其他的稍后可以看demo。

解析JS 调用OC 实现分享的参数:

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

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

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

- evaluateJavaScript:completionHandler:

效果图如下图所示

详情看下面文章链接

iOS下 JS 与 OC 互相调用(五) - UIWebView+WebViewJavascriptBridge

详情看下面文章链接

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

Demo: https://github.com/gwpp/jsinterface

不论是在创业团队中快速试错,还是在成熟团队中快速迭代复杂需求,还或者是其他原因,WebView在APP中的大量使用已经成为了一个明显的趋势,这也应该算是大前端融合的一个表象吧。笔者在工作中也遇到过很多App&Js交互的问题,粗浅的研究了一下,这里也分享给大家,如果有错误的地方还请下方留言指出,共同进步。

众所周知,iOS有 UIWebView 、 WKWebView 两个组件可以用来渲染嵌入页面。前者使用甚广,出生的也早,后者是iOS8推出的,优化了加载速度和内存,安全性上也有所提升。具体的两者比较百度、上都很多,这里不做赘述。

前两种方法到此就介绍完了,很简单,但是在项目大了之后拦截跳转的代理方法中会有非常多的判断。冗余、可维护性差,硬编码重。所以我们会有下面的其他方法。

JSContext即JavaScriptContext,这个东西在UIWebView中可以拿到,但是在WKWebView中却是取不到了,所以只能用在UIWebView中。除此以外Android里也有类似的一个东西,所以使用JSContext就有了在JS端多平台统一的可能,这里不多说,在《App与Js交互(三)》中会有详细说明。

JSContext的原理就是iOS暴露出去一个遵守 <JSExport>协议的对象给JS,JS可以直接调用该对象的public方法。

window.webkit.messagehandlers.<name>.postMessage 是apple推荐使用的WKWebView的JS交互方式,使用起来比较简单,不支持callback回调。