级别:★★☆☆☆
标签:「iOS与JS交互」「WKWebView与JS交互」「WKJSMessageHandler」
作者: Xs·H
审校: QiShare团队
先解释下标题:“iOS与JS交互”。iOS指iOS
原生代码(文章只有OC
示例),JS指WEB
前端(不单指JavaScript
),交互指JS调用iOS
和iOS调用JS
。
作者将iOS与JS交互总结成了6种方式,并将逐一介绍。目录如下:
- iOS与JS交互之UIWebView-协议拦截
- iOS与JS交互之UIWebView-JavaScriptCore框架
- iOS与JS交互之UIWebView-JSExport协议
- iOS与JS交互之WKWebView-协议拦截
- iOS与JS交互之WKWebView-WKScriptMessageHandler协议
- iOS与JS交互之WKWebView-WKUIDelegate协议
本文介绍如果使用
WKWebView
的WKScriptMessageHandler
实现iOS
与JS
交互。
WKWebView
是Apple
在iOS8推出的Webkit
框架中的负责网页的渲染与展示的类,相比UIWebView
速度更快,占用内存更少,支持更多的HTML
特性。WKScriptMessageHandler
是WebKit
提供的一种在WKWebView
上进行JS
消息控制的协议。
一、JS调用iOS:
-
实现逻辑:点击JS的登录按钮,JS将登录成功后的token数据传递给iOS,iOS将收到的数据展示出来。
-
实现效果:
JS调用iOS实现效果 -
JS代码:
//! 登录按钮
<button onclick = "login()" style = "font-size: 18px;">登录</button>
//! 登录
function login() {
var token = "js_tokenString";
loginSucceed(token);
}
//! 登录成功
function loginSucceed(token) {
var action = "loginSucceed";
window.webkit.messageHandlers.jsToOc.postMessage(action, token);
}
- iOS代码:
//! 导入WebKit框架头文件
#import <WebKit/WebKit.h>
//! WKWebViewWKScriptMessageHandlerController遵守WKScriptMessageHandler协议
@interface WKWebViewWKScriptMessageHandlerController () <WKScriptMessageHandler>
//! 为userContentController添加ScriptMessageHandler,并指明name
WKUserContentController *userContentController = [[WKUserContentController alloc] init];
[userContentController addScriptMessageHandler:self name:@"jsToOc"];
//! 使用添加了ScriptMessageHandler的userContentController配置configuration
WKWebViewConfiguration *configuration = [[WKWebViewConfiguration alloc] init];
configuration.userContentController = userContentController;
//! 使用configuration对象初始化webView
_webView = [[WKWebView alloc] initWithFrame:self.view.bounds configuration:configuration];
#pragma mark - WKScriptMessageHandler
//! WKWebView收到ScriptMessage时回调此方法
- (void)userContentController:(WKUserContentController *)userContentController didReceiveScriptMessage:(WKScriptMessage *)message {
if ([message.name caseInsensitiveCompare:@"jsToOc"] == NSOrderedSame) {
[WKWebViewWKScriptMessageHandlerController showAlertWithTitle:message.name message:message.body cancelHandler:nil];
}
}
- 实现原理:
1、JS与iOS约定好jsToOc
方法,用作JS在调用iOS时的方法;
2、iOS使用WKUserContentController
的-addScriptMessageHandler:name:
方法监听name
为jsToOc
的消息;
3、JS通过window.webkit.messageHandlers.jsToOc.postMessage()
的方式对jsToOc
方法发送消息;
4、iOS在-userContentController:didReceiveScriptMessage:
方法中读取name
为jsToOc
的消息数据message.body
。
PS:
[userContentController addScriptMessageHandler:self name:@"jsToOc"]
会引起循环引用问题。一般来说,在合适的时机removeScriptMessageHandler
可以解决此问题。比如:在-viewWillAppear:方法中
执行add
操作,在-viewWillDisappear:
方法中执行remove
操作。如下:
- (void)viewWillAppear:(BOOL)animated {
[super viewWillAppear:animated];
[_webView.configuration.userContentController addScriptMessageHandler:self name:@"jsToOc"];
}
- (void)viewWillDisappear:(BOOL)animated {
[super viewWillDisappear:animated];
[_webView.configuration.userContentController removeScriptMessageHandlerForName:@"jsToOc"];
}
二、iOS调用JS:
iOS调用JS方式与上篇文章一致,都是通过WKWebView的
-evaluateJavaScript:completionHandler:
方法来实现的。
- 可从QiShare的Github获取工程源码
关注我们的途径有:
QiShare(简书)
QiShare(掘金)
QiShare(知乎)
QiShare(GitHub)
QiShare(CocoaChina)
QiShare(StackOverflow)
QiShare(微信公众号)
推荐文章:
不一样的React context
网友评论
//! OC调用JS入口
function ocToJs(action, params) {
return document.getElementById("returnValue").innerHTML = action + '?' + params;
}
NSString *jsString = [NSString stringWithFormat:@"ocToJs('loginSucceed', 'oc_tokenString')"];
[self.webView evaluateJavaScript:jsString completionHandler:^(id response, NSError * error) {
NSLog(@"error: %@", error.description);
NSLog(@"response: %@", response);
}];