ios WebViewJavascriptBridge源碼解析

githup地址:https://github.com/marcuswestin/WebViewJavascriptBridge
一 用法簡析

image.png

這個庫的還是比較精簡單的,當前webView 是用UIWebView 那么我只需要引入WebViewJavascriptBridge ,相應的WKWebView則需要用到WKWebViewJavascriptBridge
這個橋接主要是介于js 和 app 間我們先來看js 要怎么做
我們需要copy 這段代碼到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 = 'https://__bridge_loaded__';
    document.documentElement.appendChild(WVJBIframe);
    setTimeout(function() { document.documentElement.removeChild(WVJBIframe) }, 0)
}
export default class IOSBridge {
// key : xxx  參數 : json   回調: responseCallback
      changeState (json) {
          setupWebViewJavascriptBridge(function (bridge) {
                 bridge.callHandler('xxx', json, function                responseCallback (responseData) {
      })
    })
  }
}

app 端只需要

_bridge = [WebViewJavascriptBridge bridgeForWebView:webView];
[_bridge setWebViewDelegate:self];
[self.bridge registerHandler:@"xxx" handler:^(id data, WVJBResponseCallback responseCallback) {
    responseCallback(@"xxx");
}];

簡潔的代碼就已經完成js與app的橋接,那么我們來看看他整個流程是怎么執行,
首先js 調用的代碼出現一個了創建了一個iframe 并且設置src = 'https://bridge_loaded'
我們很清楚的知道如果WKWebView 可以捕獲到url 的變化的 也就是說設置src后WKWebView 是有回調的,那么我把斷點斷到WKWebView的代理看看這里發生了什么(PS:為什么這里iframe 要appendChild到document, 然后又快速的remove 呢 ,我想到一個解釋 ,是因為iframe 設置src 就無用了,iframe 只能通過 removeChild 才能移除掉,然后要想remove 就必須得先append )

原理簡釋:
當js 第一次app 橋接 我們在代理截獲到 這段

image.png

我們截獲到 這段url https://bridge_loaded
這里有個loaded 我可以猜測類似ViewDidLoad 頁面加載完成,那么我們進代理看看做了什么

if ([_base isWebViewJavascriptBridgeURL:url]) {
        if ([_base isBridgeLoadedURL:url]) {
            [_base injectJavascriptFile];
        } else if ([_base isQueueMessageURL:url]) {
            [self WKFlushMessageQueue];
        } else {
            [_base logUnkownMessage:url];
        }
        decisionHandler(WKNavigationActionPolicyCancel);
        return;
    }

直接點進去我們看到[_base isWebViewJavascriptBridgeURL:url] 這個方法去區分是否是從這個庫的iframe 設置的src的url 他們是根據

#define kOldProtocolScheme @"wvjbscheme"
#define kNewProtocolScheme @"https"
#define kQueueHasMessage   @"__wvjb_queue_message__"
#define kBridgeLoaded      @"__bridge_loaded__"

判斷url 是否包含以上字符串,那么接著看看當url 是https://bridge_loaded 這個的時候做了什么,也就是執行了這個 [_base injectJavascriptFile] 注入一段js,自然這段js 必然起到重要的作用,
我們先簡單看一下這段js 也就是這個兩個文件

image.png

這段js簡單來看是插入一個(function(){xxx})()的匿名函數
創建了一個WebViewJavascriptBridge 全局變量

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

簡單過完這段js 然后我繼續調試,發現出現了一個url 為https://wvjb_queue_message/ 的變化

image.png

那可以猜想是不是告訴app端 js 正在調用你的方法呢,但是很奇怪的是,斷點在app方法回調的部分卻沒有執行,這是為啥,那我們在看看 那段注入的js 做了什么

[self.bridge registerHandler:@"xxx" handler:^(id data, WVJBResponseCallback responseCallback) {
    responseCallback(@"xxx");
}];

我們看到注入的js里面有一個iframe 同樣也設置了src 代碼如下

messagingIframe = document.createElement('iframe');
    messagingIframe.style.display = 'none';
    messagingIframe.src = CUSTOM_PROTOCOL_SCHEME + '://' + QUEUE_HAS_MESSAGE;
    document.documentElement.appendChild(messagingIframe);

那為什么他設置src,這樣調試有啥用,是不是為了初始化什么呢,那接著調試看看,他調用了WKFlushMessageQueue這個方法,調用js WebViewJavascriptBridge._fetchQueue()的方法,那我們在來看看注入js 有沒有_fetchQueue這個方法,

    function _fetchQueue() {
        var messageQueueString = JSON.stringify(sendMessageQueue);
        sendMessageQueue = [];
        return messageQueueString;
    }

他是返回了messageQueueString ,并且清空sendMessageQueue 這個數組,可以猜測他估計這一次只是為了重新初始化sendMessageQueue 這個數組,那么這么說下一次就應該是響應js 調用 app的方法了,那么耐著性子繼續來下一步,果然WKFlushMessageQueue 注入js 的回調了handelName 和參數


image.png

接著在[_base flushMessageQueue:result]; 這個方法將result字符串轉換成字典 并且在messageHandlers這個全局變量獲取到對應handlerName 的 hanlder 回調給app 注冊的回調中
ps: app 端注冊hanler 就會把這個hanler 添加messageHandlers這個可變字典中

- (void)registerHandler:(NSString *)handlerName handler:(WVJBHandler)handler {
    _base.messageHandlers[handlerName] = [handler copy];
}

說到這里大概知道他是根據代理判斷url 變化來截獲到js 調用app 這個事件,那到這里還有一個很大疑問就是他的url https://wvjb_queue_message/ 他是怎么把參數傳過來的了,貌似我們一直在看注入的js ,忽略了剛開始復制那段js 代碼,我們在過頭來看看

      changeState (json) {
          setupWebViewJavascriptBridge(function (bridge) {
                 bridge.callHandler('xxx', json, function                     responseCallback (responseData) {
      })
    })
  }

這里調用注入的js 的callHandler 方法了要繞回去,下面我會畫一個流程圖梳理一下整個流程,那我們來看看callHandler方法又做了什么,

    function callHandler(handlerName, data, responseCallback) {
        if (arguments.length == 2 && typeof data == 'function') {
            responseCallback = data;
            data = null;
        }
        _doSend({ handlerName:handlerName, data:data }, responseCallback);
    }   
    function _doSend(message, responseCallback) {
        if (responseCallback) {
            var callbackId = 'cb_'+(uniqueId++)+'_'+new Date().getTime();
            responseCallbacks[callbackId] = responseCallback;
            message['callbackId'] = callbackId;
        }
        sendMessageQueue.push(message);
        messagingIframe.src = CUSTOM_PROTOCOL_SCHEME + '://' + QUEUE_HAS_MESSAGE;
    }

原來在這個時候callHandler 方法message 這個字典塞入sendMessageQueue數組里面,并且設置src 為https://wvjb_queue_message/ 通知app 端將發送消息,當代理攔截到這段url 便調用WKFlushMessageQueue 方法調用WebViewJavascriptBridge._fetchQueue() 這個方法去sendMessageQueue這個數組獲取消息內容字典,大致流程已經解析完,最后在來看看流程圖,梳理下流程吧

image.png

最后總結下原來這個庫原來很簡單只是通過iframe 設置src變化去觸發app 的webView 的代理回調,但是使用這個庫卻察覺不到這個痕跡,使用十分簡單,代碼邏輯也十分整潔,還是十分推薦的。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,572評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,071評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,409評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,569評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,360評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,895評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,979評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,123評論 0 286
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,643評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,559評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,742評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,250評論 5 356
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,981評論 3 346
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,363評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,622評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,354評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,707評論 2 370