Flutter ffi开发通过 ffigen 生成函数签名绑定

前言:

最近在入坑 flutter ffi(笔者目前对flutter dart也不是很了解),先从最难的啃,网上现在关于 ffi的文章很少,对于新手而言不太友好,更别说公开的视频教程,更是少之又少,我也是摸索了很久才入一点门道(太菜了,哥哥们谅解),这里不做任何技术上的指导,只是简简单单的入门。

分几个步骤来:

第一步:搭建flutter环境
第二步:创建flutter 新项目
第三步:引入 ffigen
第四步:引入 .h/.c 文件
第五步:使用 ffigen 生成dart上可执行的签名文件(dart语言不能直接调用c语言中的函数,类似 Android中的 jni,需要做下中转)
第六步:编译 C 代码为动态库
第七步:加载动态库并调用内部 C 函数
第八步:运行
总结


废话不多说,直接开干

一:搭建flutter ffigen所需环境

详细看这里:https://codelabs.developers.google.com/codelabs/flutter-ffigen?hl=zh-cn#0
(主要看:安装 LLVM,其它的看这篇文档)

二:创建flutter 新项目

通过命令行创建 或 Android Studio,Visual Studio Code 编译器创建都行

flutter create first_flutter_ffi_study_project
cd first_flutter_ffi_study_project
如果是通过模板生成的顶层 pubpsec.yaml 可能包含过时的 ffigen 软件包版本。运行以下命令,更新插件项目中的 Dart 依赖项:
$ flutter pub upgrade --major-versions

三:引入 ffigen

flutter pub add ffi
flutter pub add ffigen --dev
// pubspec.yaml
......
dependencies:
  ffi: ^2.1.3

.....

dev_dependencies:
  ffigen: ^15.0.0
......

四:引入 .h/.c 文件

在项目根目录创建 native 文件夹并新建 hello.h 和 hello.c 文件

mkdir native
cd native
touch hello.h
touch hello.c
// hello.h
#ifndef HELLO_H
#define HELLO_H

int sum(int a, int b);

#endif // HELLO_H
// hello.c
#include "hello.h"

int sum(int a, int b) {
    return a + b;
}

五:使用 ffigen 生成 dart 和 C 绑定的签名文件

首先,你需要编写一个 ffigen 配置文件。在项目的根目录下创建一个 ffigen.yaml 文件,内容如下:

name: FFIBinding
description: FFI bindings for the native library.
output: lib/src/ffi_bindings.dart

headers:
  entry-points:
    - 'native/hello.h'
  include-directives:
    - 'native/hello.h'

然后,在终端中运行 ffigen 命令生成 Dart 绑定:

flutter pub run ffigen --config ffigen.yaml

这会在 lib/src 目录下生成一个 ffi_bindings.dart 文件。

六:编译 C 代码为动态库

为了能够在 Dart 中调用 c语言中的函数,你需要先编译 C 代码为动态库。

在 macOS 上,导航到 native 文件夹,运行以下命令:(这将在 native 目录下生成 libhello.dylib 文件)

gcc -dynamiclib -o libhello.dylib hello.c

在 Windows 上,你可以使用 MinGW 或者 Visual Studio 的命令行工具来编译。
使用 MinGW
安装 MinGW,确保 gcc 在你的系统路径中。
打开终端,导航到 native 文件夹,运行以下命令:(这将在当前目录下生成 hello.dll 文件)

gcc -shared -o hello.dll hello.c

!!!Android 和 ios 这里后面再补充(待更新)

七:加载动态库并调用内部 C 函数

在 lib/main.dart 文件中导入生成的绑定文件,并调用 sum 函数:

import 'package:flutter/material.dart';
import 'dart:ffi'; // 导入 FFI 包
import 'src/ffi_bindings.dart' as bindings; // 导入生成的绑定文件

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('FFI Example')),
        body: Center(
          child: ElevatedButton(
            onPressed: () {
              // 加载动态库
              final DynamicLibrary nativeLib = DynamicLibrary.open('hello.dll'); // windows 使用 'hello.dll' 对于 macos,使用 'libhello.dylib'

              // 获取生成的绑定文件中的函数
              final sumFunction = bindings.FFIBinding(nativeLib).sum;

              // 调用函数
              final result = sumFunction(10, 20);
              print('Sum of 10 and 20 is $result');
            },
            child: Text('Call sum function'),
          ),
        ),
      ),
    );
  }
}

八:运行

flutter run

点击按钮后,你应该能在控制台看到输出:(至此已完成初步入门,然后再回顾下这几个要点)

Sum of 10 and 20 is 30

示例源码:点这里

总结:

通过上面的步骤,大致知道了,ffi 到底怎么开发,以及 ffigen 到底怎么使用,从量变到质变,加油少年!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容