跳到主要内容

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

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

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

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

动态链接与静态链接

#

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

可以使用 DynamicLibrary.executableDynamicLibrary.process 加载来自静态链接库的符号。

相比之下,动态链接库则以单独的文件或文件夹的形式分发到应用中,并在需要时加载。在 Android 上,动态链接库作为一组 .so (ELF) 文件分发,每个架构一个。

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

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

在 Android 上,仅支持动态库(因为主可执行文件是 JVM,我们不会静态链接到它)。

创建 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))

在 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 大小(共享对象压缩)

#

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

Flutter APK 默认情况下不遵循这些指南,并压缩 libflutter.solibapp.so——这会导致较小的 APK 大小,但设备上的大小更大。

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

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 互操作性的更多信息,请查看以下视频