在 flutter 上使用 c 代码 - (二) 无源码的项目

写在前面, 对于无源码的项目, 理论上必须有头文件,不然你不知道里面都定义了什么鬼东西.

本篇虽然是写无源码的项目, 但实际上还是会有源码部分, 只是通过 cmake,clang,xcodebuild,ndk 等工具编译成 so/framework 以供 android/ios 引入

生成动态库

整体的目录结构是这样的, 如果你只是要引入库, 可以跳过这步, 这步的主要做源码生成库的步骤

$ tree -L 3 cpp-source
tree -L 3 cpp-source
cpp-source
├── android
│   ├── CMakeLists.txt
│   ├── build_android.sh
│   └── cmd
│       └── android.sh
├── ios
│   ├── CMakeLists.txt
│   ├── build_ios.sh
│   ├── cmd
│   │   └── ios_abi_build.sh
│   └── ios.toolchain.cmake
└── src
    ├── some.cpp
    └── some.h

src 为源码

some.cpp

#include "some.h"
#include <stdint.h>

extern "C" __attribute__((visibility("default"))) __attribute__((used)) int32_t
native_add(int32_t x, int32_t y) {
  return x + y;
}

android ios 分别对应平台的 Cmake 配置文件和打包脚本

打包 android

使用 Cmake 配置, 然后通过 ndk 完成这个步骤

CmakeLists.txt:

cmake_minimum_required (VERSION 2.6) # cmake version

project(SOME) # project name

set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${PROJECT_SOURCE_DIR}/../../android/libs/$ENV{ABI}) # set output path

aux_source_directory(${PROJECT_SOURCE_DIR}/../src SRC_FILES) # scan source code files

add_library(some SHARED ${SRC_FILES}) # add source code files to library, and set build type to dynamic library.

然后有两个打包脚本

主脚本, 负责循环 abi, 调用副脚本, 并且完成生成的步骤
副脚本, 根据 abi 执行 cmake, 并且完成 make 的过程

主脚本build_android.sh

rm -rf ./build
a="armeabi-v7a arm64-v8a x86 x86_64"
for abi in $a;
do
export ABI=$abi
sh cmd/android.sh
done

副脚本cmd/android.sh

export NDK_HOME=$(which adb)/../../ndk-bundle # or set to your ndk home

export MAKE_PATH=build/make-cache

export TARGET_ABI=$ABI

create_makefile() {
    cmake \
        -DANDROID_ABI=$TARGET_ABI \
        -DANDROID_PLATFORM=android-16 \
        -DCMAKE_BUILD_TYPE=release \
        -DANDROID_NDK=$NDK_HOME \
        -DCMAKE_TOOLCHAIN_FILE=$NDK_HOME/build/cmake/android.toolchain.cmake \
        -DANDROID_TOOLCHAIN=clang -B $MAKE_PATH -S .
}

create_makefile

cd $MAKE_PATH

make clean
make

只需要执行

cd cpp-source/android
./build_android.sh

就会生成对应的 so 文件

这里直接生成到插件的 libs 目录内了, 后续只需要引入即可, 引入的过程请看后面的引入篇

打包 ios

主要使用ios-cmake项目提供的脚本,配合cmake 和 xcodebuild 来完成打包这个步骤

两个脚本

build_ios.sh:

负责 cmake 和提供当前的 sdk 版本号, 调用副脚本完成打包 framework 的过程

并且将不同 abi 的二进制文件使用lipo进行合并操作

rm -fr build
mkdir build

cd build

cmake .. -G Xcode -DCMAKE_TOOLCHAIN_FILE=../ios.toolchain.cmake -DPLATFORM=OS64COMBINED
cmake --build . --config Release --target install

cd ..

DEVICE=$(xcodebuild -showsdks|grep "iphoneos"| awk '{print $4}')
ABI=$DEVICE sh cmd/ios_abi_build.sh

SIMU=$(xcodebuild -showsdks|grep "iphonesimulator"| awk '{print $6}')
ABI=$SIMU sh cmd/ios_abi_build.sh

cd build/output
cp -rf $DEVICE fat
lipo -create $DEVICE/Release/some.framework/some $SIMU/Release/some.framework/some -output fat/Release/some.framework/some

cd ../..

cp -rf build/output/fat/Release/some.framework ../../ios

cmd/ios_abi_build.sh:

负责调用xcodebuild 完成构建 framework 的过程

echo "build ios $ABI"
cd build

cmake .. -G Xcode -DCMAKE_TOOLCHAIN_FILE=../ios.toolchain.cmake -DPLATFORM=OS64COMBINED
cmake --build . --config Release --target install

# xcodebuild -project SOME.xcodeproj -configuration Release -sdk $ABI -alltargets clean build
xcodebuild OTHER_CFLAGS="-fembed-bitcode" -project SOME.xcodeproj -configuration Release -sdk $ABI -alltargets clean build CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO

只需要执行下面的命令即可打出一个 fat 的包给模拟器和真机同时可用

cd cpp-source/ios
./build_ios.sh

插件项目

现在开始, 假装没有源码, 只有 so 和 framework

android

因为 so 是分 abi 在 libs 目录下的, 而 so 库的默认目录应该是 jniLibs 目录

所以需要修改 gradle 以引入 so 库

android/build.gradle

android {
    // ...
    sourceSets{
        // ...
        main.jniLibs.srcDirs = ['libs']
    }
}

这样就完成了 so 库引入的过程

ios

修改flutter_no_cpp_src.podspec

s.vendored_frameworks = 'some.framework'

这样就完成了 ios 库的引入

dart

import 'dart:async';

import 'package:flutter/services.dart';
import 'dart:ffi'; // For FFI
import 'dart:io'; // For Platform.isX

final DynamicLibrary nativeAddLib = Platform.isAndroid
    ? DynamicLibrary.open("libsome.so")
    : DynamicLibrary.open("some.framework/some");

final int Function(int x, int y) nativeAdd = nativeAddLib
    .lookup<NativeFunction<Int32 Function(Int32, Int32)>>("native_add")
    .asFunction();

这样nativeAdd方法就是调用前面的c++方法来完成 a+b 的过程