iOS开发-JS与原生OC互相调用之问题总结二

今天继续给同学们讲解JS和OC的互相调用，今天给大家还是讲解WKWebView中的一些使用，和注意点，废话不多说直接上代码~

WKWebView中的MessageHandler?

  • WKWebView初始化时，有一个参数叫configuration，它是WKWebViewConfiguration类型的参数，而WKWebViewConfiguration有一个属性叫userContentController，它又是WKUserContentController类型的参数。WKUserContentController对象有一个方法
    - addScriptMessageHandler:name:我把这个功能简称为MessageHandler。
    - addScriptMessageHandler:name:有两个参数，第一个参数是userContentController的代理对象，第二个参数是JS里发送postMessage的对象(即你与前端JS定义好的方法名)。
  • 所以要使用MessageHandler功能，就必须要实现WKScriptMessageHandler协议。(注意)

<WebKit/WebKit.h>API中对JS的使用方法介绍?

  • 我们在该API的描述里可以看到在JS中的使用方法：
    window.webkit.messageHandlers.<name>.postMessage(<messageBody>)
  • // 其中<name>，就是上面方法里的第二个参数'name';例:我们调用API的时候第二个参数填@"Share"，那么在JS里就是: window.webkit.messageHandlers.Share.postMessage(<messageBody>)
  • // <messageBody>是一个键值对，键是body，值可以有多种类型的参数。
  • // 在'WKScriptMessageHandler'协议中，我们可以看到message是'WKScriptMessage'类型，有一个属性叫body
  • // 而注释里写明了body 的类型：Allowed types are NSNumber, NSString, NSDate, NSArray, NSDictionary, and NSNull.

那么问题来了，如何使用MessageHandler呢?

  • 创建WKWebViewConfiguration对象，配置各个API对应的MessageHandler，WKUserContentController对象可以添加多个scriptMessageHandler。示例代码：
/**

 *  创建一个WKWebViewConfiguration对象

 */

- (void)creatConfiguration {
    WKWebViewConfiguration *configuration = [[WKWebViewConfiguration  alloc] init];
    WKPreferences *preference = [[WKPreferences alloc] init]; // 对一个webView的属性设置
    preference.javaScriptCanOpenWindowsAutomatically = YES;
    configuration.preferences = preference;
}

#pragma mark - 一般在这里就设置整个view是webView
- (void)loadView {
    [super loadView];
    self.view = self.webView;
}

#pragma mark - view即将出现的时候我们就可以监听
- (void)viewWillAppear:(BOOL)animated {
    [super viewWillAppear:animated];
 // addScriptMessageHandler 很容易导致循环引用
 // 控制器 强引用了WKWebView,WKWebView copy(强引用了）configuration,configuration copy（强引用了）userContentController
 // userContentController 强引用了 self（控制器）
    [self.webView.configuration.userContentController  addScriptMessageHandler:self  name:@"ScanAction"];
    [self.webView.configuration.userContentController  addScriptMessageHandler:self  name:@"Location"];
    [self.webView.configuration.userContentController  addScriptMessageHandler:self  name:@"Share"];
    [self.webView.configuration.userContentController  addScriptMessageHandler:self  name:@"Color"];
    [self.webView.configuration.userContentController  addScriptMessageHandler:self  name:@"Pay"];
    [self.webView.configuration.userContentController  addScriptMessageHandler:self  name:@"Shake"];
    [self.webView.configuration.userContentController  addScriptMessageHandler:self  name:@"GoBack"];
    [self.webView.configuration.userContentController  addScriptMessageHandler:self  name:@"PlaySound"];
}

需要注意的是addScriptMessageHandler很容易引起循环引用，导致控制器无法被释放，所以需要加入以下这段

- (void)viewWillDisappear:(BOOL)animated {
    [super viewWillDisappear:animated];
 // 因此这里要记得移除handlers
    [self.webView.configuration.userContentController  removeScriptMessageHandlerForName:@"ScanAction"];
    [self.webView.configuration.userContentController  removeScriptMessageHandlerForName:@"Location"];
    [self.webView.configuration.userContentController  removeScriptMessageHandlerForName:@"Share"];
    [self.webView.configuration.userContentController  removeScriptMessageHandlerForName:@"Color"];
    [self.webView.configuration.userContentController  removeScriptMessageHandlerForName:@"Pay"];
    [self.webView.configuration.userContentController  removeScriptMessageHandlerForName:@"Shake"];
    [self.webView.configuration.userContentController  removeScriptMessageHandlerForName:@"GoBack"];
    [self.webView.configuration.userContentController  removeScriptMessageHandlerForName:@"PlaySound"];
}

#pragma mark - 创建WKWebView?
- (void)viewDidLoad {
    [super  viewDidLoad];

    // 0.创建WKWebView
    [self  setUpWebView];

    // 1.创建WKWebViewConfiguration对象
    [self  setUpConfiguration];
}

/**
 *  创建webView
 */
- (void)setUpWebView {
   self.webView = [[WKWebView  alloc] initWithFrame:self.view.frame  configuration:nil];
   NSString *urlStr = [[NSBundle  mainBundle] pathForResource:@"test.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];
}

/**
 *  创建一个WKWebViewConfiguration对象
 */
- (void)setUpConfiguration {
   WKWebViewConfiguration *configuration = [[WKWebViewConfiguration  alloc] init];
   WKPreferences *preference = [[WKPreferences alloc] init]; // 对一个webView的属性设置
   preference.javaScriptCanOpenWindowsAutomatically = YES;
   configuration.preferences = preference;
}

#pragma mark - 实现协议方法
#pragma mark - 我这里实现了两个协议<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 test];
    } else if ([message.name isEqualToString:@"Share"]) {
        [self test];
    } else if ([message.name isEqualToString:@"Color"]) {
        [self test];
    } else if ([message.name isEqualToString:@"Pay"]) {
        [self test];
    } else if ([message.name isEqualToString:@"Shake"]) {
        [self test];
    } else if ([message.name isEqualToString:@"GoBack"]) {
        [self test];
    } else if ([message.name isEqualToString:@"PlaySound"]) {
        [self test];
    }
}

- (void)test {

}

#pragma mark - WKScriptMessage有两个关键属性name和body。因为我们给每一个OC方法取了一个name，那么我们就可以根据name 来区分执行不同的方法。body中存着JS要给OC传的参数。关于参数body的解析，我就举一个body中放字典的例子.
/**
 *  @param tempDic tempDic来自message.body来自与JS传过来的参数
 */
- (void)shareWithParams:(NSDictionary *)tempDic {

    if (![tempDic isKindOfClass:[NSDictionary class]]) return;

    // kvc取值
    NSString *title = [tempDic objectForKey:@"title"];
    NSString *content = [tempDic objectForKey:@"content"];
    NSString *url = [tempDic objectForKey:@"url"];

    // 在这里执行分享的操作
#pragma mark - OC调用JS

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

#pragma mark - 那么这里总结用MessageHandler的好处
/* 
 * 1> 在JS中写起来简单，不用再用创建URL的方式那么麻烦了。
 * 2> JS传递参数更方便。使用拦截URL的方式传递参数，只能把参数拼接在后面，如果遇到要传递的参数中有特殊字符，如&、=、？等，必须得转换，否则参数解析肯定会出错。
 * 例如传递的url是这样的:
 * [http://www.baidu.com/share/openShare.htm?share_uuid=shdfxdfdsfsdf&name=1234567890](http://www.baidu.com/share/openShare.htm?share_uuid=shdfxdfdsfsdf&name=1234567890)
 * 使用拦截URL 的JS调用方式
 * loadURL("firstClick://shareClick?title=分享的标题&content=分享的内容&url=链接地址&imagePath=图片地址"); }
 * 将上面的url 放入链接地址这里后，根本无法区分share_uuid是其他参数，还是url里附带的参数。
 * 但是使用MessageHandler 就可以避免特殊字符引起的问题。
 */
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成，浏览时请结合常识与多方信息审慎甄别。
平台声明：文章内容（如有图片或视频亦包括在内）由作者上传并发布，文章内容仅代表作者本人观点，简书系信息发布平台，仅提供信息存储服务。

推荐阅读更多精彩内容

友情链接更多精彩内容