WebViewJavascriptBridge实现原理

关于WebViewJavascriptBridge的功能不多做介绍,有兴趣的小伙伴可以搜一下

使用示例

iOS端使用如下

let bridge = WKWebViewJavascriptBridge(for: webView)

//原生调用js
bridge.callHandler("jsFunction", data: [:], responseCallback: { (obj) in
})

//native端注册方法,以供js调用
bridge.registerHandler("nativeFunction") { (data, reponseCallback) in
}

实现原理:

js端有一个处理对象,window.WebViewJavascriptBridge对象,原生端也有一个类似的对象WebViewJavascriptBridgeBase,他们两个在两端,分别使用拦截url和注入js的方式,进行通信,他们的主要工作内容是

  • 存储自己端registed handler(实质是个block数组)

  • 存储回调(实质也是个block数组)

  • 对需要通信数据进行编码和解码

//js端存储相关代码
var messageHandlers = {}; //存储registerHandler方法注册过的block
var responseCallbacks = {}; //存储callHandler中的responseCallback
//原生端存储相关
@interface WebViewJavascriptBridgeBase : NSObject
@property (strong, nonatomic) NSMutableDictionary* responseCallbacks; //存储callHandler中的responseCallback
@property (strong, nonatomic) NSMutableDictionary* messageHandlers; //存储registerHandler方法注册过的block
@end

初始化过程

原生端的初始化:原生端调用WebViewJavascriptBridge库,生成需要的WebViewJavascriptBridge或者WKWebViewJavascriptBridge实例

js端的初始化:js端加载地址为“https://__bridge_loaded__”的新页面,新页面的加载事件触发webview的代理方法

//WKWebView
- (void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler;

//UIWebView
- (BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType;

在代理方法中识别加载地址为“https://__bridge_loaded__”,调用WebViewJavascriptBridge库中预先写好的一段js代码 — WebViewJavascriptBridge_JS,使用evaluateJavaScript执行这段js代码,在js端生成window.WebViewJavascriptBridge对象及一些需要的js方法。

这种交互方式,比较通用的叫法是 url sheme

原生调用js

原生调用js的callHandler方法,实际上是调用WebViewJavascriptBridgeBase中方法对参数进行处理。

WebViewJavascriptBridgeBase会为此次调用的回调生成一个id,并在responseCallbacks中用ID为key存储回调。然后把js方法名、参数、回调id 组织成字典,再json字符串化。

{
  "data": ["ID": 67788],
  "callbackId": "objc_cb_1",
  "handlerName": "jsFunction"
}

然后用“WebViewJavascriptBridge._handleMessageFromObjC”把这个message字符串包起来。_handleMessageFromObjC的是初始化时通过WebViewJavascriptBridge_JS注入js中的一个js方法。接下来通过evaluateJavaScript执行handleMessageFromObjC。

NSString* javascriptCommand = [NSString stringWithFormat:@"WebViewJavascriptBridge._handleMessageFromObjC('%@');", messageJSON];

js端的bridge方法handleMessageFromObjC被调用后,先将json字符串解析成字典对象,然后根据字典中的handlerName值,在messageHandlers中寻找注册过的对应name的function,将message.data和js回调传给该function,进行调用。

if (message.callbackId) {
    var callbackResponseId = message.callbackId;
    responseCallback = function(responseData) {
        _doSend({ handlerName:message.handlerName, responseId:callbackResponseId, responseData:responseData });
    };
}
                
var handler = messageHandlers[message.handlerName];
if (!handler) {
    console.log("WebViewJavascriptBridge: WARNING: no handler for message from ObjC:", message);
} else {
    handler(message.data, responseCallback);
}

注意一点,上面的responseCallback是js自己的回调,原生的回调还留在WebViewJavascriptBridge的responseCallbacks字典中存储。js回调的功能是给原生发送回调消息。

js回调调用_doSend方法中把字典类型的message添加进sendMessageQueue数组

[handlerName: xxxx, responseId: xxx, responseData: xxx] //iOS 字典
{handlerName: xxxx, responseId: xxx, responseData: xxx} //js 字典

然后加载一个地址为“https://__wvjb_queue_message__”的新页面,原生的代理方法被调用

WebViewJavascriptBridge中的代理方法识别到特殊的加载地址,使用evaluateJavaScript调用“WebViewJavascriptBridge._fetchQueue();”,js端的_fetchQueue把sendMessageQueue数组中的message都格式化成json字符串。原生拿到messages的json字符串后先把字符串转换成数组,然后遍历数组处理每个message(通常只有一个)。原生bridge发现message中有responseId,则用responseId调用对应的responseCallback。如果没有responseId,说明这不是 原生调js - js回调原生,而是js直接调用原生的方法,那就从messageHandlers中寻找对应handlerName的block

在原生端初始化WebViewJavascriptBridge的时候,WebViewJavascriptBridge就把webview的代理指向了自己,所以这里能拦截到。如果webview的代理被指向了其他地方,那WebViewJavascriptBridge就不工作了。毕竟js端初始化就指望着这个代理方法拦截到请求,然后去给js注入window.WebViewJavascriptBridge对象。

js调用原生

前面原生调用js中说到了原生发消息给js,js怎么处理,原生的回调怎么处理。js调用原生是类似的逻辑。只是双方发消息的方式不一样,一个是通过evaluateJavaScript,一个是通过url sheme。这里不再多述。

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

推荐阅读更多精彩内容