Flutter性能优化插件vroom的使用

vroom

vroom 是一个新的 Flutter FFI 插件项目。

使用步骤

1. 项目结构

vroom 模板使用以下结构：

.
├── android/
│   └── build.gradle
├── ios/
│   └── vroom.podspec
├── lib/
│   ├── vroom.dart
│   └── vroom.g.dart
├── linux/
│   └── CMakeLists.txt
├── src/
│   ├── vroom.h
│   └── vroom.c
├── windows/
│   └── CMakeLists.txt
└── pubspec.yaml

• src: 包含本地源代码和用于构建动态库的 CmakeFile.txt 文件。
• lib: 包含定义插件 API 的 Dart 代码，并使用 dart:ffi 调用本地代码。
• 平台文件夹 (android, ios, windows 等): 包含用于将本地代码库与平台应用程序一起构建和捆绑的构建文件。

2. 构建和捆绑本地代码

在 pubspec.yaml 中指定 FFI 插件配置如下：

plugin:
  platforms:
    some_platform:
      ffiPlugin: true

此配置会针对各个目标平台调用本地构建，并将二进制文件捆绑到使用这些 FFI 插件的 Flutter 应用程序中。

可以结合 dartPluginClass 使用，例如当 FFI 用于联邦插件的一个平台实现时：

plugin:
  implements: some_other_plugin
  platforms:
    some_platform:
      dartPluginClass: SomeClass
      ffiPlugin: true

插件可以同时具有 FFI 和方法通道：

plugin:
  platforms:
    some_platform:
      pluginClass: SomeName
      ffiPlugin: true

FFI（和方法通道）插件调用的本地构建系统如下：

• Android: Gradle，它通过 Android NDK 进行本地构建。
  • 查看 android/build.gradle 文档。
• iOS 和 MacOS: Xcode，通过 CocoaPods。
  • 查看 ios/vroom.podspec 文档。
  • 查看 macos/vroom.podspec 文档。
• Linux 和 Windows: CMake。
  • 查看 linux/CMakeLists.txt 文档。
  • 查看 windows/CMakeLists.txt 文档。

3. 绑定到本地代码

要使用本地代码，Dart 需要绑定。为了避免手动编写这些绑定，它们是从头文件 (src/vroom.h) 生成的，使用的是 package:ffigen。

重新生成绑定的方法如下：

flutter pub run ffigen --config ffigen.yaml

4. 调用本地代码

非常短的本地函数可以直接从任何隔离区调用。例如，查看 lib/vroom.dart 中的 sum 函数。

较长运行的函数应在辅助隔离区调用，以避免在 Flutter 应用程序中丢帧。例如，查看 lib/vroom.dart 中的 sumAsync 函数。

示例代码

lib/vroom.dart

import 'dart:ffi';
import 'package:ffi/ffi.dart';

// 加载动态库
final DynamicLibrary _nativeLib = Platform.isWindows
    ? DynamicLibrary.process()
    : DynamicLibrary.open("libvroom.so");

// 定义本地函数的签名
typedef SumNative = Int32 Function(Int32 a, Int32 b);
final sumNative = _nativeLib
    .lookup<NativeFunction<SumNative>>('sum')
    .asFunction<int Function(int, int)>();

// 定义异步本地函数的签名
typedef SumAsyncNative = Void Function(Pointer<Int32> result, Int32 a, Int32 b);
final sumAsyncNative = _nativeLib
    .lookup<NativeFunction<SumAsyncNative>>('sumAsync')
    .asFunction<void Function(Pointer<Int32>, int, int)>();

// 调用本地函数
int sum(int a, int b) {
  return sumNative(a, b);
}

// 异步调用本地函数
Future<int> sumAsync(int a, int b) async {
  final result = allocate<Int32>();
  sumAsyncNative(result, a, b);
  final value = result.value;
  free(result);
  return value;
}

src/vroom.h

#ifndef VROOM_H
#define VROOM_H

#include <stdint.h>

// 定义本地函数
int32_t sum(int32_t a, int32_t b);

// 定义异步本地函数
void sumAsync(int32_t* result, int32_t a, int32_t b);

#endif // VROOM_H

src/vroom.c

#include "vroom.h"

// 实现本地函数
int32_t sum(int32_t a, int32_t b) {
  return a + b;
}

// 实现异步本地函数
void sumAsync(int32_t* result, int32_t a, int32_t b) {
  *result = a + b;
}