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

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

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

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

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

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

相比之下，动态链接库以单独的文件或文件夹形式在应用内分发，并按需加载。在 Android 上，动态链接库以一组 .so (ELF) 文件形式分发，每个架构对应一个。

动态链接库可以通过 DynamicLibrary.open 加载到 Dart 中。

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

在 Android 上，仅支持动态库（因为主可执行文件是 JVM，我们不进行静态链接）。

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

在 Android 上，native_add/android/build.gradle 链接代码。

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

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

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

1. 在 Android 文档的 Android NDK 原生 API 列表中查找所需的库。此列表列出了稳定的原生 API。

2. 使用 DynamicLibrary.open 加载库。例如，加载 OpenGL ES (v3)

   dart

   DynamicLibrary.open('libGLES_v3.so');

如果文档中有所指示，您可能需要更新应用或插件的 Android 清单文件。

在应用或插件中以源代码或二进制形式包含原生代码的过程是相同的。

请遵循 Android 文档中的 向您的项目添加 C 和 C++ 代码 指南，以添加原生代码并支持原生代码工具链（无论是 CMake 还是 ndk-build）。

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

1. 打开您项目的 android/build.gradle 文件。
2. 添加 AAR 工件作为依赖项。不要将该工件包含在您的 Flutter 包中。相反，它应该从仓库下载，例如 JCenter。

Android 指南通常建议分发未压缩的原生共享对象，因为这实际上可以节省设备空间。共享对象可以直接从 APK 加载，而无需在设备上解压到临时位置然后再加载。APK 在传输过程中会额外打包——这就是您应该关注下载大小的原因。

Flutter APK 默认不遵循这些指南，并压缩 libflutter.so 和 libapp.so——这会导致 APK 大小更小，但设备上占用空间更大。

第三方共享对象可以在其 AndroidManifest.xml 中使用 android:extractNativeLibs="true" 更改此默认设置，并停止压缩 libflutter.so、libapp.so 以及任何用户添加的共享对象。要重新启用压缩，请按以下方式覆盖 your_app_name/android/app/src/main/AndroidManifest.xml 中的设置。

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.your_app_name">
    xmlns:tools="http://schemas.android.com/tools"
    package="com.example.your_app_name" >
    <!-- io.flutter.app.FlutterApplication is an android.app.Application that
         calls FlutterMain.startInitialization(this); in its onCreate method.
         In most cases you can leave this as-is, but you if you want to provide
         additional functionality it is fine to subclass or reimplement
         FlutterApplication and put your custom class here. -->

    <application
        android:name="io.flutter.app.FlutterApplication"
        android:label="your_app_name"
        android:icon="@mipmap/ic_launcher">
        android:icon="@mipmap/ic_launcher"
        android:extractNativeLibs="true"
        tools:replace="android:extractNativeLibs">

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

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