wkwebview与js通信学习总结(二) 之MessageHandler_binglan520的博客-程序员宝宝

使用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.
  
   
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8

怎么使用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;
  
   
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16

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];
  
   
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9

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];
    }
}
  
   
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22

WKScriptMessage有两个关键属性namebody
因为我们给每一个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"];
    // 在这里执行分享的操作

    // 将分享结果返回给js
    NSString *jsStr = [NSString stringWithFormat:@"shareResult('%@','%@','%@')",title,content,url];
    [self.webView evaluateJavaScript:jsStr completionHandler:^(id _Nullable result, NSError * _Nullable error) {
        NSLog(@"%@----%@",result, error);
    }];
}
  
   
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17

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]);
}

  
   
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17

5.OC调用JS

这里使用WKWebView 实现OC 调用JS方法跟上一篇是一样的,还是利用
- evaluateJavaScript:completionHandler:。像下面这样使用:

// 将分享结果返回给js
    NSString *jsStr = [NSString stringWithFormat:@"shareResult('%@','%@','%@')",title,content,url];
    [self.webView evaluateJavaScript:jsStr completionHandler:^(id _Nullable result, NSError * _Nullable error) {
        NSLog(@"%@----%@",result, error);
    }];
  
   
  • 1
  • 2
  • 3
  • 4
  • 5
  • 1
  • 2
  • 3
  • 4
  • 5

使用MessageHandler 的好处

  • 1.在JS中写起来简单,不用再用创建URL的方式那么麻烦了。
  • 2.JS传递参数更方便。使用拦截URL的方式传递参数,只能把参数拼接在后面,如果遇到要传递的参数中有特殊字符,如&、=、?等,必须得转换,否则参数解析肯定会出错。
    例如传递的url是这样的:
    http://www.baidu.com/share/openShare.htm?share_uuid=shdfxdfdsfsdf&name=1234556
    使用拦截URL 的JS调用方式
loadURL("haleyAction://shareClick?title=分享的标题&content=分享的内容&url=链接地址&imagePath=图片地址"); }
  
   
  • 1
  • 1

将上面的url 放入链接地址这里后,根本无法区分share_uuid是其他参数,还是url里附带的参数。
但是使用MessageHandler 就可以避免特殊字符引起的问题。

效果图

更详细的使用步骤还是去工程中查看吧。地址:JS_OC_MessageHandler

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/binglan520/article/details/59056607

智能推荐

004 Optional_天为我蓝的博客-程序员宝宝

一 . 概述  在我们之前的应用之中,我们常常需要面临的一个问题就是面对各种出现null的情况.  比如我们的方法的参数是否为null,我们的方法的返回值是否是null.  我们常见的一种情景就是忘记掉这些特殊的情况,这会导致我们的应用在特殊的情况下挂掉.  JDK吸取了guava之中的傻瓜式防护的策略,让程序员必须对null进行处理,这样的好处就是程序员在代码的上下文之中常常被提...

php位值,解决 PHP 中 usort 在值相同时改变原始位置的问题_会打嗝的布谷鸟的博客-程序员宝宝

从 PHP 4.1.0 后,usort 在比较的值相同时,原始位置可能会改变,文档中是这样说的:If two members compare as equal, their order in the sorted array is undefined.也就是说,如果比较的2个值相同,则它们在排序结果中的顺序是随机的。如果你需要保持相同值的原始位置,可以参考本文的方法。演示数据:/*解决 PHP 中...

axis2+MyEclipse8.5实现webservice接口例子(没有使用插件)_爱幻想的小布丁的博客-程序员宝宝

一.webservice服务端demo1.下载axis2-1.5.4-war.zip,解压后将axis2.war放入tomcat,启动,访问http://127.0.0.1:8080/axis2,进入欢迎页面,表明axis2可用.2.新建一个webproject,取名为MyAxisDemo3.新建一个类:package com.sidney.bj;public cl

LOJ 2541 「PKUWC2018」猎人杀——思路+概率+容斥+分治_weixin_30740581的博客-程序员宝宝

题目:https://loj.ac/problem/2541看了题解才会……有三点很巧妙。1.分母如果变动,就很不好。所以考虑把操作改成 “已经选过的人仍然按 \( w_i \) 的概率被选,但是再次选中一个已经选过的人算作没有操作” 。2.然后要容斥,考虑强制点集 S 的人在 1 号点之后被选、其余随意,那么  \( ans=\sum\limits_{S} (-1)^{|S|} ...

hwclock: settimeofday() failed: Invalid argument_settimeofday不成功_jiangchao3392的博客-程序员宝宝

hwclock: settimeofday() failed: Invalid argument移植linux2.6.35到s3c2416遇到drivers/rtc/hctosys.c: unable to open rtc device (rtc0) 错误提示。2010年07月09日 星期五 14:26移植linux2.6.35到s3c2416遇到drivers/rtc/h...

android inflate assets,android – 从assets文件夹中读取sqlite错误_今天也要开心呢的博客-程序员宝宝

我的Databasehelper.classpublic class DatabaseHelper extends SQLiteOpenHelper {public static final String DBNAME = "db3000.sqlite";public static final String DBLOCATION = "/data/data/com.gnirt69.sqlitefr...

随便推点

Windows10 子系统 debian 设置 root 密码_debian .config_kokostro的博客-程序员宝宝

步骤:切换默认登录用户为 root管理员身份运行 PowerShelll 或 cmd,执行后,退出debian config --default-user root以root账号登录,并设置密码管理员身份运行 PowerShelll 或 cmd,执行后,退出debianpasswd root# 设置密码切换默认登录用户管理员身份运行 PowerShelll 或 cmd,执行后,退出debian config --default-user 用户名...

python奇数和_请问python如何判断奇偶数?_weixin_39524425的博客-程序员宝宝

odd 代表奇数, even 代表偶数, 下面代码全部使用is_odd, 判断输入的值是不是奇数, 是奇数返回True, 否则返回False最常用的办法就是直接取模判断:def is_odd(n):# 余数是 1 就是奇数, 否则是偶数return n % 2 == 1当然也可以用位运算, 这里需要知道的是, 一个十进制表示的数字如果是奇数的话, 在二进制下最后一位一定是 1, 否则最后一位是 0...

ZooKeeper启动报错myid file is missing IOException: ZooKeeperServer not running_坚持是一种态度的博客-程序员宝宝

zookeeper数据刷新不了,一气之下把data删了 然后启动失败`IllegalArgumentException: myid file is missing` 处理后,又报错`IOException: ZooKeeperServer not running`

什么是过滤器?_过滤器定义_陪你去流浪lv的博客-程序员宝宝

什么是过滤器?1.概念:过滤器是一个程序,它先于与之相关的servlet或JSP页面运行在服务器上。过滤器可附加到一个或多个servlet或JSP页面上,并且可以检查进入这些资源的请求信息。在这之后,过滤器可以作如下的选择:①以常规的方式调用资源(即,调用servlet或JSP页面)。②利用修改过的请求信息调用资源。③调用资源,但在发送响应到客户机前对其进行修改。④阻止该资源调用,代之...

python nlp开源工具包摸索(3)gensim_scarlette47的博客-程序员宝宝

1、tfidf 2、Summarization特点是主题模型,lda什么的宝宝也不懂啊,第一反应就是又来降维也是醉了~~心疼地抱住我寄几~~

Vsim选项整理、questasim自动化仿真控制文件书写_茶花煮酒的博客-程序员宝宝

vsim指令 载入一个设计到仿真器。1、vsim语句格式:Vsim [option] +TESTNAME=[test] [work.实体名] 2、常用选项:# 常用-c # 使vsim运行在命令行模式,不启动图形界面,节省时间-novopt # 不采用vopt优化,常和+acc配合使用-l &lt;logfile&gt; # 设置输出仿真的log文件-do "cmd" # 开始仿真后运行tcl脚本文件,如运行cmd# 其它-L # 开始仿真后运行tcl脚本文件,...