内容
description bug_report

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

内容

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

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

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

动态链接与静态链接

原生库可以通过动态或静态方式链接到应用程序。静态链接的库嵌入到应用程序的可执行映像中，并在应用程序启动时加载。

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

相比之下，动态链接库分布在应用程序内的单独文件或文件夹中，并按需加载。在 iOS 上，动态链接库以 .framework 文件夹的形式进行分发。

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

API 文档可从 Dart 开发频道获取：Dart API 参考文档。

创建 FFI 插件

要创建名为“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 生成。

其他用例

iOS 和 macOS

应用程序启动时，动态链接库会自动由动态链接器加载。可以使用 DynamicLibrary.process 解析其组成符号。您还可以使用 DynamicLibrary.open 获取库的句柄，以限制符号解析的范围，但目前尚不清楚 Apple 的审核流程如何处理此问题。

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

平台库

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

  1. 在 Xcode 中，打开 Runner.xcworkspace。
  2. 选择目标平台。
  3. 在 链接框架和库 部分中，单击 +。
  4. 选择要链接的系统库。

第一方库

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

源代码

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

  1. 在 Xcode 中，打开 Runner.xcworkspace。
  2. 将 C/C++/Objective-C/Swift 源文件添加到 Xcode 项目。

  3. 将以下前缀添加到导出的符号声明中，以确保 Dart 可见这些声明

    C/C++/Objective-C

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

    Swift

    @_cdecl("myFunctionName")

已编译（动态）库

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

  1. 如果存在已正确签名的 Framework 文件，请打开 Runner.xcworkspace。
  2. 将框架文件添加到 嵌入式二进制文件 部分。
  3. 还将其添加到 Xcode 中目标的 链接框架和库 部分。

开源第三方库

若要创建同时包含 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 示例。

剥离 iOS 符号

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

  1. 在 Xcode 中，转到 目标 Runner > 构建设置 > 剥离样式。
  2. 从 所有符号 更改为 非全局符号。

其他资源

要深入了解 C 互操作性，请查看以下视频