iOS下JS与OC互相调用(三)--MessageHandler
使用WKWebView的时候,如果想要实现JS调用OC方法,除了拦截URL之外,还有一种简单的方式。那就是利用WKWebView的新特性MessageHandler来实现JS调用原生方法。
MessageHandler 是什么?
WKWebView 初始化时,有一个参数叫configuration,它是WKWebViewConfiguration
类型的参数,而WKWebViewConfiguration
有一个属性叫userContentController
,它又是WKUserContentController
类型的参数。WKUserContentController
对象有一个方法- addScriptMessageHandler:name:
,我把这个功能简称为MessageHandler。
- addScriptMessageHandler:name:
有两个参数,第一个参数是userContentController的代理对象,第二个参数是JS里发送postMessage的对象。
所以要使用MessageHandler功能,就必须要实现WKScriptMessageHandler
协议。
我们在该API的描述里可以看到在JS中的使用方法:
window.webkit.messageHandlers.<name>.postMessage(<messageBody>)
//其中<name>,就是上面方法里的第二个参数`name`。
//例如我们调用API的时候第二个参数填@"Share",那么在JS里就是:
//window.webkit.messageHandlers.Share.postMessage(<messageBody>)
//<messageBody>是一个键值对,键是body,值可以有多种类型的参数。
// 在`WKScriptMessageHandler`协议中,我们可以看到mssage是`WKScriptMessage`类型,有一个属性叫body。
// 而注释里写明了body 的类型:
Allowed types are NSNumber, NSString, NSDate, NSArray, NSDictionary, and NSNull.
怎么使用MessageHandler?
1.创建WKWebViewConfiguration
对象,配置各个API对应的MessageHandler。
WKUserContentController
对象可以添加多个scriptMessageHandler。
看了示例代码,会很容易理解。示例代码如下:
WKWebViewConfiguration *configuration = [[WKWebViewConfiguration alloc] init];configuration.userContentController = [WKUserContentController new];[configuration.userContentController addScriptMessageHandler:self name:@"ScanAction"];[configuration.userContentController addScriptMessageHandler:self name:@"Location"];[configuration.userContentController addScriptMessageHandler:self name:@"Share"];[configuration.userContentController addScriptMessageHandler:self name:@"Color"];[configuration.userContentController addScriptMessageHandler:self name:@"Pay"];[configuration.userContentController addScriptMessageHandler:self name:@"Shake"];[configuration.userContentController addScriptMessageHandler:self name:@"GoBack"];[configuration.userContentController addScriptMessageHandler:self name:@"PlaySound"];WKPreferences *preferences = [WKPreferences new];preferences.javaScriptCanOpenWindowsAutomatically = YES;preferences.minimumFontSize = 40.0;configuration.preferences = preferences;
2.创建WKWebView。
这里没什么好说的,直接看示例代码吧:
self.webView = [[WKWebView alloc] initWithFrame:self.view.frame configuration:configuration];NSString *urlStr = [[NSBundle mainBundle] pathForResource:@"index.html" ofType:nil];NSURL *fileURL = [NSURL fileURLWithPath:urlStr];[self.webView loadFileURL:fileURL allowingReadAccessToURL:fileURL];self.webView.navigationDelegate = self;self.webView.UIDelegate = self;[self.view addSubview:self.webView];
3.实现协议方法。
我这里实现了两个协议<WKUIDelegate,WKScriptMessageHandler>
,WKUIDelegate
是因为我在JS中弹出了alert 。WKScriptMessageHandler
是因为我们要处理JS调用OC方法的请求。
先看实现协议方法的示例代码:
#pragma mark - WKScriptMessageHandler
- (void)userContentController:(WKUserContentController *)userContentController didReceiveScriptMessage:(WKScriptMessage *)message
{
// message.body -- Allowed types are NSNumber, NSString, NSDate, NSArray,NSDictionary, and NSNull.if ([message.name isEqualToString:@"ScanAction"]) {NSLog(@"扫一扫");} else if ([message.name isEqualToString:@"Location"]) {[self getLocation];} else if ([message.name isEqualToString:@"Share"]) {[self shareWithParams:message.body];} else if ([message.name isEqualToString:@"Color"]) {[self changeBGColor:message.body];} else if ([message.name isEqualToString:@"Pay"]) {[self payWithParams:message.body];} else if ([message.name isEqualToString:@"Shake"]) {[self shakeAction];} else if ([message.name isEqualToString:@"GoBack"]) {[self goBack];} else if ([message.name isEqualToString:@"PlaySound"]) {[self playSound:message.body];}
}
WKScriptMessage
有两个关键属性name
和 body
。
因为我们给每一个OC 方法取了一个name,那么我们就可以根据name 来区分执行不同的方法。body 中存着JS 要给OC 传的参数。
关于参数body 的解析,我就举一个body中放字典的例子,其他的稍后可以看demo。
解析JS 调用OC 实现分享的参数:
- (void)shareWithParams:(NSDictionary *)tempDic
{if (![tempDic isKindOfClass:[NSDictionary class]]) {return;}NSString *title = [tempDic objectForKey:@"title"];NSString *content = [tempDic objectForKey:@"content"];NSString *url = [tempDic objectForKey:@"url"];// 在这里执行分享的操作// 将分享结果返回给jsNSString *jsStr = [NSString stringWithFormat:@"shareResult('%@','%@','%@')",title,content,url];[self.webView evaluateJavaScript:jsStr completionHandler:^(id _Nullable result, NSError * _Nullable error) {NSLog(@"%@----%@",result, error);}];
}
message.boby 就是JS 里传过来的参数。我们不同的方法先做一下容错性判断。然后正常取值就可以了。
4.处理HTML中JS调用。
HMTL的源码跟之前的HTML内容差不多,只有JS的调用部分改变了。
// 传null
function scanClick() {window.webkit.messageHandlers.ScanAction.postMessage(null);
}
// 传字典
function shareClick() {window.webkit.messageHandlers.Share.postMessage({title:'测试分享的标题',content:'测试分享的内容',url:'http://www.baidu.com'});
}
// 传字符串
function playSound() { window.webkit.messageHandlers.PlaySound.postMessage('shake_sound_male.wav');
}
// 传数组
function colorClick() {window.webkit.messageHandlers.Color.postMessage([67,205,128,0.5]);
}
5.OC调用JS
这里使用WKWebView 实现OC 调用JS方法跟上一篇是一样的,还是利用
- evaluateJavaScript:completionHandler:
。像下面这样使用:
// 将分享结果返回给jsNSString *jsStr = [NSString stringWithFormat:@"shareResult('%@','%@','%@')",title,content,url];[self.webView evaluateJavaScript:jsStr completionHandler:^(id _Nullable result, NSError * _Nullable error) {NSLog(@"%@----%@",result, error);}];
使用MessageHandler 的好处
- 1.在JS中写起来简单,不用再用创建URL的方式那么麻烦了。
- 2.JS传递参数更方便。使用拦截URL的方式传递参数,只能把参数拼接在后面,如果遇到要传递的参数中有特殊字符,如&、=、?等,必须得转换,否则参数解析肯定会出错。
例如传递的url是这样的:
http://www.baidu.com/share/openShare.htm?share_uuid=shdfxdfdsfsdf&name=1234556
使用拦截URL 的JS调用方式loadURL("firstClick://shareClick?title=分享的标题&content=分享的内容&url=链接地址&imagePath=图片地址"); }
将上面的url 放入链接地址这里后,根本无法区分share_uuid是其他参数,还是url里附带的参数。
但是使用MessageHandler 就可以避免特殊字符引起的问题。
效果图
iOS下JS与OC互相调用(三)--MessageHandler相关推荐
- iOS下JS与OC互相调用(五)--UIWebView + WebViewJavascriptBridge
WebViewJavascriptBridge是一个有点年代的JS与OC交互的库,使用该库的著名应用还挺多的,目前这个库有7000+star.我去翻看了它的第一版本已经是4年前了,在版本V4.1.4以 ...
- iOS下JS与OC互相调用(六)--WKWebView + WebViewJavascriptBridge
2019独角兽企业重金招聘Python工程师标准>>> iOS下JS与OC互相调用(六)--WKWebView + WebViewJavascriptBridge 转载:原地址 ht ...
- iOS下JS与OC互相调用(一)--UIWebView 拦截URL
1.在JS 中做一次URL跳转,然后在OC中拦截跳转.(这里分为UIWebView 和 WKWebView两种,去年因为还要兼容iOS 6,所以没办法只能采用UIWebView来做.) 2.利用WKW ...
- iOS下JS与OC互相调用(四)--JavaScriptCore
前面讲完拦截URL的方式实现JS与OC互相调用,终于到JavaScriptCore了.它是从iOS7开始加入的,用 Objective-C 把 WebKit 的 JavaScript 引擎封装了一下, ...
- iOS下JS与OC互相调用(二)--WKWebView 拦截URL
在上篇文章中讲述了使用UIWebView拦截URL的方式来处理JS与OC交互. 由于UIWebView比较耗内存,性能上不太好,而苹果在iOS 8中推出了WKWebView. 同样的用WKWebVie ...
- iOS下JS与OC互相调用(七)--Cordova 基础
Cordova 简介 在介绍Cordova之前,必须先提一下PhoneGap.PhoneGap 是Nitobi软件公司2008年推出的一个框架,旨在弥补web 和iOS 之间的不足,使得web 和 i ...
- iOS下JS与OC互相调用(八)--Cordova详解+实战
1.新建工程,添加Cordova 关键类 我这里用Xcode 8 新建了一个工程,叫 JS_OC_Cordova,然后将Cordova关键类添加进工程. 有哪些关键类呢? 这里添加config.xml ...
- iOS中JS 与OC的交互(JavaScriptCore.framework)
iOS中实现js与oc的交互,目前网上也有不少流行的开源解决方案: 如:react native 当然一些轻量级的任务使用系统提供的UIWebView 以及JavaScriptCore.framewo ...
- ios下js复制到粘贴板_h5实现一键复制到粘贴板 兼容ios
实现原理 采用document.execCommand('copy') 来实现复制到粘贴板功能 复制必须是选中input框的文字内容,然后执行document.execCommand('copy') ...
最新文章
- C++知识点61——typename与class、模板编程与继承、模板类和友元、类模板与static成员
- Linux 脚本编写基础(二)
- 《数据结构与算法》课程设计报告——赫夫曼编码/译码器
- jaxb int convert to integer
- stm32外部中断_STM32学习笔记 | 电源管理及低功耗设计要点
- Eclipse创建Maven父子项目
- 格式化 SQL 来提高效率
- 支持x64的开发工具
- apache 服务器修改网站默认首页
- 网络工程师--网络规划和设计案例分析(4)
- 第五章——树(数据结构)
- 初识mac 之设置篇
- 你以为的匿名评价,原来并没真的匿名
- linux 获取视频截图,linux ffmpeg 视频截图 安装使用
- 为什么onenote一直在加载_用OneNote打造全平台的数字笔记本
- JAVA冰箱评测开题报告_基于CFD的风冷冰箱后风道数值计算和优化设计开题报告...
- 在word修改模式下如何进行修改
- 消息中间件架构面面观
- **在一个字符串中寻找另外一个字符串**
- 想让你跟古埃及法老都无障碍沟通,Google 上线了这款工具
热门文章
- Windows客户端C/C++编程规范“建议”——风格
- CUDA Samples:Vector Add
- 【C++】C++11新增关键字详解
- java 操作mysql数据库得到错误码_[数据库/Java]数据库开发过程中产生的MySQL错误代码及其解决方案...
- bootstrap 两个轮播图冲突_Bootstrap的轮播图样式
- String类常用方法(看一眼就懂)
- iOS SwiftUI篇-4 注解@State、@Binding、@ObservedObject、@EnvironmentObject、@Environment
- uniapp自定义导航栏样式,自定义导航栏组件使用说明,兼容小程序和H5及各端
- ant 修改组件默认样式属性
- 商品列表选择尺寸和颜色高亮,并且把选择的数据传递到下一个页面