iOS - OC 与 JS 交互六种方式总结

Posted

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了iOS - OC 与 JS 交互六种方式总结相关的知识,希望对你有一定的参考价值。

参考技术A 在 APP 中,免不了与 H5页面打交道,所以掌握 与 JS 交互就显的至关重要,本文总结了常见的与 JS 交互方式。

注意事项

在 OC 原生中

html 文件中

早期的JS与原生交互的开源库很多都是用得这种方式来实现的,例如:PhoneGap、 WebViewjavascriptBridge 。

效果图

使用WKNavigationDelegate中的代理方法,拦截自定义的 URL 来实现 JS 调用 OC 方法。

注意点

关于如何区分执行不同的OC 方法,也与UIWebView的处理方式一样,通过URL 的host 来区分执行不同的方法:

JS 调用OC 方法后,有的操作可能需要将结果返回给JS。这时候就是OC 调用JS 方法的场景。
WKWebView 提供了一个新的方法 evaluateJavaScript:completionHandler: ,实现OC 调用JS 等场景。

注意点

运行结果

ios 7之后,apple添加了一个新的库JavaScriptCore,用来做JS交互,因此JS与原生OC交互也变得简单了许多。

首先导入JavaScriptCore库, 然后在OC中获取JS的上下文。

再然后定义好JS需要调用的方法,例如JS要调用share方法:
则可以在UIWebView加载url完成后,在其代理方法中添加要调用的share方法:

OC 调用 JS 方法有多种,首先介绍使用JavaScriptCore框架的方式。

使用JSContext 的方法 -evaluateScript ,可以实现 OC 调用 JS 方法

效果图

使用WKWebView的时候,如果想要实现JS调用OC方法,除了拦截URL之外,还有一种简单的方式。那就是利用WKWebView的新特性MessageHandler来实现JS调用原生方法。

创建 WKWebViewConfiguration 对象,配置各个API对应的MessageHandler。

然后在界面即将显示的时候添加MessageHandler

需要注意的是addScriptMessageHandler很容易引起循环引用,导致控制器无法被释放,所以需要移除MessageHandler

这里实现了两个协议 <WKUIDelegate,WKScriptMessageHandler> , WKUIDelegate 是因为我在JS中弹出了alert 。 WKScriptMessageHandler 是因为我们要处理JS调用OC方法的请求。

WKScriptMessage 有两个关键属性 name 和 body 。
因为我们给每一个OC 方法取了一个name,那么我们就可以根据name 来区分执行不同的方法。body 中存着JS 要给OC 传的参数。

关于参数body 的解析,我就举一个body中放字典的例子,其他的稍后可以看demo。
解析JS 调用OC 实现分享的参数:

message.boby 就是JS 里传过来的参数。我们不同的方法先做一下容错性判断。然后正常取值就可以了。

下面只列举一个shareClick()方法,其他看Demo

这里使用WKWebView 实现OC 调用JS方法与之前说的文章一样,通过
- evaluateJavaScript:completionHandler:

效果图如下图所示

详情看下面文章链接
iOS下 JS 与 OC 互相调用(五) - UIWebView+WebViewJavascriptBridge

详情看下面文章链接
iOS下 JS 与 OC 互相调用(六) - WKWebView+WKWebViewJavascriptBridge

iOS下 JS 与OC 互相调用(一) - UIWebView 拦截 URL
iOS下 JS 与OC 互相调用(二) - JavaScriptCore
iOS 下 JS 与 OC 互相调用(三) - WKWebView 拦截 URL
iOS下JS与OC互相调用(四)-MessageHandler
iOS下 JS 与 OC 互相调用(五) - UIWebView+WebViewJavascriptBridge
iOS下 JS 与 OC 互相调用(六) - WKWebView+WKWebViewJavascriptBridge

OC与JS的交互(iOS与H5混编)

在开发过程中,经常会出现需要iOS移动端与H5混编的使用场景。 iOS中加载html网页, 可以使用UIWebView或WKWebView. 本篇博客将介绍两种控件使用过程中如何实现OC与JS的交互。
UIWebView delegate 协议方法

 //网页即将开始加载
 - (BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType;

 //网页开始加载
 - (void)webViewDidStartLoad:(UIWebView *)webView;

 //网页加载完成
 - (void)webViewDidFinishLoad:(UIWebView *)webView;

 //网页加载失败
 - (void)webView:(UIWebView *)webView didFailLoadWithError:(NSError *)error;


 //UIWebView自带了一个方法, 可以直接调用JS代码(转化为string类型的js代码)
 - (nullable NSString *)stringByEvaluatingJavaScriptFromString:(NSString *)script;

 //例如修改id为‘html’标签内部的text属性
 [web stringByEvaluatingJavaScriptFromString:@"document.getElementById(‘html‘).innerText=‘修改内容‘"];

 //也可以执行多行js代码
 [web stringByEvaluatingJavaScriptFromString:@"var div = document.getElementById(‘html‘); div.innerText = ‘修改内容‘"];

 

利用JavaScriptCore实现交互 
JavaScriptCore中类及协议:

 JSContext:给JavaScript提供运行的上下文环境
 JSValue:JavaScript和Objective-C数据和方法的桥梁
 JSManagedValue:管理数据和方法的类
 JSVirtualMachine:处理线程相关,使用较少
 JSExport:这是一个协议,如果采用协议的方法交互,自己定义的协议必须遵守此协议
 OC中提供了JavaScriptCore 这个库,使得OC与js的交互变得更加方便。
 使用方法:
 1  加入JavaScriptCore 这个framework
 2  引入头文件<JavaScriptCore/JavaScriptCore.h>
 3  在VC里面加入一个JSContext属性
    @property (strong, nonatomic) JSContext *context;
    JSContext是什么那? 我们看一下api里面的解释
 @interface
 @discussion A JSContext is a JavaScript execution environment. All
 JavaScript execution takes place within a context, and all JavaScript values
 are tied to a context.

大概意思是说:JSContext是一个JS的执行环境,所有的JS执行都发生在一个context里面, 所有的JS value都绑定到context里面

具体使用
 //初始化context
 self.context = [webView valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"];
 //OC调用JS
 //(1)例如html的script中一个方法
   function dolike(a,b,c){
   }
 //通过OC调用此方法
 NSString * method = @"dolike";
 JSValue * function = [self.context objectForKeyedSubscript:method];
 //这里面的a,b,c就是OC调用JS的时候给JS传的参数
 [function callWithArguments:@[a,b,c]];

 //JS调用OC
 //例如网页中有个标签,点击button的时候调用Jump方法, 此处3为传入的参数
 <button onclick="jump(‘3‘)">点我</button>
 //当点击网页中的button的时候,触发jump方法, 在OC中用如下代码可以捕捉到jump方法, 并拿到JS给我传的参数‘3’
 self.context[@"jump"] = ^(NSString * str){
 //此处 str 值为‘3‘(js调用OC时传给OC的参数)
 };

 

WKWebView : 
说到WKWebView, 首先要说下WKWebView的优势

1 更多的支持HTML5的特性 
2 官方宣称的高达60fps的滚动刷新率以及内置手势 
3 将UIWebViewDelegate与UIWebView拆分成了14类与3个协议,以前很多不方便实现 的功能得以实现 
4 Safari相同的JavaScript引擎 
5 占用更少的内存

类:

   WKBackForwardList: 之前访问过的 web 页面的列表,可以通过后退和前进动作来访问到。
    WKBackForwardListItem: webview 中后退列表里的某一个网页。
    WKFrameInfo: 包含一个网页的布局信息。
    WKNavigation: 包含一个网页的加载进度信息。
    WKNavigationAction: 包含可能让网页导航变化的信息,用于判断是否做出导航变化。
    WKNavigationResponse: 包含可能让网页导航变化的返回内容信息,用于判断是否做出导航变化。
    WKPreferences: 概括一个 webview 的偏好设置。
    WKProcessPool: 表示一个 web 内容加载池。
    WKUserContentController: 提供使用 JavaScript post 信息和注射 script 的方法。
    WKScriptMessage: 包含网页发出的信息。
    WKUserScript: 表示可以被网页接受的用户脚本。
    WKWebViewConfiguration: 初始化 webview 的设置。
    WKWindowFeatures: 指定加载新网页时的窗口属性。

 

协议:

      WKNavigationDelegate: 提供了追踪主窗口网页加载过程和判断主窗口和子窗口是否进行页面加载新页面的相关方法。
      WKScriptMessageHandler: 提供从网页中收消息的回调方法。
      WKUIDelegate: 提供用原生控件显示网页的方法回调。

 

 加载方式:
 //方式一
 WKWebView *webView = [[WKWebView alloc] initWithFrame:self.view.bounds];
 [webView loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:@"http://www.baidu.com"]]];
 [self.view addSubview:webView];

 //方式二
 WKWebViewConfiguration * configuration = [[WKWebViewConfiguration alloc] init];
 webView = [[WKWebView alloc] initWithFrame:self.view.bounds configuration:configuration];
 [webView loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:@"http://www.baidu.com"]]];
 [self.view addSubview:webView];


协议方法介绍:
 #pragma mark - WKNavigationDelegate
 // 页面开始加载时调用
 - (void)webView:(WKWebView *)webView didStartProvisionalNavigation:(WKNavigation *)navigation{

 }
 // 当内容开始返回时调用
 - (void)webView:(WKWebView *)webView didCommitNavigation:(WKNavigation *)navigation{

 }
 // 页面加载完成之后调用
 - (void)webView:(WKWebView *)webView didFinishNavigation:(WKNavigation *)navigation{

 }
 // 页面加载失败时调用
 - (void)webView:(WKWebView *)webView didFailProvisionalNavigation:(WKNavigation *)navigation{

 }
 // 接收到服务器跳转请求之后调用
 - (void)webView:(WKWebView *)webView didReceiveServerRedirectForProvisionalNavigation:(WKNavigation *)navigation{

 }
 // 在收到响应后,决定是否跳转
 - (void)webView:(WKWebView *)webView decidePolicyForNavigationResponse:(WKNavigationResponse *)navigationResponse decisionHandler:(void (^)(WKNavigationResponsePolicy))decisionHandler{

 NSLog(@"%@",navigationResponse.response.URL.absoluteString);
 //允许跳转
 decisionHandler(WKNavigationResponsePolicyAllow);
 //不允许跳转
 //decisionHandler(WKNavigationResponsePolicyCancel);
 }
 // 在发送请求之前,决定是否跳转
 - (void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler{

 NSLog(@"%@",navigationAction.request.URL.absoluteString);
 //允许跳转
 decisionHandler(WKNavigationActionPolicyAllow);
 //不允许跳转
 decisionHandler(WKNavigationActionPolicyCancel);
 }
 #pragma mark - WKUIDelegate
 // 创建一个新的WebView
 - (WKWebView *)webView:(WKWebView *)webView createWebViewWithConfiguration:(WKWebViewConfiguration *)configuration forNavigationAction:(WKNavigationAction *)navigationAction windowFeatures:(WKWindowFeatures *)windowFeatures{
 return [[WKWebView alloc]init];
 }
 // 输入框
 - (void)webView:(WKWebView *)webView runJavaScriptTextInputPanelWithPrompt:(NSString *)prompt defaultText:(nullable NSString *)defaultText initiatedByFrame:(WKFrameInfo *)frame completionHandler:(void (^)(NSString * __nullable result))completionHandler{
 completionHandler(@"http");
 }
 // 确认框
 - (void)webView:(WKWebView *)webView runJavaScriptConfirmPanelWithMessage:(NSString *)message initiatedByFrame:(WKFrameInfo *)frame completionHandler:(void (^)(BOOL result))completionHandler{
 completionHandler(YES);
 }
 // 警告框
 - (void)webView:(WKWebView *)webView runJavaScriptAlertPanelWithMessage:(NSString *)message initiatedByFrame:(WKFrameInfo *)frame completionHandler:(void (^)(void))completionHandler{
 NSLog(@"%@",message);
 completionHandler();
 }

 

 

OC与JS的交互

WKWebView

WKWebView的 UIDelegate 提供了三个协议方法, 可以让前端很方便的拦截JS的alert, confirm, prompt方法。除此之外,OC,JS互调可以按照如下方法。

1 OC 调用JS

 可以使用webkit这个库
 - (void)evaluateJavaScript:(NSString *)javaScriptString completionHandler:(void (^ _Nullable)(_Nullable id, NSError * _Nullable error))completionHandler;

//例如OC调用JS的方法 setName

   [webView evaluateJavaScript:@"setname(‘张三‘)" completionHandler:nil];

//此处 setname为JS定义的方法名, 内部 ‘张三’为传给JS的参数。 如果setname方法需要传入一个json或者array等非字符参数, 需要用format方法将其转为string类型,在调用evaluate方法。例如

   NSString * para = [NSString stringWithFormat:@"setname(‘%@‘)",json];

 

JS调用OC

此时就要用到WKScriptMessageHandler了

 //首先.m中加入属性
 @property (nonatomic ,strong)WKUserContentController * userCC;


//1 遵循WKScriptMessageHandler协议
//2 初始化
   WKWebViewConfiguration * config = [[WKWebViewConfiguration alloc]init];

 self.wkWebViw = [[WKWebView alloc]initWithFrame:self.view.bounds configuration:config];

 [self.wkWebViw loadRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:self.webPageUrl]]];

 [self.view addSubview:self.wkWebViw];

 self.userCC = config.userContentController;

 [self.userCC addScriptMessageHandler:self name:@"callOSX"];

 //此处相当于监听了JS中callFunction这个方法

 [self.userCC addScriptMessageHandler:self name:@"callFunction"];

 //当JS发出callFunction这个方法指令的时候, WKScriptMessageHandler的协议方法中我们就会收到这个消息

 #pragma mark  WKScriptMessageHandler delegate
 - (void)userContentController:(WKUserContentController *)userContentController didReceiveScriptMessage:(WKScriptMessage *)message
 {
//这个回调里面, message.name代表方法名(‘本例为 callFunction’), message.body代表JS给我们传过来的参数

 }

//最后, VC销毁的时候一定要把handler移除
-(void)dealloc
{
    [_userContentController removeScriptMessageHandlerForName:@"callFunction"];
}


//对应的JS代码

<button onclick="buttonClick(‘温馨提示‘)">点我</button>

<script>
       function buttonClick(string){
       //JS调用OC, 格式如下
       //(window.webkit.messageHandlers.Method_Name.postMessage(parameterToOC))
              window.webkit.messageHandlers.callFunction.postMessage(string)
        }       
</script>  






以上是关于iOS - OC 与 JS 交互六种方式总结的主要内容,如果未能解决你的问题,请参考以下文章

JS与原生OC/Swift相互调用总结

WebView与JS的几种交互

js与oc原生WKWebView交互传值

js与oc原生WKWebView交互传值

iOS下JS与OC互相调用--UIWebView 拦截URL

OC与JS的交互(iOS与H5混编)