跳到正文
教程首页
Dart + FFICH 10ch10_ffi

ch10-ffi

FFI 实战:用 dart:ffi 调用 C / Rust / Go 原生库。完整工程共 22 个文件,其中 22 个文本源文件可在下面在线阅读。

22

在线文本文件

1,514

源码行数

dart / go / c

语言

22 KB

打包体积

在线阅读源码

左侧按目录浏览,点击文件切换。右上角可复制代码、复制路径或单独下载文件。在线视图只覆盖文本源码,完整工程请下载 zip。

darttextcrustmarkdown

22 text files · 1,514 lines

dartlib/bindings/c_bindings.dart
/// C 动态库(libadd_c.so / .dylib / .dll)的绑定。
///
/// 这里用**手写绑定**,为的是把 ABI 细节讲清楚:
///   - lookupFunction 把符号地址变成 Dart 函数(原生签名 → Dart 签名);
///   - 每个参数/返回值都要有明确的 C 类型(`Int32` / `Double` / `Pointer<Utf8>`);
///   - 回调要声明成 `Pointer<NativeFunction<...>>`。
///
/// 工程里符号多了以后应该用 `ffigen` 从 `add.h` 生成(见 `ffigen.yaml`),
/// 手写版适合理解原理。
library;

import 'dart:ffi';

import 'package:ffi/ffi.dart';

import '../add_library.dart';
import '../loader.dart';

typedef AddI32Native = Int32 Function(Int32 a, Int32 b);
typedef AddI32Dart = int Function(int a, int b);

typedef MulF64Native = Double Function(Double a, Double b);
typedef MulF64Dart = double Function(double a, double b);

typedef ConcatNative = Pointer<Utf8> Function(Pointer<Utf8> a, Pointer<Utf8> b);
typedef ConcatDart = Pointer<Utf8> Function(Pointer<Utf8> a, Pointer<Utf8> b);

typedef FreeStringNative = Void Function(Pointer<Utf8> s);
typedef FreeStringDart = void Function(Pointer<Utf8> s);

typedef ApplyCbNative = Int32 Function(
    Pointer<NativeFunction<Int32 Function(Int32)>> cb, Int32 x);
typedef ApplyCbDart = int Function(
    Pointer<NativeFunction<Int32 Function(Int32)>> cb, int x);

class CLibrary implements AddLibrary {
  CLibrary._(DynamicLibrary lib)
      : _addI32 = lib.lookupFunction<AddI32Native, AddI32Dart>('add_i32'),
        _mulF64 = lib.lookupFunction<MulF64Native, MulF64Dart>('mul_f64'),
        _concat = lib.lookupFunction<ConcatNative, ConcatDart>('concat_strings'),
        _freeString = lib.lookupFunction<FreeStringNative, FreeStringDart>('free_string'),
        _applyCb = lib.lookupFunction<ApplyCbNative, ApplyCbDart>('apply_cb');

  /// 打开 `libadd_c` 并解析全部符号。
  factory CLibrary.open() => CLibrary._(NativeLoader.open('add_c'));

  final AddI32Dart _addI32;
  final MulF64Dart _mulF64;
  final ConcatDart _concat;
  final FreeStringDart _freeString;
  final ApplyCbDart _applyCb;

  @override
  String get language => 'C';

  @override
  int addI32(int a, int b) => _addI32(a, b);

  @override
  double mulF64(double a, double b) => _mulF64(a, b);

  @override
  String concat(String a, String b) {
    // toNativeUtf8() 用的是 calloc,必须由调用方 free —— 谁分配谁释放。
    final Pointer<Utf8> pa = a.toNativeUtf8();
    final Pointer<Utf8> pb = b.toNativeUtf8();
    Pointer<Utf8> result = nullptr;
    try {
      result = _concat(pa, pb);
      if (result == nullptr) {
        throw StateError('C concat_strings 返回了 NULL');
      }
      // toDartString() 会复制一份 Dart 字符串,之后才能安全释放原生内存。
      return result.toDartString();
    } finally {
      calloc.free(pa);
      calloc.free(pb);
      if (result != nullptr) _freeString(result);
    }
  }

  @override
  int applyCallback(int Function(int x) fn, int x) {
    // 同步回调必须用 isolateLocal:原生代码在当前线程直接调用它,要求
    // 「有返回值 + 同步执行」。listener 版本只能返回 void(它把调用排进事件队列)。
    // close() 之前必须保证原生侧不再持有它,否则就是 use-after-free。
    final NativeCallable<Int32 Function(Int32)> cb =
        NativeCallable<Int32 Function(Int32)>.isolateLocal(
      (int v) => fn(v),
      exceptionalReturn: -1, // 回调里抛异常时返回给原生侧的值
    );
    try {
      return _applyCb(cb.nativeFunction, x);
    } finally {
      cb.close();
    }
  }
}

代码构成:dart 24 KB · text 14 KB · c 2 KB · rust 2 KB

本地运行

zip → 解压 → 执行
$cd examples/ch10-ffi/native && ./build_all.sh
$cd examples/ch10-ffi && dart pub get && dart run

这个 zip 里有什么

  • • 完整工程目录(含 Android / iOS / 桌面平台脚手架)
  • • lib / bin / test / native 全部源码与测试
  • • pubspec.yaml、锁文件与平台配置文件
  • • 已排除 .dart_tool / build / target / ephemeral 等构建产物

已验证

  • dart analyze 0 告警、dart test 18 个用例全绿(C 手写绑定 / C ffigen 生成绑定 / Rust / Go)
查看全部示例