通过ffi在nodejs中调用动态链接库(.so文件)

通过ffi在node.js中调用动态链接库(.so/.dll文件)

概述

为什么要在node.js中调用动态链接库

1. 由于腾讯体系下的许多公共的后台服务(L5, CKV, msgQ等)已经有了非常成熟的C/C++编写的API，以供应用程序调用，node.js作为在公司内新兴的后台runtime在调用这些公共服务的时候没必要再造一遍轮子，而是可以将这些API编译成.so文件直接使用。
2. 对于一些密集计算型的任务可以由C++编写好模块，生成.so文件后由node.js调用。

ffi简介与安装

我们使用node-ffi来帮助我们调用动态链接库。

FFI的全称是Foreign Function Interface，该项目生来就是解决NodeJS的本地调用问题的，其流程就相当于Windows下的LoadLibrary()和GetProcAddress()，亦可以理解为NodeJS下的平台调用。为了调用一个小小的本地函数而创建一个addon实在是有点过头了，这个时候，FFI这把杀鸡刀就顺手得多了。有了它，本地调用变得异常简单，因为它在NodeJS环境中为JavaScript提供了一套强大的工具集用来调用动态链接库。

notice: 本人的node使用环境是64bit的Linux系统。
安装ffi：
1. 全局或局部安装node-gyp: 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。
2. 安装ffi：npm install ffi

注意事项！

• ffi只能调用C风格的模块。
• 需要将C源码build成动态链接库以供调用，在Linux下将C源码build成.so文件，在windows下build成.dll文件。本文只阐述.so文件的调用方法，调用.dll差别不大。
• 在Linux下如果使用C++编写的addon来调用.so文件，需要将.so文件为系统共享。具体方法可以参看ldconfig命令，这是一个Linux下的动态链接库管理命令。ldconfig命令的主要用途是在默认搜寻目录(/lib和/usr/lib)以及动态库配置文件/etc/ld.so.conf内所列的目录下，搜索出可共享的动态链接库(格式如lib*.so*)，进而创建出动态装入程序(ld.so)所需的连接和缓存文件。缓存文件默认为 /etc/ld.so.cache，此文件保存已排好序的动态链接库名字列表。ldconfig通常在系统启动时运行，而当用户安装了一个新的动态链接库时，就需要手工运行这个命令。

煎蛋栗子

这里就不演示利用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方法的。

获取C接口的指针内容

上面这个栗子非常简单，主要是简单在传参和出参的类型。由于javascript和C这两种语言的基本类型并不能完全对齐，所以有时候在调用的时候，对于传参出参的处理比较麻烦。

异步调用

实际案例

值得一提的是，还有一个名为edge.js的开源项目，整个流程和FFI类似，不过支持调用C#、Python，相当有意思。这样一来，NodeJS相当于可以用C/C++、C#、Python扩展了，潜力无限啊。当然，你可以说我直接拿其它语言写程序然后NodeJS里fork()就好了，不过其灵活性显然是不如以上思路的。