使用 dart:ffi 绑定到原生 iOS 代码

Flutter 移动和桌面应用可以使用 dart:ffi 库调用原生 C API。FFI 代表外部函数接口 (foreign function interface)。其他类似功能的术语包括原生接口和语言绑定。

在你的库或程序可以使用 FFI 库绑定到原生代码之前，你必须确保原生代码已加载且其符号对 Dart 可见。本页面侧重于在 Flutter 插件或应用中编译、打包和加载 iOS 原生代码。

本教程演示了如何在 Flutter 插件中捆绑 C/C++ 源代码，并通过 Dart FFI 库在 iOS 上绑定它们。在本演练中，你将创建一个实现 32 位加法的 C 函数，然后通过名为 "native_add" 的 Dart 插件将其公开。

原生库可以动态或静态地链接到应用中。静态链接库嵌入到应用的 executables 映像中，并在应用启动时加载。

可以使用 DynamicLibrary.executable 或 DynamicLibrary.process 加载静态链接库中的符号。

相比之下，动态链接库以独立文件或文件夹的形式在应用中分发，并按需加载。在 iOS 上，动态链接库作为 .framework 文件夹分发。

可以使用 DynamicLibrary.open 将动态链接库加载到 Dart 中。

API 文档可从 Dart API 参考文档 获取。

要创建一个名为 "native_add" 的 FFI 插件，请执行以下操作：

flutter create --platforms=android,ios,macos,windows,linux --template=plugin_ffi native_add
cd native_add

这将在 native_add/src 中创建一个包含 C/C++ 源代码的插件。这些源代码由不同操作系统构建文件夹中的原生构建文件构建。

FFI 库只能绑定 C 符号，因此在 C++ 中，这些符号会被标记为 extern "C"。

您还应该添加属性来指示这些符号是从 Dart 引用的，以防止链接器在链接时优化期间丢弃这些符号。__attribute__((visibility("default"))) __attribute__((used))。

在 iOS 上，native_add/ios/native_add.podspec 链接代码。

原生代码在 lib/native_add_bindings_generated.dart 中从 Dart 调用。

绑定是使用 package:ffigen 生成的。

动态链接库在应用启动时由动态链接器自动加载。它们的组成符号可以使用 DynamicLibrary.process 解析。你也可以使用 DynamicLibrary.open 获取库的句柄以限制符号解析的范围，但目前尚不清楚 Apple 的审核流程如何处理此情况。

静态链接到应用程序二进制文件中的符号可以使用 DynamicLibrary.executable 或 DynamicLibrary.process 解析。

要链接到平台库，请使用以下说明

1. 在 Xcode 中，打开 Runner.xcworkspace。
2. 选择目标平台。
3. 点击Linked Frameworks and Libraries部分中的 +。
4. 选择要链接的系统库。

第一方原生库可以作为源代码或（已签名）.framework 文件包含。可能也可以包含静态链接的归档文件，但这需要测试。

要直接链接到源代码，请使用以下说明：

1. 在 Xcode 中，打开 Runner.xcworkspace。

2. 将 C/C++/Objective-C/Swift 源文件添加到 Xcode 项目中。

3. 在导出的符号声明中添加以下前缀，以确保它们对 Dart 可见：

   C/C++/Objective-C

   objc

   extern "C" /* <= C++ only */ __attribute__((visibility("default"))) __attribute__((used))

   Swift

   swift

   @_cdecl("myFunctionName")

要链接到已编译的动态库，请使用以下说明：

1. 如果存在正确签名的 Framework 文件，请打开 Runner.xcworkspace。
2. 将框架文件添加到 Embedded Binaries 部分。
3. 同时将其添加到 Xcode 中目标的 Linked Frameworks & Libraries 部分。

要创建一个同时包含 C/C++/Objective-C 和 Dart 代码的 Flutter 插件，请使用以下说明：

1. 在你的插件项目中，打开 ios/<myproject>.podspec。
2. 将原生代码添加到 source_files 字段。

然后，原生代码将静态链接到使用此插件的任何应用的应用程序二进制文件中。

要创建一个包含 Dart 源代码但以二进制形式分发 C/C++ 库的 Flutter 插件，请使用以下说明：

1. 在你的插件项目中，打开 ios/<myproject>.podspec。
2. 添加一个 vendored_frameworks 字段。请参阅 CocoaPods 示例。

创建发布归档 (IPA) 时，符号会被 Xcode 剥离。

1. 在 Xcode 中，转到 Target Runner > Build Settings > Strip Style。
2. 将值从 All Symbols 更改为 Non-Global Symbols。

要了解更多关于 C 互操作性的信息，请查看以下视频

• Dart FFI 与 C 互操作性
• 如何使用 Dart FFI 构建复古音频播放器