我们使用node-ffi来帮助我们调用动态链接库。
FFI的全称是Foreign Function Interface,该项目生来就是解决NodeJS的本地调用问题的,其流程就相当于Windows下的LoadLibrary()和GetProcAddress(),亦可以理解为NodeJS下的平台调用。为了调用一个小小的本地函数而创建一个addon实在是有点过头了,这个时候,FFI这把杀鸡刀就顺手得多了。有了它,本地调用变得异常简单,因为它在NodeJS环境中为JavaScript提供了一套强大的工具集用来调用动态链接库。
notice: 本人的node使用环境是64bit的Linux系统。 安装ffi:
npm install -g node-gyp
,装之前要安装python 2.7,而node-gyp不支持Python 3.x,所以安装了多个版本Python的读者得留意一下自己当前的Python版本了。Linux下pythonbrew一键搞定,Windows下还得去改环境变量。并且,如果你使用的node.js版本是4.0+,node-gyp的安装依赖支持C++11语法的gcc,你需要确定当前环境的gcc版本至少高于4.8。npm install ffi
注意事项!
.so
文件,在windows下build成.dll
文件。本文只阐述.so文件的调用方法,调用.dll差别不大。这里就不演示利用node-gyp将.cc文件生成.node文件了,一般我都是找后台同学帮我把C源码文件编译成.so文件,然后直接拿过来用!哈哈哈! 这个栗子是nodejs调用C接口发送短信,这个C的API也非常简单:
int send_msg(char * phone, char * content)
参数是手机号和短信内容,类型都是char *
,返回的retcode是一个整型,返回0就代表发送成功,其他就是失败,方法名是send_msg。下面是如果利用ffi在nodejs中调用这个接口,该接口的源码已经被封装成libsend_msg.so这个动态链接库了,我们直接调用就好。
'use strict'
/**
* 短信下发服务模块
* 由于项目是使用node 5.0+,所以安装node-ffi模块需要依赖gcc 4.8+以上版本
*/
var ffi = require('ffi');
// int send_msg(char * phone, char * content)
var libm = ffi.Library(__dirname + '/msgQ/libsend_msg', {
'send_msg': ['int', ['string', 'string']]
});
let smsExport = {
sendMsg(opt) {
let phone = opt.phone;
let content = opt.text;
// 调用c接口,发送短信
let retcode = libm.send_msg(phone, content);
if (retcode === 0) {
// TODO succ
} else {
// TODO fail
}
}
};
module.exports = smsExport;
可以看到,在使用ffi调用C接口传参时,C的char *
类型在nodejs源码中可以直接用string
类型表示,而对于nodejs没有的int
类型,我们也可以直接写成int
。并且可以看出来,这里我们使用同步的方式调用send_msg方法的。
上面这个栗子非常简单,主要是简单在传参和出参的类型。由于javascript和C这两种语言的基本类型并不能完全对齐,所以有时候在调用的时候,对于传参出参的处理比较麻烦。经常遇到的一个问题就是如何在JS中针对C的指针类型进行操作。 例如有5个C接口如下:
double do_some_number_fudging(double a, int b);
myobj * create_object();
double do_stuff_with_object(myobj *obj);
void use_string_with_object(myobj *obj, char *value);
void delete_object(myobj *obj);
可以看到这些接口,有的方法的出参是一个指向object类型的指针,有的入参是一个指向object类型的指针,如果使用C语言调用这5个接口,可能会是这样:
#include "mylibrary.h"
int main()
{
myobj *fun_object;
double res, fun;
res = do_some_number_fudging(1.5, 5);
fun_object = create_object();
if (fun_object == NULL) {
printf("Oh no! Couldn't create object!\n");
exit(2);
}
use_string_with_object(fun_object, "Hello World!");
fun = do_stuff_with_object(fun_object);
delete_object(fun_object);
}
那用JS如何调用这些接口呢?我们先使用ffi
来包装一下这些接口:
var ref = require("ref");
var ffi = require("ffi");
// typedefs
var myobj = ref.types.void // 仅仅只是用来演示如何用ref创建C语言中的类型,由于我们这里不知道myobj将来会是啥类型,所以先定义成void类型
var MyLibrary = ffi.Library('libmylibrary', {
"do_some_number_fudging": [ 'double', [ 'double', 'int' ] ],
"create_object": [ "pointer", [] ],
"do_stuff_with_object": [ "double", [ "pointer" ] ],
"use_string_with_object": [ "void", [ "pointer", "string" ] ],
"delete_object": [ "void", [ "pointer" ] ]
});
好啦,下面编写JS代码来调用这些接口:
var res = MyLibrary.do_some_number_fudging(1.5, 5); // 单纯的计算
var fun_object = MyLibrary.create_object(); // 调用接口,创建一个指向object类型的指针
if (fun_object.isNull()) {
console.log("Oh no! Couldn't create object!\n");
} else {
// 将刚刚创建的指针作为入参传入其他方法。
MyLibrary.use_string_with_object(fun_object, "Hello World!");
var fun = MyLibrary.do_stuff_with_object(fun_object);
MyLibrary.delete_object(fun_object); // 使用完之后记得调用C接口释放指针指向的内存
}
有时候,有时候,我会相信一切有尽头,相爱分离都有时候,没有什么会永垂不朽。。。 不对,跑偏了。有时候,我们会把一个指针作为入参传给一个C接口,接口方法执行完之后会给这个指针指向的内存地址赋值,那么我们如何把这个值取出来呢?下面给出一个栗子。 C接口:
void* xyz_create(int id, unsigned int network_timeout_ms, float something_timeout_s);
int xyz_get(int id, void *obj, const char *key, char **val, int *something);
int xyz_set(int id, void *obj, const char *key, const char *val, int *something);
void xyz_destroy(void *obj);
void xyz_free(char *p);
用ffi
包装C接口生成的动态链接库,并使用ref
进行一些类型映射。
'use strict'
const ref = require("ref");
const ffi = require("ffi");
// 生成兼容C的指向string类型的指针,即char**
let stringPointer = ref.refType(ref.types.CString);
let libxyz = ffi.Library(__dirname + '/so/example.so', {
'xyz_create': ['pointer', ['int', 'uint', 'float']],
'xyz_get': ['int', ['int', 'pointer', 'string', stringPointer, 'int *']],
'xyz_set': ['int', ['int', 'pointer', 'string', 'string', 'int *']],
'xyz_destroy': ['void', ['pointer']],
'xyz_free': ['void', ['string']]
});
使用JS调用C接口:
'use strict'
let id = 123;
let network_timeout_ms = 3000;
let something_timeout_s = 0.3;
let obj = libxyz .xyz_create(id , config.cmdid, network_timeout_ms, something_timeout_s); // 调用C接口创建一个指针
if (obj .isNull()) {
console.log("Oh no! Couldn't create object!\n");
} else {
let pointerSomething= ref.alloc(ref.types.int, 666); // something的值,固定为666,将js中的number类型转化成C中的int *
let key = 'key';
let value = 'value';
let retcode = libxyz.cmem_set(id , obj, key, value , pointerSomething);
if(retcode === 0) {
let val2 = ref.alloc('string'); // 声明一个char **类型的指针,即指向string的指针
// 如果设置key/value成功,我们可以利用key取出刚刚设置的value值,并进行比较,看看有木有设置正确。取出来的值,是存在val2这个值里面的,但val2是一个指向string的指针类型,我们来看看如何取出val2的值,并与value进行比较。
let getRetcode = libcmem.cmem_get(config.bid, obj, key, val2, pointerSomething);
if(getRetcode === 0) {
if(value === ref.readPointer(val2, 0, value.length)) {
console.log('set value succ!');
}
} else {
console.log('get value failed!');
}
} else {
console.log('set key/value failed!');
}
}
关于ref的详细api可以参看他们的官方文档:https://github.com/TooTallNate/ref
值得一提的是,还有一个名为edge.js的开源项目,整个流程和FFI类似,不过支持调用C#、Python,相当有意思。这样一来,NodeJS相当于可以用C/C++、C#、Python扩展了,潜力无限啊。当然,你可以说我直接拿其它语言写程序然后NodeJS里fork()就好了,不过其灵活性显然是不如以上思路的。