如何實現 Flutter 同步調用 Native API
Flutter Channel 是一個異步調用通道,如果想在 Dart 側同步獲取到 Native 返回的結果,調用的時候加上 await 就可以了:
- final int result = await platform.invokeMethod('hello channel');
所以這篇文章到此為止了?
不!上面這行代碼其實是個『假同步』,因為它只保證了 Dart 代碼的同步執行,而 Native 代碼與 Dart 并不在同一條線程執行。試想下,如果你通過 Flutter Channel 打日志,但由于打日志的消息是異步傳遞到 Native 的,最后日志順序可能是錯的。而通過日志來排查一些時序性相關的 Bug 時,日志的順序很重要。
因為 Flutter Channel 設計之初就是異步的,使用 await 來回切換線程所帶來的開銷不小。而且協程的 await 語法具有傳遞性,上層調用方也需要使用 await,層層傳遞。
而 DartNative (https://github.com/dart-native/dart_native) 設計之初就是同步調用的,且也支持異步調用:
- // new DNTest instance and call hello method.
- DNTest().hello('DartNative');
Why DartNative?
DartNative 是『真同步』,保證了執行順序。同時也支持異步調用。
一行代碼實現同步調用,告別 Flutter Channel 膠水代碼帶來的開發成本。
同步調用性能是 Flutter Channel 的數倍。分別使用 Flutter Channel 和 DartNative 調用 fooNSString: 方法,耗時相差三到四倍。性能數據可能在不同場景下有波動,可以通過執行 Benchmark 代碼 來對比結果。
實現原理
下圖以 Dart 同步調用 iOS Objective-C API 為例,描述了 DartNative 同步調用的原理。以一個字符串參數為例,講述了從 Dart String 自動轉為 Objective-C NSString 并傳遞給 hello: 方法的過程。返回值也是自動轉換類型的,由于篇幅原因沒在圖片中描述。
在實現了基本的同步調用后,開發重點也轉向了性能優化。
方法簽名的優化
在 Dart 同步調用 Native 時,為了實現跨語言調用時參數和返回值類型的自動轉換,需要先獲取到 Native 的方法簽名。這里做了兩方面的性能優化:
- 通過 DartFFI 調用 OC Runtime 獲取方法簽名占據了一定耗時。可以在 Dart 側加一層 Cache 來減少通信和反射次數。
- 方法簽名字符串的構成是 “TypeEncoding+offset” 的組合,跨語言之間傳遞字符串的編解碼的耗時較多,而只有 TypeEncoding 那部分才是類型自動轉換所需要的。絕大部分類型對應的 TypeEncoding 都是固定的,于是只需要傳遞 TypeEncoding 的指針即可。
字符串轉換的優化
Dart String 在與 Objective-C NSString 相互轉換的過程中,數據傳輸的格式的選擇至關重要。因為 Dart String 是使用 UTF16 編碼的,所以 DartNative 使用 Uint16List 作為數據傳輸的格式。通過性能測試,使用 UTF16 來回傳輸字符串的總耗時(包含 Native 方法自身耗時)相比 UTF8 減少了 35% 左右,如果只計算通道自動類型轉換耗時減少的比例會更多。
轉換 Dart String 為 Objective-C NSString:
使用 DartFFI 在堆上創建 uint16_t 數組,將 Dart String 轉為 UTF16 格式后裝載進去。最終通過 perform 方法反射調用 stringWithCharacters:length: 方法來創建 NSString 對象。
- final units = value.codeUnits;
- final Pointer<Uint16> charPtr = allocate<Uint16>(count: units.length + 1);
- final Uint16List nativeString = charPtr.asTypedList(units.length + 1);
- nativeString.setAll(0, units);
- nativeString[units.length] = 0;
- NSObject result = Class('NSString').perform(
- SEL('stringWithCharacters:length:'),
- args: [charPtr, units.length]);
- free(charPtr);
轉換 Objective-C NSString 為 Dart String:
NSString 轉為 UTF16 稍微麻煩一點。這里的方案是先轉為 UTF16 的 NSData,然后將 uint16_t 數組的地址和字符長度(不是字節長度)返回給 Dart 側。
- const void *
- native_convert_nsstring_to_utf16(NSString *string, NSUInteger *length) {
- NSData *data = [string dataUsingEncoding:NSUTF16StringEncoding];
- // UTF16, 2-byte per unit
- *length = data.length / 2;
- return data.bytes;
- }
Dart 拿到 uint16_t 數組后會轉為 Uint16List 類型,并用它初始化一個 String 對象。
- Pointer<Uint64> length = allocate<Uint64>();
- Pointer<Void> result = convertNSStringToUTF16(ptr, length);
- Uint16List list = result.cast<Uint16>().asTypedList(length.value);
- free(length);
- String str = String.fromCharCodes(list);
后記
寫了這么多 DartNative 的相關文章,終于輪到了介紹最基礎最核心的同步調用功能。其實異步調用也是支持的,看來用 DartNative 來替換 Flutter Channel 的理由又多了。
這篇文章主要講的是 iOS 的同步調用實現以及性能優化,Android 也已經實現同步調用中基本類型的自動轉換。