原生與 Hybrid 之爭這裡不做討論,重點說說 JavaScript 與 Objective-C 之間該怎麼通信。
這是 UIWebView 自帶的方法,也是與 JS 交互最樸素的方式:
- (nullable NSString *)stringByEvaluatingJavaScriptFromString:(NSString *)script;
通常在 webViewDidFinishLoad: 中調用:
NSString *title = [webview stringByEvaluatingJavaScriptFromString:@"document.title"];
NSString *url = [webview stringByEvaluatingJavaScriptFromString:@"document.location.href"];
iOS 7 之後引入的 JavaScriptCore.framework 讓 OC 與 JS 的互調變得優雅。先熟悉幾個核心對象:
JSContext:為 JavaScript 提供運行上下文,通過 -evaluateScript: 執行腳本JSValue:連接 JS 與 OC 的橋梁,封裝了類型轉換與調用能力JSManagedValue:管理數據與方法的記憶體生命週期JSVirtualMachine:處理線程相關場景,使用較少JSExport:協議,基於協議交互時自定義協議必須遵守它
self.jsContext = [[JSContext alloc] init];
[self.jsContext evaluateScript:@"var num = 10"];
[self.jsContext evaluateScript:@"var squareFunc = function(value) { return value * 2 }"];
JSValue *square = [self.jsContext evaluateScript:@"squareFunc(num)"];
JSValue *squareFunc = self.jsContext[@"squareFunc"];
JSValue *value = [squareFunc callWithArguments:@[@"20"]];
NSLog(@"%@", square.toNumber);
JavaScriptCore 沒有瀏覽器裡的 window、document、console,但我們可以自定義一個 Block 當作 JS 的全局函數:
JSContext *context = [[JSContext alloc] init];
context[@"log"] = ^() {
NSArray *args = [JSContext currentArguments];
for (JSValue *jsVal in args) { NSLog(@"%@", jsVal); }
};
[context evaluateScript:@"log('ider', [7, 21], { hello:'world', js:100 });"];
JS 調用 OC 方法時參數個數不固定,JSContext 提供了 +currentArguments 與 +currentThis 兩個類方法來取得參數列表與調用者。
反過來,JSValue 提供了:
- (JSValue *)callWithArguments:(NSArray *)arguments;
- (JSValue *)invokeMethod:(NSString *)method withArguments:(NSArray *)arguments;
注意 JSValue 並沒有 toBlock,因為 Block 的參數個數、類型與返回值都是編譯期固定的,無法承載 JS 那種動態簽名。
OC 的異常會被 Xcode 捕獲,而 JSContext 中執行的 JS 出錯時,異常只會被存到 exception 屬性上,不會向外拋。與其反復判斷 exception 是否為 nil,更合理的做法是設置 exceptionHandler:
context.exceptionHandler = ^(JSContext *con, JSValue *exception) {
NSLog(@"%@", exception);
con.exception = exception;
};
[context evaluateScript:@"ider.zheng = 21"];
// ReferenceError: Can't find variable: ider
Block 在 Block 內部不要直接引用外部定義的 JSContext 或 JSValue。應該把 context 當作參數傳進來,或者用 +currentContext 獲取。否則 Block 強引用 context、context 又強引用 Block,形成循環引用導致內存洩漏。JSValue 同理,因為每個 JSValue 都持有其 JSContext 的引用。
前面那些方式只適合數值、布爾、字符串、數組等基礎類型。當需要傳遞複雜結構、並要求接口約定清晰時,建議事先與前端商定格式,用協議 + 模型的方式實現。
@protocol JavaScriptObjectiveCDelegate <JSExport>
- (void)callSystemCamera;
// JS 中調用時函數名為 showAlertMsg(arg1, arg2)
- (void)showAlert:(NSString *)title msg:(NSString *)msg;
- (void)callWithDict:(NSDictionary *)params;
- (void)jsCallObjcAndObjcCallJsWithDict:(NSDictionary *)params;
@end
@interface ObjCModel : NSObject <JavaScriptObjectiveCDelegate>
@property (nonatomic, weak) JSContext *jsContext;
@end
模型實現中,可以在處理完 OC 邏輯後反過來調用 JS 方法,形成閉環:
- (void)callSystemCamera {
NSLog(@"JS 調用了 OC,調起系統相冊");
JSValue *jsFunc = self.jsContext[@"jsFunc"];
[jsFunc callWithArguments:nil];
}
- (void)jsCallObjcAndObjcCallJsWithDict:(NSDictionary *)params {
JSValue *jsParamFunc = self.jsContext[@"jsParamFunc"];
[jsParamFunc callWithArguments:@[@{@"age": @10, @"name": @"lili", @"height": @158}]];
}
注入的關鍵在於通過 KVC 拿到 UIWebView 的 JS 上下文:
- (void)webViewDidFinishLoad:(UIWebView *)webView {
self.jsContext = [webView valueForKeyPath:@"documentView.webView.mainFrame.javaScriptContext"];
ObjCModel *model = [[ObjCModel alloc] init];
self.jsContext[@"OCModel"] = model;
model.jsContext = self.jsContext;
self.jsContext.exceptionHandler = ^(JSContext *context, JSValue *exceptionValue) {
context.exception = exceptionValue;
NSLog(@"異常信息:%@", exceptionValue);
};
}
HTML 側只需要通過注入的模型對象調用即可:
<input type="button" value="Call ObjC system camera"
onclick="OCModel.callSystemCamera()" />
<input type="button" value="Call ObjC system alert"
onclick="OCModel.showAlertMsg('js title', 'js message')" />
<input type="button" value="Call ObjC func with JSON"
onclick="OCModel.callWithDict({'name':'testname','age':10,'height':170})" />
還有一個容易忽略的細節:JS 調用本地方法是在子線程中執行的,涉及 UI 更新時必須自行切換到主線程;而在回調 JavaScript 方法時,最好在最初調用它的那個線程中執行,以保證線程語義一致。
在 UIWebView 的代理方法中判斷 URL 前綴,命中約定協議時攔截並解析參數:
- (BOOL)webView:(UIWebView *)webView
shouldStartLoadWithRequest:(NSURLRequest *)request
navigationType:(UIWebViewNavigationType)navigationType {
NSString *urlStr = request.URL.absoluteString;
if ([urlStr rangeOfString:@"test://"].location != NSNotFound) {
NSURL *url = [NSURL URLWithString:urlStr];
NSString *scheme = url.scheme;
NSString *host = url.host;
NSString *query = url.query;
// 根據參數做進一步處理
return NO;
}
return YES;
}
這種方式的好處是零依賴、兼容性極好,缺點是參數只能拼接在 URL 上,表達能力有限,不適合傳遞複雜結構。