[源码分析]iOS WebViewJavascriptBridge使用及原理

在开发中涉及到网页与iOS原生交互,于是就想到了WebViewJavascriptBridge 这个开源库。经过最近几天的研究和了解算是熟悉了它的使用和大致的处理过程。以此记录作为自己学习总结习惯的开始,也便于不熟悉它的人能快速使用它。
内容包括三个部分。

  • WebViewJavascriptBridge基本使用
  • OC中调用JS方法分析
  • JS中调用OC方法分析

<p>

1、WebViewJavascriptBridge基本使用:

导入工程包含文件如下(图1):

F3C1C2C7-B738-41D2-B7CB-987604347B9D.png

其支持UIWebView 和 WKWebView,我用的是UIWebView,测试文件** test.html
** oc端的操作

首先添加头文件#import <WebViewJavascriptBridge.h>
    //初始化_webBridge对象
    _webBridge =[WebViewJavascriptBridge bridgeForWebView:_webview];
    [_webBridge setWebViewDelegate:self];

js和iOS方法相互调用之前需要先注册,如js要调用oc中的方法 * objc_fun1 *,在oc文件中操作如下

//注册方法供js处调用
[_webBridge registerHandler:@"objc_fun1" handler:^(id data, WVJBResponseCallback responseCallback) {
        NSLog(@"rec data from js :%@",data);
        responseCallback(@"i am from objc!");
    }];
//objc_fun1:注册方法的名称供js端调用
//handler:具体的方法操作,参数data — js调用时传递的参数 ,responseCallback—js 回调操作。
//调用js中的方法
[_webBridge callHandler:@"js_fun1" data:@{@"key":@"hello js"} responseCallback:^(id responseData) {
        NSLog(@"from js  :%@",responseData);
    }];

js端的操作
相关操作基本固定,在 test.html 中,方法 function setupWebViewJavascriptBridge(callback){}的定义不需要改动,我们只是在方法的调用时,在callback 中加入自己的操作。这里注册oc 需要调用的方法,或者调用oc已注册过的方法

setupWebViewJavascriptBridge(function(bridge) {
    //register functin
    bridge.registerHandler('js_fun1', function(data, responseCallback) {
        console.log("JS Echo called with:", data)
        responseCallback(data)
    })
    // add button
   var btn = document.getElementById('divid1').appendChild(document.createElement('button'))
       btn.innerHTML = "callOCFunction"
       btn.style="background-color:red;text-align:center" 

       btn.onclick = function(e){
        e.preventDefault()
        bridge.callHandler('objc_fun1', {'key':'hello oc,I from JS'}, function responseCallback(responseData) {
             var e =document.getElementById('result')
             e.innerHTML = "oc response: " + responseData;
    })
   }
})
//html部分
<body>
<p>this is webviewJavascriptBridge demo</p>
<div>
    <p id='result'></p>
</div>
<div style = "background-color:blue;text-align:center;" id = 'divid1' height:40px></div>
</body>

在此注册了方法中js_fun1可供oc处调用,添加了测试按钮callOCFunction,点击通过bridge.callHandler() 调用oc端的方法objc_fun1,返回的结果在页面上显示。运行程序后点击按钮达到了预期结果,到这里算是完成了基本实用。

2、OC中调用JS方法分析:

WebViewJavascriptBridge中js与oc的交互主要通过- (BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType
url拦截然后对url分析进行js代码注入,最终实现js与oc的方法相互调用。<p>

首次加载test.html时发起一次请求操作,url = 'wvjbscheme://__BRIDGE_LOADED__',拦截到该url,通过- >>(void)injectJavascriptFile 方法进行js注入, NSString *js = WebViewJavascriptBridge_js();此js代码在#import "WebViewJavascriptBridge_JS.h"中,对js中>WebViewJavascriptBridge对象方法和变量进行初始化 主要方法如下:

function registerHandler(handlerName, handler);//注册方法
function callHandler(handlerName, data, responseCallback);//调用方法
function _doSend(message, responseCallback);
function _fetchQueue();
function _dispatchMessageFromObjC(messageJSON);
function _handleMessageFromObjC(messageJSON);

<p>
OC中调用JS方法顺序
1.首先调用方法 - (void)callHandler:(NSString *)handlerName data:(id)data responseCallback:(WVJBResponseCallback)responseCallback
参数data,参数形式js端书写语法。
参数responseCallback,最后的回调操作。
2.- (void)sendData:(id)data responseCallback:(WVJBResponseCallback)responseCallback handlerName:(NSString*)handlerName
把发送的数据封装在一个字典中,如果有responseCallback同时生成一个回调id(objc_cb_1形式的字符串)。
3.- (void)_queueMessage:(WVJBMessage*)message
4.- (void)_dispatchMessage:(WVJBMessage*)message
把消息对象转化为json字符串,添加字符格式化的处理-> messageJSON,
获取js代码字符串
NSString* javascriptCommand = [NSString stringWithFormat:@"WebViewJavascriptBridge._handleMessageFromObjC('%@');", messageJSON];

执行js代码
[self _evaluateJavascript:javascriptCommand];js中依次调用
function _handleMessageFromObjC(messageJSON) function _dispatchMessageFromObjC(messageJSON)执行js中方法操作
方法结束后,如果此时的oc方法有回调操作->通过function _doSend(message, responseCallback)再次发起url请求。然后操作回到oc端。

<p>
oc中拦截url请求,分析请求类型为WVJB_QUEUE_MESSAGE调用方法5
5.- (void)flushMessageQueue:(NSString *)messageQueueString
根据js传入的参数获取 回调id 'responseId'取出oc方法的回调代码块执行,然后在self.responseCallbacks移除已执行的操作。

        NSString* responseId = message[@"responseId"];
        if (responseId) {
            WVJBResponseCallback responseCallback = _responseCallbacks[responseId];
            responseCallback(message[@"responseData"]);
            [self.responseCallbacks removeObjectForKey:responseId];
}

至此,oc调用js方法执行结束。

3、JS中调用OC方法分析:

依次调用方法顺序
JS中的方法操作
在文件#import "WebViewJavascriptBridge_JS.h"中定义的方法
1.function callHandler(handlerName, data, responseCallback);
2.function _doSend(message, responseCallback) 在这个方法中生成回调的id,并保存js端的回调操作,然后发起一次请求回到OC端操作。
oc中拦截url请求,分析请求类型为WVJB_QUEUE_MESSAGE调用方法3
3.- (void)flushMessageQueue:(NSString *)messageQueueString
主要操作代码如下:

{
            WVJBResponseCallback responseCallback = NULL;
            NSString* callbackId = message[@"callbackId"];
            if (callbackId) {
                responseCallback = ^(id responseData) {
                    if (responseData == nil) {
                        responseData = [NSNull null];
                    }
                    
                    WVJBMessage* msg = @{ @"responseId":callbackId, @"responseData":responseData };
                    [self _queueMessage:msg];
                };
            } else {
                responseCallback = ^(id ignoreResponseData) {
                    // Do nothing
                };
            }
            
            WVJBHandler handler = self.messageHandlers[message[@"handlerName"]];
            
            if (!handler) {
                NSLog(@"WVJBNoHandlerException, No handler for message from JS: %@", message);
                continue;
            }
            
            handler(message[@"data"], responseCallback);
        }

根据传递过来的方法名,参数,和回调调用oc方法handler(message[@"data"], responseCallback);如果有回调responseCallback,oc方法执行完后调用[self _queueMessage:msg];
然后操作同OC中调用JS方法顺序中步骤3、4又回到JS端执行

    function _dispatchMessageFromObjC(messageJSON) {
    setTimeout(function _timeoutDispatchMessageFromObjC() {
            var message = JSON.parse(messageJSON);
            var messageHandler;
            var responseCallback;
            if (message.responseId) {
                responseCallback = responseCallbacks[message.responseId];
                if (!responseCallback) {
                    return;
                }
                responseCallback(message.responseData);
                delete responseCallbacks[message.responseId];
            } 

根据message.responseId 找到原来保存的回调操作、执行完毕后,删除该id的操作,至此JS中调用OC方法的操作流程结束。

总结:通过WebViewJavascriptBridge来实现JS、OC的交互,主要通过在OC端进行请求拦截,根据url的类型判断不同的操作,然后在通过js注入和执行来完成方法的调用,所以每次的事件可能会在OC和JS间多次来回切换。
以上为使用WebViewJavascriptBridge的操作和分析,若理解有不对的地方谢谢指出。

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

推荐阅读更多精彩内容