WKWebView 是 iOS 8.0 之後用來取代 UIWebView 的網頁元件,包含在 WebKit 中,可用 @import WebKit 導入。若專案還要支援 iOS 7,那就只能留在 UIWebView;只要是 iOS 8.0 以上,無論從功能、載入速度還是效能來看,WKWebView 都是更好的選擇。
網路上介紹 WKWebView 用法與各協程角色的文章已經很多,這裡不重複。本篇只聚焦一件在實務專案裡一定會遇到的事:原生與網頁之間的資料雙向傳遞。
我們用 WKWebView 載入一個 HTML 檔(載入網路網頁的原理相同)。假設某個操作發生時,原生需要把一筆資料(這裡以字串為例)傳給網頁。
做法是在建立 WKWebView 之前,先準備好 WKWebViewConfiguration,然後透過 WKUserScript 把 JavaScript 注入進去。
// 初始化 webView 的設定物件
let configuration = WKWebViewConfiguration()
// 這就是要傳給 web 的參數
let name = "RITL"
// 建立 WKUserScript,注入一個會呼叫 ObjCToJavaScript 的函式
let script: WKUserScript = WKUserScript(
source: "function callJavaScript() {ObjCToJavaScript('\(name)');}",
injectionTime: .AtDocumentStart,
forMainFrameOnly: true)
// 把腳本加入設定
configuration.userContentController.addUserScript(script)
接著,在需要觸發的時機(範例中是導航欄上的 Do 按鈕)呼叫這個 JS 函式:
// 回應 Do 按鈕
@IBAction func doTap(sender: AnyObject) {
let js = "callJavaScript()";
webView.evaluateJavaScript(js) { (object, error) in
// 與 iOS 8 之前的 UIWebView 用法類似
}
}
既然有 add,自然該有 remove。在 deinit 中清掉注入的腳本,是一個好習慣:
deinit {
webView.configuration.userContentController.removeAllUserScripts()
}
HTML 端只要準備一個能被 JS 找到的標籤即可,範例如下:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>我是HTML標題</title>
</head>
<script>
// 原生呼叫這個方法,並用傳入的參數做後續處理
function ObjCToJavaScript(name) {
document.getElementById("Text").innerText = name;
}
</script>
<body>
<label id="Text" style="margin-top: 100px; display: block; font-size: 100px;">Text</label>
</body>
</html>
老實說,這個方向的「傳值」,本質上就是原生去修改網頁端某個 JS 函式的觸發點,並把參數塞進去。範例中,字串「RITL」由客戶端送出,再由 JS 更新 label 的內容。

這是我在實際專案裡用得比較多的方向。在 WKWebView 之前(也就是 UIWebView 時代),要取得 JS 傳來的參數大概只有兩條路:
其一,靠 URL 重定向。網頁把參數拼成自訂格式,當作 URL 重新導向;客戶端實作 WebView 的代理方法攔下重定向的 URL,再字串解析取出參數。能用,但確實不優雅。
其二,引入第三方庫。像是 JavaScriptWebView 這類方案。但要提醒的是,這種做法通常會把 WebView 的代理與控制權交給第三方管理類——資訊交互是完成了,但你也失去了對 WebView 的直接掌控,個人覺得不划算。
WKWebView 提供了一個更漂亮、又不交出控制權的做法:透過 WKUserContentController 註冊訊息處理器。
// 對 JS 傳出資料的名稱進行監聽 // 注意:負責接收 JS 訊息的物件必須實作 <WKScriptMessageHandler> [self.webView.configuration.userContentController addScriptMessageHandler:self name:name];
這個協程只有一個方法,非常精簡:
#pragma mark - <WKScriptMessageHandler>
- (void)userContentController:(WKUserContentController *)userContentController
didReceiveScriptMessage:(WKScriptMessage *)message {
if ([message.name isEqualToString:name]) {
// message.body 就是 JS 傳出的參數本體
// handle coding..
}
}
網頁端在需要客戶端配合時,用下面的語法觸發:
/* 抽象模型 */
window.webkit.messageHandlers.<name>.postMessage(<messageBody>)
/* 具體實例:此處 name = "RITL" */
window.webkit.messageHandlers.RITL.postMessage("RITL-GOGOGO")
/* 外部監聽 */
[self.webView.configuration.userContentController addScriptMessageHandler:self name:@"RITL"];
/* 取得傳出的字串參數,即 "RITL-GOGOGO" */
NSString *dataString = message.body;
同樣的,有註冊就该有註銷,習慣性地寫在 dealloc 裡:
[self.webView.configuration.userContentController removeScriptMessageHandlerForName:name];
如果你在 dealloc 打中斷點驗證,會發現一件嚴重的事:dealloc 根本不會被呼叫。
原因在於 addScriptMessageHandler:name: 會對傳入的 handler 產生強引用。這與 NSTimer 造成的洩漏異曲同工:把 self 當成 handler 傳進去,等於讓 userContentController 強持有 self,形成保留環,控制器永遠不會釋放。
把 self 換成 __weak 有用嗎?沒有。這跟 NSTimer 那個問題一樣,換成歸零弱引用並不能解決根本的強引用關係。正確思路同樣是轉移引用對象:建立一個中間代理類,由它去被強引用,而它內部用 weak 指向真正的接收者。這樣控制器就能正常釋放,進而註銷 message handler,把洩漏堵住。
以下是我使用的轉發類實作:
/* CB_YZZBScriptMessageHandler.h */
#import <Foundation/Foundation.h>
@import WebKit;
NS_ASSUME_NONNULL_BEGIN
@interface CB_YZZBScriptMessageHandler : NSObject <WKScriptMessageHandler>
@property (nullable, nonatomic, weak) id<WKScriptMessageHandler> delegate;
- (instancetype)initWithDelegate:(id<WKScriptMessageHandler>)delegate;
+ (instancetype)scriptWithDelegate:(id<WKScriptMessageHandler>)delegate;
@end
NS_ASSUME_NONNULL_END
/* CB_YZZBScriptMessageHandler.m */
@implementation CB_YZZBScriptMessageHandler
- (instancetype)initWithDelegate:(id<WKScriptMessageHandler>)delegate {
if (self = [super init]) {
_delegate = delegate;
}
return self;
}
+ (instancetype)scriptWithDelegate:(id<WKScriptMessageHandler>)delegate {
return [[CB_YZZBScriptMessageHandler alloc] initWithDelegate:delegate];
}
#pragma mark - <WKScriptMessageHandler>
- (void)userContentController:(WKUserContentController *)userContentController
didReceiveScriptMessage:(WKScriptMessage *)message {
[self.delegate userContentController:userContentController didReceiveScriptMessage:message];
}
@end
使用時,只要把強引用對象轉一層即可:
// 建立引用物件 CB_YZZBScriptMessageHandler *messageHandle = [CB_YZZBScriptMessageHandler scriptWithDelegate:self]; // 註冊 JS 訊息處理 [self.webView.configuration.userContentController addScriptMessageHandler:messageHandle name:@"RITL"];