Objective-C 和 Swift 互通性與 package:ffigen

Objective-C 範例
Swift 範例

在 macOS 或 iOS 上的 Dart Native 平台上運行的 Dart 行動、命令列和伺服器應用程式，可以使用 dart:ffi 和 package:ffigen 來呼叫 Objective-C 和 Swift API。

dart:ffi 使 Dart 程式碼能夠與原生 C API 互動。Objective-C 是基於 C 且與 C 相容，因此僅使用 dart:ffi 即可與 Objective-C API 互動。然而，這樣做會涉及大量樣板程式碼，因此您可以使用 package:ffigen 自動為給定的 Objective-C API 產生 Dart FFI 綁定。若要深入了解 FFI 以及直接與 C 程式碼介接，請參閱 C 互操作性指南。

您可以為 Swift API 產生 Objective-C 標頭，使 dart:ffi 和 package:ffigen 能夠與 Swift 互動。

本指南將逐步引導您完成一個範例，該範例使用 package:ffigen 為 AVAudioPlayer 產生綁定。此 API 至少需要 macOS SDK 10.7，因此請檢查您的版本並在必要時更新 Xcode

$ xcodebuild -showsdks

產生綁定以包裝 Objective-C API 類似於包裝 C API。將 package:ffigen 指向描述 API 的標頭檔，然後使用 dart:ffi 載入程式庫。

package:ffigen 使用 LLVM 解析 Objective-C 標頭檔，因此您需要先安裝它。請參閱 ffigen README 中的安裝 LLVM 以取得更多詳細資訊。

首先，將 package:ffigen 新增為開發依賴項

$ dart pub add --dev ffigen

然後，設定 ffigen 以為包含 API 的 Objective-C 標頭產生綁定。ffigen 設定選項位於 pubspec.yaml 檔案的頂層 ffigen 條目下。或者，您可以將 ffigen 設定放在其自己的 .yaml 檔案中。

yamlffigen:
  name: AVFAudio
  description: Bindings for AVFAudio.
  language: objc
  output: 'avf_audio_bindings.dart'
  headers:
    entry-points:
      - '/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/System/Library/Frameworks/AVFAudio.framework/Headers/AVAudioPlayer.h'

name 是將產生的原生程式庫包裝函式類別的名稱，而 description 將用於該類別的文件中。output 是 ffigen 將建立的 Dart 檔案的路徑。進入點是包含 API 的標頭檔。在本範例中，它是內部的 AVAudioPlayer.h 標頭。

如果您查看範例設定，您還會看到另一個重要的事項是排除和包含選項。預設情況下，ffigen 會為它在標頭中找到的所有內容以及這些綁定在其他標頭中相依的所有內容產生綁定。大多數 Objective-C 程式庫都相依於 Apple 的內部程式庫，這些程式庫非常龐大。如果在沒有任何過濾器的情況下產生綁定，則產生的檔案可能會長達數百萬行。為了解決此問題，ffigen 設定具有可讓您過濾掉所有您不感興趣的函數、結構、列舉等的欄位。對於此範例，我們僅對 AVAudioPlayer 感興趣，因此您可以排除其他所有內容

yaml  exclude-all-by-default: true
  objc-interfaces:
    include:
      - 'AVAudioPlayer'

由於 AVAudioPlayer 像這樣被明確包含，因此 ffigen 會排除所有其他介面。exclude-all-by-default 標誌告訴 ffigen 排除其他所有項目。結果是除了 AVAudioPlayer 及其相依性（例如 NSObject 和 NSString）之外，沒有包含任何其他內容。因此，您最終得到的不是數百萬行的綁定，而是數萬行。

如果您需要更細緻的控制，您可以單獨排除或包含所有宣告，而不是使用 exclude-all-by-default

yaml  functions:
    exclude:
      - '.*'
  structs:
    exclude:
      - '.*'
  unions:
    exclude:
      - '.*'
  globals:
    exclude:
      - '.*'
  macros:
    exclude:
      - '.*'
  enums:
    exclude:
      - '.*'
  unnamed-enums:
    exclude:
      - '.*'

這些 exclude 條目都排除正規表示式 '.*'，它會匹配任何內容。

您也可以使用 preamble 選項在產生的檔案頂端插入文字。在本範例中，preamble 用於在產生的檔案頂端插入一些 Linter 忽略規則

yaml  preamble: |
    // ignore_for_file: camel_case_types, non_constant_identifier_names, unused_element, unused_field, return_of_invalid_type, void_checks, annotate_overrides, no_leading_underscores_for_local_identifiers, library_private_types_in_public_api

請參閱 ffigen 說明文件以取得完整的設定選項清單。

若要產生綁定，請導航至範例目錄，並執行 ffigen

$ dart run ffigen

這將在 pubspec.yaml 檔案中搜尋頂層 ffigen 條目。如果您選擇將 ffigen 設定放在單獨的檔案中，請使用 --config 選項並指定該檔案

$ dart run ffigen --config my_ffigen_config.yaml

對於此範例，這將產生 avf_audio_bindings.dart。

此檔案包含一個名為 AVFAudio 的類別，它是原生程式庫包裝函式，它使用 FFI 載入所有 API 函數，並提供方便的包裝函式方法來呼叫它們。此檔案中的其他類別都是我們需要的 Objective-C 介面的 Dart 包裝函式，例如 AVAudioPlayer 及其相依性。

現在您已準備好載入並與產生的程式庫互動。範例應用程式 play_audio.dart 會載入並播放作為命令列參數傳遞的音訊檔案。第一步是載入 dylib 並實例化原生 AVFAudio 程式庫

dartimport 'dart:ffi';
import 'avf_audio_bindings.dart';

const _dylibPath =
    '/System/Library/Frameworks/AVFAudio.framework/Versions/Current/AVFAudio';

void main(List<String> args) async {
  final lib = AVFAudio(DynamicLibrary.open(_dylibPath));

由於您載入的是內部程式庫，因此 dylib 路徑指向內部框架 dylib。您也可以載入自己的 .dylib 檔案，或者如果程式庫是靜態連結到您的應用程式中 (在 iOS 上通常是這種情況)，則可以使用 DynamicLibrary.process()

dart

  final lib = AVFAudio(DynamicLibrary.process());

範例的目標是逐個播放作為命令列參數指定的每個音訊檔案。對於每個參數，您首先必須將 Dart String 轉換為 Objective-C NSString。產生的 NSString 包裝函式具有方便的建構子來處理此轉換，以及一個 toString() 方法將其轉換回 Dart String。

dart  for (final file in args) {
    final fileStr = NSString(lib, file);
    print('Loading $fileStr');

音訊播放器預期使用 NSURL，因此接下來我們使用 fileURLWithPath: 方法將 NSString 轉換為 NSURL。由於 : 在 Dart 方法名稱中不是有效的字元，因此在綁定中已將其轉換為 _。

dart

    final fileUrl = NSURL.fileURLWithPath_(lib, fileStr);

現在，您可以建構 AVAudioPlayer。建構 Objective-C 物件有兩個階段。alloc 為物件分配記憶體，但不初始化它。名稱以 init* 開頭的方法會執行初始化。某些介面也提供 new* 方法來執行這兩個步驟。

若要初始化 AVAudioPlayer，請使用 initWithContentsOfURL:error: 方法

dart    final player =
        AVAudioPlayer.alloc(lib).initWithContentsOfURL_error_(fileUrl, nullptr);

Objective-C 使用參考計數進行記憶體管理 (透過 retain、release 和其他函數)，但在 Dart 端，記憶體管理是自動處理的。Dart 包裝函式物件會保留對 Objective-C 物件的參考，並且當 Dart 物件被垃圾回收時，產生的程式碼會使用 NativeFinalizer 自動釋放該參考。

接下來，查找音訊檔案的長度，您稍後需要它來等待音訊完成。duration 是一個 @property(readonly)。Objective-C 屬性會轉換為產生的 Dart 包裝函式物件上的 getter 和 setter。由於 duration 是 readonly，因此僅產生 getter。

產生的 NSTimeInterval 只是型別別名為 double，因此您可以立即使用 Dart .ceil() 方法無條件進位到下一個整數秒

dart    final durationSeconds = player.duration.ceil();
    print('$durationSeconds sec');

最後，您可以使用 play 方法播放音訊，然後檢查狀態，並等待音訊檔案的持續時間

dart    final status = player.play();
    if (status) {
      print('Playing...');
      await Future<void>.delayed(Duration(seconds: durationSeconds));
    } else {
      print('Failed to play audio.');
    }

多執行緒問題是 Dart 實驗性支援 Objective-C 互操作性的最大限制。這些限制是由於 Dart isolates 和作業系統執行緒之間的關係，以及 Apple 的 API 處理多執行緒的方式

Dart isolates 與執行緒不同。Isolates 在執行緒上運行，但不保證在任何特定執行緒上運行，並且 VM 可能會在沒有警告的情況下變更 isolate 運行的執行緒。有一個開放功能請求，要求允許將 isolates 固定到特定執行緒。
雖然 ffigen 支援將 Dart 函數轉換為 Objective-C blocks，但大多數 Apple API 並不保證回呼將在哪個執行緒上運行。
大多數涉及 UI 互動的 API 只能在主執行緒上呼叫，在 Flutter 中也稱為平台執行緒。
許多 Apple API 不是執行緒安全的。

前兩點表示在一個 isolate 中建立的回呼可能會在運行不同 isolate 的執行緒上或根本沒有 isolate 的情況下調用。根據您使用的回呼類型，這可能會導致您的應用程式崩潰。使用 Pointer.fromFunction 或 NativeCallable.isolateLocal 建立的回呼必須在擁有者 isolate 的執行緒上調用，否則它們將會崩潰。使用 NativeCallable.listener 建立的回呼可以從任何執行緒安全地調用。

第三點表示直接使用產生的 Dart 綁定呼叫某些 Apple API 可能不是執行緒安全的。這可能會使您的應用程式崩潰，或導致其他無法預測的行為。您可以透過編寫一些 Objective-C 程式碼來解決此限制，這些程式碼會將您的呼叫分派到主執行緒。如需更多資訊，請參閱 Objective-C 調度文件。

關於最後一點，雖然 Dart isolates 可以切換執行緒，但它們一次只能在一個執行緒上運行。因此，您正在互動的 API 不一定必須是執行緒安全的，只要它不是執行緒不友善的，並且沒有關於從哪個執行緒呼叫它的限制即可。

只要您牢記這些限制，就可以安全地與 Objective-C 程式碼互動。

此範例示範如何使 Swift 類別與 Objective-C 相容、產生包裝函式標頭，並從 Dart 程式碼調用它。

Swift API 可以透過使用 @objc 註解來與 Objective-C 相容。請務必將您想要使用的任何類別或方法設為 public，並讓您的類別擴展 NSObject。

swiftimport Foundation

@objc public class SwiftClass: NSObject {
  @objc public func sayHello() -> String {
    return "Hello from Swift!";
  }

  @objc public var someField = 123;
}

如果您嘗試與第三方程式庫互動，但無法修改其程式碼，您可能需要編寫一個與 Objective-C 相容的包裝函式類別，以公開您想要使用的方法。

如需有關 Objective-C/Swift 互操作性的更多資訊，請參閱 Swift 文件。

一旦您使您的類別相容，您就可以產生 Objective-C 包裝函式標頭。您可以使用 Xcode 或使用 Swift 命令列編譯器 swiftc 來執行此操作。本範例使用命令列

$ swiftc -c swift_api.swift             \
    -module-name swift_module           \
    -emit-objc-header-path swift_api.h  \
    -emit-library -o libswiftapi.dylib

此命令會編譯 Swift 檔案 swift_api.swift，並產生包裝函式標頭 swift_api.h。它還會產生您稍後要載入的 dylib libswiftapi.dylib。

您可以透過開啟標頭並檢查介面是否符合您的預期來驗證標頭是否正確產生。在檔案的底部附近，您應該會看到類似以下內容

objcSWIFT_CLASS("_TtC12swift_module10SwiftClass")
@interface SwiftClass : NSObject
- (NSString * _Nonnull)sayHello SWIFT_WARN_UNUSED_RESULT;
@property (nonatomic) NSInteger someField;
- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
@end

如果介面遺失，或沒有其所有方法，請確保它們都使用 @objc 和 public 進行了註解。

Ffigen 僅看到 Objective-C 包裝函式標頭 swift_api.h。因此，大多數設定看起來與 Objective-C 範例類似，包括將語言設定為 objc。

yamlffigen:
  name: SwiftLibrary
  description: Bindings for swift_api.
  language: objc
  output: 'swift_api_bindings.dart'
  exclude-all-by-default: true
  objc-interfaces:
    include:
      - 'SwiftClass'
    module:
      'SwiftClass': 'swift_module'
  headers:
    entry-points:
      - 'swift_api.h'
  preamble: |
    // ignore_for_file: camel_case_types, non_constant_identifier_names, unused_element, unused_field, return_of_invalid_type, void_checks, annotate_overrides, no_leading_underscores_for_local_identifiers, library_private_types_in_public_api

與之前一樣，將語言設定為 objc，並將進入點設定為標頭；預設排除所有項目，並明確包含您要綁定的介面。

包裝 Swift API 和純 Objective-C API 的設定之間的一個重要差異：objc-interfaces -> module 選項。當 swiftc 編譯程式庫時，它會為 Objective-C 介面提供模組前綴。在內部，SwiftClass 實際上註冊為 swift_module.SwiftClass。您需要告知 ffigen 此前綴，以便它從 dylib 載入正確的類別。

並非每個類別都會獲得此前綴。例如，NSString 和 NSObject 不會獲得模組前綴，因為它們是內部類別。這就是 module 選項從類別名稱對應到模組前綴的原因。您也可以使用正規表示式一次匹配多個類別名稱。

模組前綴是您在 -module-name 標誌中傳遞給 swiftc 的任何內容。在本範例中，它是 swift_module。如果您未明確設定此標誌，則預設為 Swift 檔案的名稱。

如果您不確定模組名稱是什麼，您也可以檢查產生的 Objective-C 標頭。在 @interface 上方，您會找到一個 SWIFT_CLASS 巨集

objcSWIFT_CLASS("_TtC12swift_module10SwiftClass")
@interface SwiftClass : NSObject

巨集內的字串有點難以理解，但您可以看到它包含模組名稱和類別名稱："_TtC12swift_module10SwiftClass"。

Swift 甚至可以為我們解碼此名稱

$ echo "_TtC12swift_module10SwiftClass" | swift demangle

這會輸出 swift_module.SwiftClass。

與之前一樣，導航至範例目錄，並執行 ffigen

$ dart run ffigen

這會產生 swift_api_bindings.dart。

與這些綁定互動與普通 Objective-C 程式庫完全相同

dartimport 'dart:ffi';
import 'swift_api_bindings.dart';

void main() {
  final lib = SwiftLibrary(DynamicLibrary.open('libswiftapi.dylib'));
  final object = SwiftClass.new1(lib);
  print(object.sayHello());
  print('field = ${object.someField}');
  object.someField = 456;
  print('field = ${object.someField}');
}

請注意，產生的 Dart API 中未提及模組名稱。它僅在內部用於從 dylib 載入類別。

現在您可以使用以下命令執行範例

$ dart run example.dart

除非另有說明，否則本網站上的文件反映 Dart 3.7.1。頁面最後更新於 2024-04-11。查看原始碼或回報問題。

Objective-C 和 Swift 互通性與 package:ffigen

Objective-C 範例

設定 ffigen

產生 Dart 綁定

使用綁定

回呼與多執行緒限制

Swift 範例

產生 Objective-C 包裝函式標頭檔

設定 ffigen

產生 Dart 綁定

使用綁定