WebViewJavascriptBridge原码分析

前言

本文主要内容是对iOS的WebViewJavascriptBridge源码进行分析梳理,分为iOS端调用JS端,以及JS端调用iOS端两部分,并在最后进行了总结。

iOS端调用JS端

  1. JS端调用WebViewJavascriptBridgeregisterHandler(handlerName, handler)注册相应的回调,并将handler存到一个messageHandlers的数组当中。

  2. JS端通过将一个隐藏的iframesrc设置为:https://__bridge_loaded__,来触发OC的WebView的回调webView: shouldStartLoadWithRequest: navigationType:,此时会判断该请求的url,如果是上面的的https://__bridge_loaded__,则将WebViewJavascriptBridge的JS代码注入(通过调用UIWebView的stringByEvaluatingJavaScriptFromString:或者WKWebview的stringByEvaluatingJavaScriptFromString:completionHandler:的方法)到网页中。

  3. iOS端调用callHandler:handlerName data:responseCallback:,并将其参数封装成一个WVJBMessage(NSDictionary)并将responseCallback存到responseCallbacks(NSMutableDictionary)中,格式如下:

    message:
    {
        callbackId = "objc_cb_6"; //6是_uniqueId从0,以1为步长累加上来的
        data =     {
            greetingFromObjC = "Hi there, JS!";
        };
        handlerName = testJavascriptHandler; //在js端注册的名字,其对应的是一个方法。
    }
    
    • 向Web端注入JSBridge的JS代码之前先将message保存在一个startupMessageQueue(NSMutableArray)中,待调用injectJavascriptFile向Web端注入JSBridge的JS的时候,递归的执行_dispatchMessage:
    • iOS端调用方法_dispatchMessage:中将message序列化成一个json字符串messageJSON
  4. iOS端接下来会回调UIWebView的stringByEvaluatingJavaScriptFromString:或者WKWebview的stringByEvaluatingJavaScriptFromString:completionHandler:方法执行JS端的代码:WebViewJavascriptBridge._handleMessageFromObjC('messageJSON')

  5. JS端执行WebViewJavascriptBridge._handleMessageFromObjC(),从数组messageHandlers根据上面所说的handlerName取出相应的方法执行,如果iOS端有传入callbackId,则将其变成responseId,和要返回的数据responseData,构造一个message,并写入在sendMessageQueue中,接着将iframesrc设置为:https://__wvjb_queue_message__,这将触发UIWebView的webView:shouldStartLoadWithRequest:navigationType:或者WKWebView的webView:decidePolicyForNavigationAction:decisionHandler:回调方法。

  6. iOS端判断请求是否是https://__wvjb_queue_message__,如果是,则调用flushMessageQueue,从JS端中的sendMessageQueue取出message(json格式),并将其转换成本地的WVJBMessage(NSDictionary),并通过它的responseId从本地的responseCallbacks取出回调方法进行执行。

JS端调用iOS端

  1. iOS端在WebView加载前,调用registerHandler:handler:方法注册回调。这些回调会以注册时传入的方法名为key,存入名为messageHandlers(NSMutableDictionary)中。
  2. JS端调用setupWebViewJavascriptBridge:
    发起一个https://__bridge_loaded__请求(通过设置iframesrc实现)触发iOS端的UIWebView的webView:shouldStartLoadWithRequest:navigationType:或者WKWebView的webView:decidePolicyForNavigationAction:decisionHandler:回调方法,将JSBridge的JS代码注入到网页中。
  3. JS端调用bridge.callHandler(handlerName, data, responseCallback),然后将各个参数封装成一个message,其中会生成一个callbackId来标记这个responseCallback,存入sendMessageQueue中,接着设置iframesrchttps://__wvjb_queue_message__,依次触发UIWebView的webView:shouldStartLoadWithRequest:navigationType:或者WKWebView的webView:decidePolicyForNavigationAction:decisionHandler:回调方法。
  4. iOS端判断请求是否是https://__wvjb_queue_message__,如果是,则调用flushMessageQueue,从JS端中的sendMessageQueue取出message(json格式),并将其转换成本地的WVJBMessage(NSDictionary),并通过它的handlerName从本地的messageHandlers取出回调方法进行执行。
  5. iOS端接着将JS端传入的callbackId变成responseId并和responseData一起构造一个message,然后调用方法_dispatchMessage:中将message序列化成一个json字符串messageJSON
  6. JS端执行WebViewJavascriptBridge._handleMessageFromObjC(),根据responseId从数组responseCallbacks中取出相应的回调执行。

总结

通过上面的分析,我们可以发现:

  • iOS端调用JS接口,通过UIWebView的stringByEvaluatingJavaScriptFromString:或者WKWebview的stringByEvaluatingJavaScriptFromString:completionHandler:的方法既可。但是为了取得取得JS返回的结果,JS必须将结果封装成一个json数据,并写入的sendMessageQueue,然后通过设置一个隐藏的iframesrchttps://__wvjb_queue_message__来触发iOS端的WebView的回调,接着就在回调中调用JS的WebViewJavascriptBridge._fetchQueue()方法,取回要返回的结果信息。

  • JS端调用iOS端的接口,则先将消息写入sendMessageQueue中,然后通过设置一个隐藏的iframesrchttps://__wvjb_queue_message__来触发iOS端的WebView的回调,接着就在回调中调用JS的WebViewJavascriptBridge._fetchQueue()方法,取回要执行的方法的信息,iOS端根据这些信息找到相应的block进行执行,最后将返回的结果转换成json,并调用JS的WebViewJavascriptBridge._handleMessageFromObjC(messageJson)方法将结果回传给JS。

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

推荐阅读更多精彩内容