Dart 调用C语言
本篇博客研究Dart语言如何调用C语言代码混合编程,最后我们实现一个简单示例,在C语言中编写简单加解密函数,使用dart调用并传入字符串,返回加密结果,调用解密函数,恢复字符串内容。
环境准备
编译器环境
如未安装过VS编译器,则推荐使用GCC编译器,下载一个64位Windows版本的GCC——MinGW-W64下载地址
如上,它有两个版本,sjlj和seh后缀表示异常处理模式,seh性能较好,但不支持 32位。sjlj稳定性好,可支持 32位,推荐下载seh版本
将编译器安装到指定的目录,完成安装后,还需要配置一下环境变量,将安装目录下的bin目录加入到系统Path环境变量中,bin目录下包含gcc.exe、make.exe等工具链。
测试环境配置完成后,检测一下环境是否搭建成功,打开cmd命令行,输入gcc -v能查看版本号则成功。
Dart SDK环境
去往Dart 官网下载最新的2.3 版本SDK,注意,旧版本不支持ffi下载地址
下载安装后,同样需要配置环境变量,将dart-sdk\bin配置到系统Path环境变量中。
测试Dartffi接口
简单示例
创建测试工程,打开cmd命令行
mkdir ffi-projcdffi-projmkdir bin src复制代码
创建工程目录ffi-proj,在其下创建bin、src文件夹,在bin中创建main.dart文件,在src中创建test.c文件
编写test.c我们在其中包含了windows头文件,用于showBox函数,调用Win32 API,创建一个对话框
#include<windows.h>intadd(inta,intb){returna + b;}voidshowBox(){ MessageBox(NULL,"Hello Dart","Title",MB_OK);}复制代码
进入src目录下,使用gcc编译器,将C语言代码编译为dll动态库
gcc test.c -shared -o test.dll复制代码
编写main.dart
import'dart:ffi'asffi;import'dart:io'show Platform;/// 根据C中的函数来定义方法签名(所谓方法签名,就是对一个方法或函数的描述,包括返回值类型,形参类型)/// 这里需要定义两个方法签名,一个是C语言中的,一个是转换为Dart之后的typedefNativeAddSign = ffi.Int32Function(ffi.Int32,ffi.Int32);typedefDartAddSign =intFunction(int,int);/// showBox函数方法签名typedefNativeShowSign = ffi.VoidFunction();typedefDartShowSign =voidFunction();voidmain(List args) {if(Platform.isWindows) {// 加载dll动态库ffi.DynamicLibrary dl = ffi.DynamicLibrary.open("../src/test.dll");// lookupFunction有两个作用,1、去动态库中查找指定的函数;2、将Native类型的C函数转化为Dart的Function类型varadd = dl.lookupFunction("add");varshowBox = dl.lookupFunction("showBox");// 调用add函数print(add(8,9));// 调用showBox函数showBox(); }}复制代码
深入用法
这里写一个稍微深入一点的示例,我们在C语言中写一个简单加密算法,然后使用dart调用C函数加密解密
编写encrypt_test.c,这里写一个最简单的异或加密算法,可以看到加密和解密实际上是一样的
#include #define KEY 'abc' void encrypt(char *str, char *r, int r_len){ int len = strlen(str); for(int i = 0; i < len && i < r_len; i++){ r[i] = str[i] ^ KEY; } if (r_len > len) r[len] = '\0'; else r[r_len] = '\0'; }void decrypt(char *str, char *r, int r_len){ int len = strlen(str); for(int i = 0; i < len && i < r_len; i++){ r[i] = str[i] ^ KEY; } if (r_len > len) r[len] = '\0'; else r[r_len] = '\0';}复制代码
编译为动态库
gcc encrypt_test.c -shared -o encrypt_test.dll复制代码
编写main.dart
import'dart:ffi';import'dart:io'show Platform;import"dart:convert";/// encrypt函数方法签名,注意,这里encrypt和decrypt的方法签名实际上是一样的,两个函数返回值类型和参数类型完全相同typedefNativeEncrypt = VoidFunction(CString,CString,Int32);typedefDartEncrypt =voidFunction(CString,CString,int);voidmain(List args) {if(Platform.isWindows) {// 加载dll动态库DynamicLibrary dl = DynamicLibrary.open("../src/encrypt_test.dll");varencrypt = dl.lookupFunction("encrypt");vardecrypt = dl.lookupFunction("decrypt"); CString data = CString.allocate("helloworld"); CString enResult = CString.malloc(100); encrypt(data,enResult,100);print(CString.fromUtf8(enResult));print("-------------------------"); CString deResult = CString.malloc(100); decrypt(enResult,deResult,100);print(CString.fromUtf8(deResult)); }}/// 创建一个类继承Pointer指针,用于处理C语言字符串和Dart字符串的映射classCStringextendsPointer{/// 申请内存空间,将Dart字符串转为C语言字符串factoryCString.allocate(StringdartStr) {List units = Utf8Encoder().convert(dartStr); Pointer str = allocate(count: units.length +1);for(inti =0; i < units.length; ++i) { str.elementAt(i).store(units[i]); } str.elementAt(units.length).store(0);returnstr.cast(); }// 申请指定大小的堆内存空间factoryCString.malloc(intsize) { Pointer str = allocate(count: size);returnstr.cast(); }/// 将C语言中的字符串转为Dart中的字符串staticStringfromUtf8(CString str) {if(str ==null)returnnull;intlen =0;while(str.elementAt(++len).load() !=0);List units =List(len);for(inti =0; i < len; ++i) units[i] = str.elementAt(i).load();returnUtf8Decoder().convert(units); }}复制代码
运行结果
可以看到将"helloworld"字符串加密后变成一串乱码,解密字符串后,恢复内容
完善代码
上述代码虽然实现了我们的目标,但是存在明显的内存泄露,我们使用CString
的allocate和malloc申请了堆内存,但是却没有手动释放,这样运行一段时间后可能会耗尽内存空间,手动管理内存往往是C/C++中最容易出问题的地方,这里我们只能进行一个简单的设计来回收内存
/// 创建Reference 类来跟踪CString申请的内存classReference{finalList> _allocations = []; T ref(T ptr) { _allocations.add(ptr.cast());returnptr; }// 使用完后手动释放内存voidfinalize() {for(finalptrin_allocations) { ptr.free(); } _allocations.clear(); }}复制代码
修改代码
import'dart:ffi';import'dart:io'show Platform;import"dart:convert";/// encrypt函数方法签名,注意,这里encrypt和decrypt的方法签名实际上是一样的,两个函数返回值类型和参数类型完全相同typedefNativeEncrypt = VoidFunction(CString,CString,Int32);typedefDartEncrypt =voidFunction(CString,CString,int);voidmain(List args) {if(Platform.isWindows) {// 加载dll动态库DynamicLibrary dl = DynamicLibrary.open("../src/hello.dll");varencrypt = dl.lookupFunction("encrypt");vardecrypt = dl.lookupFunction("decrypt");// 创建Reference 跟踪CStringReference ref = Reference(); CString data = CString.allocate("helloworld",ref); CString enResult = CString.malloc(100,ref); encrypt(data,enResult,100);print(CString.fromUtf8(enResult));print("-------------------------"); CString deResult = CString.malloc(100,ref); decrypt(enResult,deResult,100);print(CString.fromUtf8(deResult));// 用完后手动释放ref.finalize(); }}classCStringextendsPointer{/// 开辟内存控件,将Dart字符串转为C语言字符串factoryCString.allocate(StringdartStr, [Reference ref]) {List units = Utf8Encoder().convert(dartStr); Pointer str = allocate(count: units.length +1);for(inti =0; i < units.length; ++i) { str.elementAt(i).store(units[i]); } str.elementAt(units.length).store(0); ref?.ref(str);returnstr.cast(); }factoryCString.malloc(intsize, [Reference ref]) { Pointer str = allocate(count: size); ref?.ref(str);returnstr.cast(); }/// 将C语言中的字符串转为Dart中的字符串staticStringfromUtf8(CString str) {if(str ==null)returnnull;intlen =0;while(str.elementAt(++len).load() !=0);List units =List(len);for(inti =0; i < len; ++i) units[i] = str.elementAt(i).load();returnUtf8Decoder().convert(units); }}复制代码
总结
dart:ffi包目前正处理开发中,暂时释放的只有基础功能,且使用dart:ffi包后,Dart代码不能进行aot编译,不过Dart开发了ffi接口后,极大的扩展了dart语言的能力边界,就如同的Java的Jni一样,如果ffi接口开发得足够好用,Dart就能像Python那样成为一门真正的胶水语言。
大家如果有兴趣进一步研究,可以查看dart:ffi包源码,目前该包总共才5个dart文件,源码很少,适合学习。
参考资料:
http://www.developcls.com/qa/405b4a822f36458481346daf59ad6a90.html