這篇記錄來自一個真實需求:用本地 CSS 渲染一段從網路取得、只有 body 部分的 HTML 片段,同時要停用 HTML 內建 <img> 的自動載入,改由原生端負責下載,再把快取位置回傳給網頁。
把圖片搬回原生端的理由很實際:一是能落地快取,第二次進入文章直接讀本地,省流量也快;二是點擊放大、存入相簿、雙擊縮放這些互動,在原生端實作遠比在網頁裡折騰容易。
於是出現兩個技術難題:如何讓 HTML 在 onLoad 時不去抓圖?以及原生端下載完之後,怎麼把結果送回網頁?
單靠 stringByEvaluatingJavaScriptFromString: 這類簡易評估方法並不足夠。真正好用的方案是開源庫 WebViewJavascriptBridge,它把 UIWebView 與 JS 的雙向呼叫包裝成了統一介面。
Objective-C 端:
@property WebViewJavascriptBridge *bridge;
_bridge = [WebViewJavascriptBridge bridgeForWebView:webView
webViewDelegate:self
handler:^(id data, WVJBResponseCallback responseCallback) {
NSLog(@"ObjC received message from JS: %@", data);
responseCallback(@"Response for message from ObjC");
}];
JS 端則是一段固定寫法,負責等待橋樑就緒:
function connectWebViewJavascriptBridge(callback) {
if (window.WebViewJavascriptBridge) {
callback(WebViewJavascriptBridge);
} else {
document.addEventListener('WebViewJavascriptBridgeReady', function() {
callback(WebViewJavascriptBridge);
}, false);
}
}
connectWebViewJavascriptBridge(function(bridge) {
bridge.init(function(message, responseCallback) {
log('JS got a message', message);
var data = { 'Javascript Responds': 'Wee!' };
responseCallback(data);
});
});
整個機制只有兩個原語:send 與 callHandler,兩端各自都有,因此形成四種組合。最典型的兩條是:JS 呼叫 bridge.send() 會觸發 Objective-C 端初始化時傳入的 handler;JS 呼叫 bridge.callHandler('xxx') 則觸發原生端以同名註冊的處理器:
bridge.registerHandler('testJavascriptHandler', function(data, responseCallback) {
log('ObjC called testJavascriptHandler with', data);
var responseData = { 'Javascript Says': 'Right back atcha!' };
responseCallback(responseData);
});
步驟 1|先斷掉自動載入。把 HTML 裡的 src 全部改名,瀏覽器自然就找不到圖片來源:
NSString *_content = [contentString stringByReplacingOccurrencesOfString:@"src"
withString:@"esrc"];
步驟 2|組出完整 HTML 並在 body 觸發 JS。由於拿到的只是 body 片段,需要自己補上完整的 HTML 骨架,讓 <body onload="onLoaded()"> 去呼叫 JS 的 onLoaded。這個函數遍歷所有 img 標籤的 esrc,彙整成陣列後交給原生端:
function onLoaded() {
connectWebViewJavascriptBridge(function(bridge) {
var allImage = document.querySelectorAll("img");
allImage = Array.prototype.slice.call(allImage, 0);
var imageUrlsArray = new Array();
allImage.forEach(function(image) {
var esrc = image.getAttribute("esrc");
imageUrlsArray.push(esrc);
});
bridge.send(imageUrlsArray);
});
}
步驟 3|原生端接手。bridge.send 會觸發初始化時的 handler,我們在那裡下載全部圖片,並把快取鍵與可用來源回傳 JS:
#pragma mark -- 下載全部圖片
- (void)downloadAllImagesInNative:(NSArray *)imageUrls {
SDWebImageManager *manager = [SDWebImageManager sharedManager];
_allImagesOfThisArticle = [NSMutableArray arrayWithCapacity:imageUrls.count];
for (NSUInteger i = 0; i < imageUrls.count; i++) {
[_allImagesOfThisArticle addObject:[NSNull null]];
}
for (NSUInteger i = 0; i < imageUrls.count; i++) {
NSString *_url = imageUrls[i];
[manager downloadImageWithURL:[NSURL URLWithString:_url]
options:SDWebImageHighPriority
progress:nil
completed:^(UIImage *image, NSError *error,
SDImageCacheType cacheType, BOOL finished,
NSURL *imageURL) {
if (image) {
NSString *imgB64 = [UIImageJPEGRepresentation(image, 1.0)
base64EncodedStringWithOptions:NSDataBase64Encoding64CharacterLineLength];
NSString *key = [manager cacheKeyForURL:imageURL];
NSString *source = [NSString stringWithFormat:@"data:image/png;base64,%@", imgB64];
[_bridge callHandler:@"imagesDownloadComplete" data:@[key, source]];
}
}];
}
}
步驟 4|JS 回填 src。原生端的 callHandler 觸發 JS 的 imagesDownloadComplete,把新來源寫回對應的 img:
function imagesDownloadComplete(pOldUrl, pNewUrl) {
var allImage = document.querySelectorAll("img");
allImage = Array.prototype.slice.call(allImage, 0);
allImage.forEach(function(image) {
if (image.getAttribute("esrc") == pOldUrl ||
image.getAttribute("esrc") == decodeURIComponent(pOldUrl)) {
image.src = pNewUrl;
}
});
}
至此,「原生下載 + JS 渲染」的閉環完成,同時也涵蓋了 OC 調 JS 與 JS 調 OC 兩個方向。其他業務需求大致可以依樣畫葫蘆,差別只在業務邏輯。
使用者點的是網頁裡的一張圖,要怎麼讓它「跳出來」放大、還能左右滑動、雙擊縮放、存入相簿?關鍵在於善於「作弊」:網頁中的圖片確實無法自己跳出來,但我們可以依 JS 回報的位置資訊,在原生端造一個同尺寸的佔位視圖,用它做轉場動畫。
首先改造 HTML,用正則為 img 標籤補上 onClick:
NSRegularExpression *regex = [NSRegularExpression
regularExpressionWithPattern:@"(《img[^》]+esrc=\")(\\S+)\""
options:0 error:nil];
result = [regex stringByReplacingMatchesInString:newContent
options:0
range:NSMakeRange(0, newContent.length)
withTemplate:@"《img esrc=\"$2\" onClick=\"javascript:onImageClick('$2')\""];
JS 端的 onImageClick 負責回報兩件事:點擊圖片在全部圖片中的索引,以及它在當前視口中的幾何位置。
function onImageClick(picUrl) {
connectWebViewJavascriptBridge(function(bridge) {
var allImage = document.querySelectorAll("p img[esrc]");
allImage = Array.prototype.slice.call(allImage, 0);
var index = -1, x = 0, y = 0, width = 0, height = 0;
allImage.forEach(function(image, i) {
if (image.getAttribute("esrc") == picUrl ||
image.getAttribute("esrc") == decodeURIComponent(picUrl)) {
index = i;
x = image.getBoundingClientRect().left + document.documentElement.scrollLeft;
y = image.getBoundingClientRect().top + document.documentElement.scrollTop;
width = image.width;
height = image.height;
}
});
bridge.callHandler('imageDidClicked',
{ 'index': index, 'x': x, 'y': y, 'width': width, 'height': height },
function(response) {
console.log("JS 已送出 index,並收到 OC 回調");
});
});
}
原生端收到後,用回報的座標建立一個透明的佔位 UIImageView,再交給 IDMPhotoBrowser 完成瀏覽體驗:
[_bridge registerHandler:@"imageDidClicked"
handler:^(id data, WVJBResponseCallback responseCallback) {
NSInteger index = [[data objectForKey:@"index"] integerValue];
CGFloat originX = [[data objectForKey:@"x"] floatValue];
CGFloat originY = [[data objectForKey:@"y"] floatValue];
CGFloat width = [[data objectForKey:@"width"] floatValue];
CGFloat height = [[data objectForKey:@"height"] floatValue];
tappedImageView.alpha = 0;
tappedImageView.frame = CGRectMake(originX, originY, width, height);
tappedImageView.image = _allImagesOfThisArticle[index];
responseCallback(@"OC 已收到 imageDidClicked");
[self presentPhotosBrowserWithInitialPage:index animatedFromView:tappedImageView];
}];
Objective-C 有 breakpoints,JS 卻常常只能靠猜。其實不必為此換編輯器:把 iPhone 接上電腦或啟動模擬器,當 App 顯示著 UIWebView 時,Safari 會自動識別出該 WebView,你可以在「開發」選單中找到對應裝置,開啟 Web Inspector 後,久违的 console 與 console.log 輸出全都回來了。
折騰 WebViewJavascriptBridge 的這幾天,最大的感受是學無止境。Node.js 能寫伺服器、React Native 能寫 iOS、GitHub 上最熱門的語言是 JS,確實讓人一時心癢。但冷靜下來想想手上有什麼、該補什麼,才是更要緊的事。
原文地址:
https://kittenyang.com/webview-javascript-bridge/