WebViewJSBridge源碼解析

WebViewJSBridge源碼很簡(jiǎn)單,只有一個(gè)類跪腹,下面是這個(gè)類的類圖(去除了OSX平臺(tái)的代碼)。

WebViewJSBridge類.png

JS和Native的交互主要通過(guò)發(fā)送WVJBMessage消息來(lái)完成,它是一個(gè)字典栅迄,有五個(gè)字段:

  • data,交互數(shù)據(jù)
  • callbackId皆怕,是一個(gè)字符串毅舆,結(jié)構(gòu)為objc_cb_(_uniqueid),_uniqueId是一個(gè)全局自增的整型變量
  • handlerName西篓,回調(diào)名稱
  • responseId,js調(diào)用native時(shí)使用,對(duì)應(yīng)callbackId憋活,標(biāo)示是否是針對(duì)請(qǐng)求的回復(fù)
  • responseData,js調(diào)用native時(shí)使用

JS調(diào)用Native

JS調(diào)用Native的技巧是:定義了一個(gè)專用scheme和host岂津,在webView的- (BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType代理中判斷是否是這個(gè)scheme來(lái)判斷請(qǐng)求是否來(lái)自jsBridge,通過(guò)host判斷是否有新消息悦即,如果有吮成,則主動(dòng)調(diào)用協(xié)議定義的js方法來(lái)獲取消息。

- (BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType {
    if (webView != _webView) { return YES; }
    NSURL *url = [request URL];
    __strong WVJB_WEBVIEW_DELEGATE_TYPE* strongDelegate = _webViewDelegate;
    if ([[url scheme] isEqualToString:kCustomProtocolScheme]) {
        if ([[url host] isEqualToString:kQueueHasMessage]) {
            [self _flushMessageQueue];//確認(rèn)js想調(diào)用native
        } else {
            NSLog(@"WebViewJavascriptBridge: WARNING: Received unknown WebViewJavascriptBridge command %@://%@", kCustomProtocolScheme, [url path]);
        }
        return NO;//來(lái)自jsbridge的請(qǐng)求不會(huì)加載
    } else if (strongDelegate && [strongDelegate respondsToSelector:@selector(webView:shouldStartLoadWithRequest:navigationType:)]) {
        return [strongDelegate webView:webView shouldStartLoadWithRequest:request navigationType:navigationType];
    } else {
        return YES;
    }
}

_flushMessage主要分為下面幾個(gè)步驟:
1.主動(dòng)調(diào)用WebViewJavascriptBridge._fetchQueue()獲取消息隊(duì)列辜梳;
2.循環(huán)遍歷消息隊(duì)列
3.解析message粱甫,針對(duì)不同情況進(jìn)行不同的處理

- (void)_flushMessageQueue {
//調(diào)用jsBridge協(xié)議的方法來(lái)獲取js端想發(fā)送的信息
    NSString *messageQueueString = [_webView stringByEvaluatingJavaScriptFromString:@"WebViewJavascriptBridge._fetchQueue();"];
    
    id messages = [self _deserializeMessageJSON:messageQueueString];
    if (![messages isKindOfClass:[NSArray class]]) {
        NSLog(@"WebViewJavascriptBridge: WARNING: Invalid %@ received: %@", [messages class], messages);
        return;
    }
    for (WVJBMessage* message in messages) {
        if (![message isKindOfClass:[WVJBMessage class]]) {
            NSLog(@"WebViewJavascriptBridge: WARNING: Invalid %@ received: %@", [message class], message);
            continue;
        }
        [self _log:@"RCVD" json:message];
        //取出responseId
        NSString* responseId = message[@"responseId"];
        if (responseId) {
            /*
              *這個(gè)分支說(shuō)明這個(gè)消息是針對(duì)native調(diào)用js的響應(yīng)
             *取出這個(gè)responseId的回調(diào),并且執(zhí)行完畢后從字典中移除
            */
            WVJBResponseCallback responseCallback = _responseCallbacks[responseId];
            responseCallback(message[@"responseData"]);
            [_responseCallbacks removeObjectForKey:responseId];
        } else {
            //這個(gè)分支說(shuō)明是js主動(dòng)想調(diào)用native
            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];//執(zhí)行完畢后作瞄,發(fā)送消息給js茶宵,通知調(diào)用已經(jīng)完畢
                };
            } else {
                responseCallback = ^(id ignoreResponseData) {
                    // Do nothing
                };
            }//設(shè)置調(diào)用native后的處理回調(diào)
            
            WVJBHandler handler;
            if (message[@"handlerName"]) {
                handler = _messageHandlers[message[@"handlerName"]];
            } else {
                handler = _messageHandler;
            }

            if (!handler) {
                [NSException raise:@"WVJBNoHandlerException" format:@"No handler for message from JS: %@", message];
            }
            //執(zhí)行調(diào)用
            handler(message[@"data"], responseCallback);
        }
    }
}

Native調(diào)用JS

這個(gè)過(guò)程是比較簡(jiǎn)單的,直接調(diào)用stringByEvaluatingJavaScriptFromString即可宗挥。主要分為兩步步:

  • 調(diào)用提供的send接口
  • 構(gòu)建一個(gè)message乌庶,如果隊(duì)列存在塞入隊(duì)列,如果不存在直接dispatch
    下面是主要的源碼:
-(void)_sendData:(id)data responseCallback:(WVJBResponseCallback)responseCallback handlerName:(NSString*)handlerName {
    NSMutableDictionary* message = [NSMutableDictionary dictionary];
    
    if (data) {
        message[@"data"] = data;
    }
    
    if (responseCallback) {
         //將回調(diào)注冊(cè)到_responseCallbacks中
        NSString* callbackId = [NSString stringWithFormat:@"objc_cb_%ld", ++_uniqueId];
        _responseCallbacks[callbackId] = [responseCallback copy];
        message[@"callbackId"] = callbackId;
    }
    
    if (handlerName) {
        message[@"handlerName"] = handlerName;
    }
    [self _queueMessage:message];
}

- (void)_queueMessage:(WVJBMessage*)message {
//如果queue存在契耿,則加入到queue中安拟,否則直接調(diào)用dispatchMessage
    if (_startupMessageQueue) {
        [_startupMessageQueue addObject:message];
    } else {
        [self _dispatchMessage:message];
    }
}
//將Message字典序列化成JSON,主線程調(diào)用JS方法宵喂。
- (void)_dispatchMessage:(WVJBMessage*)message {
    NSString *messageJSON = [self _serializeMessage:message];
    [self _log:@"SEND" json:messageJSON];
    NSLog(@"%@ %@", message ,messageJSON);
    messageJSON = [messageJSON stringByReplacingOccurrencesOfString:@"\\" withString:@"\\\\"];
    messageJSON = [messageJSON stringByReplacingOccurrencesOfString:@"\"" withString:@"\\\""];
    messageJSON = [messageJSON stringByReplacingOccurrencesOfString:@"\'" withString:@"\\\'"];
    messageJSON = [messageJSON stringByReplacingOccurrencesOfString:@"\n" withString:@"\\n"];
    messageJSON = [messageJSON stringByReplacingOccurrencesOfString:@"\r" withString:@"\\r"];
    messageJSON = [messageJSON stringByReplacingOccurrencesOfString:@"\f" withString:@"\\f"];
    messageJSON = [messageJSON stringByReplacingOccurrencesOfString:@"\u2028" withString:@"\\u2028"];
    messageJSON = [messageJSON stringByReplacingOccurrencesOfString:@"\u2029" withString:@"\\u2029"];
    NSLog(@"%@ %@", message ,messageJSON);
    NSString* javascriptCommand = [NSString stringWithFormat:@"WebViewJavascriptBridge._handleMessageFromObjC('%@');", messageJSON];
    if ([[NSThread currentThread] isMainThread]) {
        [_webView stringByEvaluatingJavaScriptFromString:javascriptCommand];
    } else {
        __strong WVJB_WEBVIEW_TYPE* strongWebView = _webView;
        dispatch_sync(dispatch_get_main_queue(), ^{
            [strongWebView stringByEvaluatingJavaScriptFromString:javascriptCommand];
        });
    }
}
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末糠赦,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子锅棕,更是在濱河造成了極大的恐慌拙泽,老刑警劉巖,帶你破解...
    沈念sama閱讀 222,104評(píng)論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件裸燎,死亡現(xiàn)場(chǎng)離奇詭異顾瞻,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)德绿,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,816評(píng)論 3 399
  • 文/潘曉璐 我一進(jìn)店門荷荤,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人移稳,你說(shuō)我怎么就攤上這事蕴纳。” “怎么了个粱?”我有些...
    開(kāi)封第一講書人閱讀 168,697評(píng)論 0 360
  • 文/不壞的土叔 我叫張陵古毛,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我,道長(zhǎng)稻薇,這世上最難降的妖魔是什么嫂冻? 我笑而不...
    開(kāi)封第一講書人閱讀 59,836評(píng)論 1 298
  • 正文 為了忘掉前任,我火速辦了婚禮塞椎,結(jié)果婚禮上桨仿,老公的妹妹穿的比我還像新娘。我一直安慰自己案狠,他們只是感情好蹬敲,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,851評(píng)論 6 397
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著莺戒,像睡著了一般。 火紅的嫁衣襯著肌膚如雪急波。 梳的紋絲不亂的頭發(fā)上从铲,一...
    開(kāi)封第一講書人閱讀 52,441評(píng)論 1 310
  • 那天,我揣著相機(jī)與錄音澄暮,去河邊找鬼名段。 笑死,一個(gè)胖子當(dāng)著我的面吹牛泣懊,可吹牛的內(nèi)容都是我干的伸辟。 我是一名探鬼主播,決...
    沈念sama閱讀 40,992評(píng)論 3 421
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼馍刮,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼信夫!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起卡啰,我...
    開(kāi)封第一講書人閱讀 39,899評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤静稻,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后匈辱,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體振湾,經(jīng)...
    沈念sama閱讀 46,457評(píng)論 1 318
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,529評(píng)論 3 341
  • 正文 我和宋清朗相戀三年亡脸,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了押搪。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,664評(píng)論 1 352
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡浅碾,死狀恐怖大州,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情垂谢,我是刑警寧澤摧茴,帶...
    沈念sama閱讀 36,346評(píng)論 5 350
  • 正文 年R本政府宣布,位于F島的核電站埂陆,受9級(jí)特大地震影響苛白,放射性物質(zhì)發(fā)生泄漏娃豹。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 42,025評(píng)論 3 334
  • 文/蒙蒙 一购裙、第九天 我趴在偏房一處隱蔽的房頂上張望懂版。 院中可真熱鬧,春花似錦躏率、人聲如沸躯畴。這莊子的主人今日做“春日...
    開(kāi)封第一講書人閱讀 32,511評(píng)論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)蓬抄。三九已至,卻和暖如春夯到,著一層夾襖步出監(jiān)牢的瞬間嚷缭,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書人閱讀 33,611評(píng)論 1 272
  • 我被黑心中介騙來(lái)泰國(guó)打工耍贾, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留阅爽,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 49,081評(píng)論 3 377
  • 正文 我出身青樓荐开,卻偏偏與公主長(zhǎng)得像付翁,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子晃听,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,675評(píng)論 2 359

推薦閱讀更多精彩內(nèi)容