Flutter 使用 Dart FFI 呼叫 C/C++ 函式

前言

我們在開發跨平台 Flutter APP 的時候，會依賴第三方套件進行實作。例如影像辨識會使用 OpenCV 所提供的影像處理方法，當然它有提供各種平台的動態連結庫提供 Linux、Windows、Andorid、iOS…等。然而在開發 Flutter 時可以直接透過 dart:ffi(foreign function interface) 呼叫原生的 C APIs。如此一來各種平台統一維護一份 C/C++ 程式碼即可，最後再由 ffi 去呼叫外部定義好的函式。關於 FFI 可以參考這篇文章，寫得蠻清楚的。

實作

這次範例透過建立一個 C++ BMI 計算的方法，讓 Flutter 呼叫並取得結果。

0. 建立專案

首先開啟 Android Studio 先建立一個空專案 flutter_native_c。

1. 建立 plugin

建立一個 Flutter plugin 名稱為 native_bmi 來專門管理與連結 C code。開啟終端機進入 flutter_native_c 資料夾後，輸入以下指令建立 Plugin。

flutter create --platforms=android,ios --template=plugin native_bmi

接著在 flutter_native_c 最外層專案下的 pubspec.yaml 添加相依套件： ffi 與剛建立的 plugin (native_bmi)。

dependencies:
  native_bmi:
    path: native_bmi
  ffi: ^2.0.1

2. 建立 C/C++ 檔案

將寫好的 C/C++ 放置在 native_bmi/ios/Classes 資料夾中，並命名為 native_bmi.cpp。我們在程式內加上 extern "C" 使系統函式庫兼容 C/C++，詳細內容可以參考這篇文章。簡單來說 g++ 在編譯 C++ 程式時，會對符號(變數與函數名稱等等)進行符號修飾(name mangling)，導致鏈接器在鏈接時找不到對應的符號名稱。若你是撰寫 C 且檔名為 XXX.c 就沒這問題了。

在這份 C++ 程式中建立了四個不同的函式，分別為：

取得年齡 getAge()
計算 BMI calculateBMI(double weight, double height)
- 需要傳入體種與身高回傳BMI計算結果
getResult(double weight, double height)
- 傳入體種與身高回傳文字評斷結果
getVersion()
- 取得版本號字串

#include <cmath>
using namespace std;

// Avoiding name mangling
extern "C" {

    int getAge(){
      return 25;
    }

    double calculateBMI(double weight, double height)
    {
      return weight / pow(height / 100, 2);
    }

    char *getResult(double weight, double height)
    {
        double _bmi = weight / pow(height / 100, 2);
        if (_bmi >= 25) {
          return "Overweight";
        } else if (_bmi > 18.5) {
          return "Normal";
        } else {
          return "Underweight";
        }
    }

    char *getVersion()
    {
        return "v1.0.0";
    }
}

剛剛步驟就已經完成 ios 的設定，接著在 Android 中也要去指向到那份 C++ 程式。在 native_bmi/android 手動建立 CMakeLists.txt，並指向到剛剛建立的 native_bmi.cpp。

cmake_minimum_required(VERSION 3.4.1)

add_library(
            native_bmi
            SHARED
            ../ios/Classes/native_bmi.cpp
)

接著在 native_bmi/android/build.gradle 中添加 cmake 路徑。

android {
  // ...
  externalNativeBuild {
    // Encapsulates your CMake build configurations.
    cmake {
      // Provides a relative path to your CMake build script.
      path "CMakeLists.txt"
    }
  }
  // ...
}

3. 使用 FFI 庫載入 Native code

在 flutter_native_c/lib 資料夾下建立 ffi_bridge.dart，並建立一個 FFIBridge 類別封裝。

DynamicLibrary 動態庫連結 (Android 與 iOS)。
建立 C & Dart function signatures
Flutter 建立函式透過 FFI 呼叫 Native code

完整程式碼：

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

/** C & Dart function signatures */
// 取得年齡(回傳整數)
typedef getAgeFunction = Int Function();
typedef getAgeFunctionDart = int Function();
// 計算 BMI 數值(回傳浮點)
typedef calculateBMIFunction = Double Function(Double weight, Double hight);
typedef calculateBMIFunctionDart = double Function(double weight, double hight);
// 評估結果(回傳字串)
typedef getResultFunction = Pointer<Int8> Function(Double weight, Double hight);
typedef getResultFunctionDart = Pointer<Int8> Function(
    double weight, double hight);
// 取得版本(回傳字串)
typedef getVersionFunction = Pointer<Int8> Function();
typedef getVersionFunctionDart = Pointer<Int8> Function();

/** 封裝 */
class FFIBridge {
  late getAgeFunctionDart _getAge;
  late calculateBMIFunctionDart _calculateBMI;
  late getResultFunctionDart _getResult;
  late getVersionFunctionDart _getVersion;

  FFIBridge() {
    // Getting a library
    final dl = Platform.isAndroid
        ? DynamicLibrary.open('libnative_bmi.so')
        : DynamicLibrary.process();
    // Looking for the functions
    _getAge = dl.lookupFunction<getAgeFunction, getAgeFunctionDart>('getAge');
    _calculateBMI =
        dl.lookupFunction<calculateBMIFunction, calculateBMIFunctionDart>(
            'calculateBMI');
    _getResult = dl
        .lookupFunction<getResultFunction, getResultFunctionDart>('getResult');
    _getVersion = dl.lookupFunction<getVersionFunction, getVersionFunctionDart>(
        'getVersion');
  }

  // Flutter 建立函式透過 FFI 呼叫 Native code
  int getAge() => _getAge();
  double calculateBMI() => _calculateBMI(50, 170);
  String getResult() => _getResult(50, 170).cast<Utf8>().toDartString();
  String getVersion() {
    return _getVersion().cast<Utf8>().toDartString();
  }
}

最後在 flutter_native_c/lib/main.dart 就能夠透過按鈕觸發並呼叫 Native code。詳細內容可以參考 GitHub，以下大致寫出關鍵內容呼叫取得年齡。

final FFIBridge _ffiBridge = FFIBridge();
_ffiBridge.getAge()

完整程式碼參考: GitHub

Reference

鼓勵持續創作，支持化讚為賞！透過下方的 Like 拍手👏，讓創作者獲得額外收入~

版主10在2020年首次開設YouTube頻道，嘗試拍攝程式教學。想要了解更多的朋友歡迎關注我的頻道，您的訂閱就是最大的支持～如果想學其他什麼內容也歡迎許願XD

https://www.youtube.com/channel/UCSNPCGvMYEV-yIXAVt3FA5A

1010Code