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..postMessage()//其中,就是上面方法里的第二个参数`name`。//例如我们调用API的时候第二个参数填@"Share",那么在JS里就是://window.webkit.messageHandlers.Share.postMessage()//是一个键值对,键是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是因为我在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"];

    // 在这里执行分享的操作    // 将分享结果返回给js    NSString *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的调用部分改变了。

// 传nullfunctionscanClick(){ window.webkit.messageHandlers.ScanAction.postMessage(null);

}// 传字典              functionshareClick(){    window.webkit.messageHandlers.Share.postMessage({title:'测试分享的标题',content:'测试分享的内容',url:'http://www.baidu.com'});

}// 传字符串functionplaySound(){

    window.webkit.messageHandlers.PlaySound.postMessage('shake_sound_male.wav');

}// 传数组functioncolorClick(){    window.webkit.messageHandlers.Color.postMessage([67,205,128,0.5]);

}

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

    }];

使用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=图片地址"); }

将上面的url 放入链接地址这里后,根本无法区分share_uuid是其他参数,还是url里附带的参数。 

但是使用MessageHandler 就可以避免特殊字符引起的问题。

效果图

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

版权声明:本文为博主原创文章,转载请注明出处。 https://blog.csdn.net/u011619283/article/details/52135988

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,761评论 5 460
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,953评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,998评论 0 320
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,248评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,130评论 4 356
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,145评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,550评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,236评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,510评论 1 291
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,601评论 2 310
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,376评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,247评论 3 313
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,613评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,911评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,191评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,532评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,739评论 2 335

推荐阅读更多精彩内容