Flutter插件custospackagetest入门指南

入门指南

此项目是一个用于 Flutter 的 FFI 插件 起点，这是一种包含本地代码并通过 Dart FFI 直接调用的特殊包。

项目结构

该项目使用以下结构：

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

构建和捆绑本地代码

在 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/custospackagetest.podspec
  • 查看文档：macos/custospackagetest.podspec
• Linux 和 Windows: CMake。
  • 查看文档：linux/CMakeLists.txt
  • 查看文档：windows/CMakeLists.txt

绑定到本地代码

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

重新生成绑定的命令如下：

flutter pub run ffigen --config ffigen.yaml

调用本地代码

运行时间较短的本地函数可以直接从任何隔离区调用。例如，查看 lib/custospackagetest.dart 中的 sum 函数。

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

示例代码

以下是完整的示例代码，展示如何使用 custospackagetest 插件：

示例代码

example/lib/main.dart

import 'package:flutter/material.dart';
import 'dart:async';

import 'package:custospackagetest/custospackagetest.dart' as custospackagetest;

void main() {
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  late int sumResult; // 存储同步结果
  late Future<int> sumAsyncResult; // 存储异步结果

  [@override](/user/override)
  void initState() {
    super.initState();
    sumResult = custospackagetest.sum(1, 2); // 调用同步方法
    sumAsyncResult = custospackagetest.sumAsync(3, 4); // 调用异步方法
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    const textStyle = TextStyle(fontSize: 25);
    const spacerSmall = SizedBox(height: 10);

    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Native Packages'),
        ),
        body: SingleChildScrollView(
          child: Container(
            padding: const EdgeInsets.all(10),
            child: Column(
              children: [
                const Text(
                  '此代码通过 FFI 调用本地函数，该函数作为源代码随包一起分发。'
                  '本地代码作为 Flutter Runner 构建的一部分进行构建。',
                  style: textStyle,
                  textAlign: TextAlign.center,
                ),
                spacerSmall,
                Text(
                  'sum(1, 2) = $sumResult',
                  style: textStyle,
                  textAlign: TextAlign.center,
                ),
                spacerSmall,
                FutureBuilder<int>(
                  future: sumAsyncResult,
                  builder: (BuildContext context, AsyncSnapshot<int> value) {
                    final displayValue = (value.hasData) ? value.data : '加载中...';
                    return Text(
                      'await sumAsync(3, 4) = $displayValue',
                      style: textStyle,
                      textAlign: TextAlign.center,
                    );
                  },
                ),
              ],
            ),
          ),
        ),
      ),
    );
  }
}