zoukankan      html  css  js  c++  java
  • iOS下JS与OC互相调用(五)--UIWebView + WebViewJavascriptBridge

    WebViewJavascriptBridge是一个有点年代的JS与OC交互的库,使用该库的著名应用还挺多的,其实用的时候也不难.

    本文介绍的是在UIWebView中使用WebViewJavascriptBridge来达到JS与OC互相调用的目的。WKWebView使用的是WKWebViewJavascriptBridge

    创建UIWebView 
    创建UIWebView的代码:

    self.webView = [[UIWebView alloc] initWithFrame:self.view.frame];
        [self.view addSubview:self.webView];
    
        NSURL *htmlURL = [[NSBundle mainBundle] URLForResource:@"index.html" withExtension:nil];
        NSURLRequest *request = [NSURLRequest requestWithURL:htmlURL];
    
        // UIWebView 滚动的比较慢,这里设置为正常速度
        self.webView.scrollView.decelerationRate = UIScrollViewDecelerationRateNormal;
        [self.webView loadRequest:request];

    这里不要为UIWebView设置代理,因为在创建WebViewJavascriptBridge的时候,UIWebView的代理已经被赋值给了WebViewJavascriptBridge。

    创建WebViewJavascriptBridge 
    因为WebViewJavascriptBridge实例,在控制器中多个地方用到,因此最好定义一个property或者实例变量存起来

    _webViewBridge = [WebViewJavascriptBridge bridgeForWebView:self.webView];
    // {setWebViewDelegate}这个方法,可以将UIWebView的代理,从_webViewBridge中再传递出来。
    // 所以如果你要在控制器中实现UIWebView的代理方法时,添加下面这样代码,否则可以不写。
    [_webViewBridge setWebViewDelegate:self];

    然后跟踪进{- bridgeForWebView }方法,看它具体是怎么实现的

    + (instancetype)bridgeForWebView:(WVJB_WEBVIEW_TYPE*)webView {
        WebViewJavascriptBridge* bridge = [[self alloc] init];
        [bridge _platformSpecificSetup:webView];
        return bridge;
    }
    
    // 上面方法调用了这个方法
    - (void) _platformSpecificSetup:(WVJB_WEBVIEW_TYPE*)webView {
        _webView = webView;
        _webView.delegate = self;
        _base = [[WebViewJavascriptBridgeBase alloc] init];
        _base.delegate = self;
    }

    其实{-bridgeForWebView }内部也不过是初始化了一个WebViewJavascriptBridge对象,并为其实例变量_webView 和 _base赋值而已。

    注册js 要调用的Native 功能

    先上示例代码:

    #pragma mark - private method
    - (void)registerNativeFunctions
    {
        [self registScanFunction];
    
        [self registShareFunction];
    
        [self registLocationFunction];
    
        [self regitstBGColorFunction];
    
        [self registPayFunction];
    
        [self registShakeFunction];
    }
    
    - (void)registShareFunction
    {
        // 所有JS 需要调用的原生功能都要先用registerHandler注册一下
        [_webViewBridge registerHandler:@"shareClick" handler:^(id data, WVJBResponseCallback responseCallback) {
            // data 的类型与 JS中传的参数有关
            NSDictionary *tempDic = data;
            // 在这里执行分享的操作
            NSString *title = [tempDic objectForKey:@"title"];
            NSString *content = [tempDic objectForKey:@"content"];
            NSString *url = [tempDic objectForKey:@"url"];
    
            // 将分享的结果返回到JS中
            NSString *result = [NSString stringWithFormat:@"分享成功:%@,%@,%@",title,content,url];
            responseCallback(result);
        }];
    }
    - (void)registerHandler:(NSString *)handlerName handler:(WVJBHandler)handler 该方法有两个参数:第一个参数handlerName,是对这个功能起的一个别名;第二个参数handler,是个block,也就是Native 实现的功能。JS要调用的Native 实现其实就是block 的 {} 内的代码功能。
    为了便于维护,我们可以将JS要调用的Native方法都集中到一起,然后单个功能再封装一个方法。

    完成HMTL必要的JS代码

    HTML 中有一个必须要添加的JS 方法,然后需要自动调用一次该方法。该方法是:

    function setupWebViewJavascriptBridge(callback) {
        if (window.WebViewJavascriptBridge) { return callback(WebViewJavascriptBridge); }
        if (window.WVJBCallbacks) { return window.WVJBCallbacks.push(callback); }
        window.WVJBCallbacks = [callback];
        var WVJBIframe = document.createElement('iframe');
        WVJBIframe.style.display = 'none';
        WVJBIframe.src = 'wvjbscheme://__BRIDGE_LOADED__';
        document.documentElement.appendChild(WVJBIframe);
        setTimeout(function() { document.documentElement.removeChild(WVJBIframe) }, 0)
    }

    上面这个方法的参数是一个function,这个方法的作用主要是在第一次加载HTML的时候起作用,目的是加载一

    wvjbscheme://__BRIDGE_LOADED__,来触发往HTML中注入一些已经写好的JS方法。

     添加完setupWebViewJavascriptBridge方法,需要在JS中主动调用一次该方法:

    setupWebViewJavascriptBridge(function(bridge) {
         bridge.registerHandler('testJavascriptHandler', function(data, responseCallback) {
            alert('JS方法被调用:'+data);
            responseCallback('js执行过了');
         })
    })

    Native 需要调用的 JS 功能,也是需要先注册,然后再执行的。如果Native 需要调用的JS 功能有多个,那么这些功能都要在这里先注册,注册之后才能够被Native 调用。
    接下来需要好好分析一下JS 中这个方法的作用了。

    这里是重点:
    1、首先调用setupWebViewJavascriptBridge,第一次执行的时候,由于window.WebViewJavascriptBridge和window.WVJBCallbacks都不存在,所以会继续往下执行,将参数callback(它是一个function)装进数组赋值给window.WVJBCallbacks。
    js 支持动态添加属性 并赋值,这里window.WVJBCallbacks = [callback];就是动态添加属性,并赋值。 另外js中的全局变量都可以使用window.xxxx来调用;动态添加的属性也可以不加window.,直接使用。
    2、WebViewJavascriptBridge 帮助JS调用Native的url 有两种,一种是wvjbscheme://__BRIDGE_LOADED__;而另一种是wvjbscheme://__WVJB_QUEUE_MESSAGE__。前者只有在调用setupWebViewJavascriptBridge的时候执行一次,一般来说这个url 如果没有页面应该只会执行一次。第二种url所有js调用Native 功能时,都会使用到。
    3、在拦截到自定义的url 时,WebViewJavascriptBridge分了三种情况,如果是wvjbscheme://__BRIDGE_LOADED__,就往HMTL 中注入已经写好的js,这个js 在WebViewJavascriptBridge_JS中;如果是wvjbscheme://__WVJB_QUEUE_MESSAGE__,那就利用stringByEvaluatingJavaScriptFromString,取回调用js中callHandler传进去的参数。
    然后再从WebViewJavascriptBridge之前保存的Native 方法对应的block,调用对应的block。
    

    调用Native 功能

    利用之前注入的JS方法callHandler 就可以调用Native 功能了。
    示例代码如下:

    function shareClick() {
        var params = {'title':'测试分享的标题','content':'测试分享的内容','url':'http://www.baidu.com'};
        WebViewJavascriptBridge.callHandler('shareClick',params,function(response) {
             alert(response);
            document.getElementById("returnValue").value = response;
         });
    }

    这里callHandler前的WebViewJavascriptBridge,其实就是上一步注入到JS中的代码中,动态创建属性,动态赋值的属性。如下代码片段可以在WebViewJavascriptBridge_JS中找到。

    window.WebViewJavascriptBridge = {
      registerHandler: registerHandler,
      callHandler: callHandler,
      disableJavscriptAlertBoxSafetyTimeout: disableJavscriptAlertBoxSafetyTimeout,
      _fetchQueue: _fetchQueue,
      _handleMessageFromObjC: _handleMessageFromObjC
     };

    而callHandler 内部调用了另一个js function _doSend,而_doSend内部其实,就是把handlerName和 参数data,再加上callbackId 装成键值对,然后保存到数组sendMessageQueue,同时加载一次wvjbscheme://__WVJB_QUEUE_MESSAGE__
    到此 利用WebViewJavascriptBridge实现JS 调用iOS Native 就完成了。

    Native 调用 js 功能

    Native 调用js 的功能,也需要先在js 中为要调用的功能注册一个别名。
     js 注册Native 要调用的功能 
    示例代码:

    setupWebViewJavascriptBridge(function(bridge) {
         bridge.registerHandler('testJSFunction', function(data, responseCallback) {
            alert('JS方法被调用:'+data);
            responseCallback('js执行过了');
         })
        // 注册其他的功能
        //bridge.regsiterHandler.....
    })

    Native 调用功能的别名handlerName:

    //    // 如果不需要参数,不需要回调,使用这个
    //    [_webViewBridge callHandler:@"testJSFunction"];
    //    // 如果需要参数,不需要回调,使用这个
    //    [_webViewBridge callHandler:@"testJSFunction" data:@"一个字符串"];
        // 如果既需要参数,又需要回调,使用这个
        [_webViewBridge callHandler:@"testJSFunction" data:@"一个字符串" responseCallback:^(id responseData) {
            NSLog(@"调用完JS后的回调:%@",responseData);
        }];
    而callHandler 方法又是如何实现调用js 方法的呢?
    callHandler 内部是将传递给js 的参数、handlerName、callbackId组合成字典,然后把字典转换成字符串,将转换后的字符串以参数的形式,通过stringByEvaluatingJavaScriptFromString传递给js ,js 中将传递过来的字符串转成json ,然后通过handlerName 获取对应的function执行。
    利用WebViewJavascriptBridge来实现JS与OC的交互的优点:
    1、获取参数时,更方便一些,如果参数中有一些特殊符号或者url带参数,能够很好的解析。
    也有一些缺点:
    1、做一次交互,需要执行的js 与原生的交互步骤较多,至少有两次。
    2、需要花较多的时间,理解WebViewJavascriptBridge的原理和使用步骤。

    demo地址:https://github.com/domanc/JS_OC_WebViewJavascriptBridge_UIWebView.git
  • 相关阅读:
    有36辆自动赛车和6条跑道,没有计时器的前提下,最少用几次比赛可以筛选出最快的三辆赛车?----腾讯2016研发工程师在线模拟笔试题
    10G个整数,乱序排列,要求找出中位数。内存限制为 2G。只写出思路即可
    计算机网络总结(二)
    计算机网络总结(一)
    最小编辑距离
    寻找两个有序数组的中位数
    Linux下几款C++程序中的内存泄露检查工具
    DDIA
    推荐引擎
    Innodb中的事务隔离级别和锁的关系
  • 原文地址:https://www.cnblogs.com/dianming/p/7161338.html
Copyright © 2011-2022 走看看