阅读 4795

Nodejs如何调用Dll模块

  • 苏格团队
  • 作者:Tomey

一、为什么需要用node.js调用dll?

公司项目采用Electron( electronjs.org/ )开发pc应用,会涉及到与底层硬件设备的通信,而sdk封装 基本上都是通过 C++ 动态链接库dll实现的。

有两种方案可供选择:

  • 方案一: 使用node-ffi
  • 方案二: 使用C++编写一个node addon,通过LoadLibrary调用dll

以上两种方案都可以解决dll调用问题,方案选型要个人对C++ 的掌握程度,如果熟悉C++开发,可以直接选择方案二最方便。如果完全不了解C++,那么只能采用方案一。

由于笔主不太懂C++,最终选择第一种方案。

二、什么是node-ffi?

www.npmjs.com/package/ffi…

node-ffi是使用纯JavaScript加载和调用动态库的node addon,它可以用来在不写任何C++代码的情况下调用动态链接库的API 接口。

ffi究竟干了什么?其实它本质上还是一个编译后的Node addon,node_modules/ffi/build/Release/ffi_bindings.node, ffi_bindings.node就是一个addon ffi充当了nodejs和dll之间的桥梁。

下面是一个简单的加载dll的demo实例:

var ffi = require('ffi');
var libpath = path.join(_dirname, '/test.dll');
var testLib = ffi.Library(libpath, {
	'start': ['bool', ['bool']]
});

testLib.start(true); // true
复制代码

三、安装node-ffi

npm install ffi
复制代码

如果本地没有安装编译node addon的环境会报错,如下图所示

image

无论是使用ffi,还是直接写node addon,都缺少不了编译node Addon这个步骤,要编译node addon,有两种方法:

1、node-gyp(www.npmjs.com/package/nod…)。

npm install node-gyp
复制代码

具体安装参考:github.com/nodejs/node…

总结来说需要以下四点:

  • python 2.7-3.0版本之间 (推荐装v2.7,v3.x.x是不支持的)
  • NET Framework 4.5.1
  • Visual C++编译工具 (在windows中是不需要安装VS,如果自己安装例如VS2015,导致编译报错error MSB4132: The tools version "2.0" is unrecognized. Available tools versions are "4.0".这个问题,说明没有装好编译器,又或者编译器没有被正确地识别, node-gyp的文档建议使用npm config set msvs_version 2015, 但是有些机器即使这样设置了也无效,需要手动设置msvs_version, 应该这样写: node-gyp rebuild --msvs_version=2015。如果因为安装了VS2015导致无法正常编译,可直接恢复到安装VS之前的还原点)
  • 环境变量配置。(注:python安装位置需要添加到环境变量)

2、electron-rebuild(www.npmjs.com/package/ele…

如果采用electron开发应用程序,electron同样也支持node原生模块,但由于和官方的node 相比使用了不同的 V8 引擎,如果你想编译原生模块,则需要手动设置electron的headers的位置。

electron-rebuild为多个版本的node和electron提供了一种简单发布预编译二进制原生模块的方法。 它可以重建electron模块,识别当前electron版本,帮你自动完成了下载 headers、编译原生模块等步骤。 一个下载 electron-rebuild 并重新编译的例子:

npm install --save-dev electron-rebuild
  
# 每次运行"npm install"时,也运行这条命令
./node_modules/.bin/electron-rebuild

# 在windows下如果上述命令遇到了问题,尝试这个:
.\node_modules\.bin\electron-rebuild.cmd
复制代码

详情请看 electronjs.org/docs/tutori…

这里需要注意nodejs版本问题,nodejs平台必须跟dll保持一致,同样是32位或者64位,如果两者不一致,会导致调用dll失败。

成功安装ffi模块之后,就可以开始我们下面的ffi调用dll的实例应用。

四、应用举例

在开发需求中,需要调用基于C++编写的TCP数据转发服务的SDK。

首先我们来看一下dll头文件接口声明的代码如下:

#ifndef JS_CONNECTION_SDK
#define JS_CONNECTION_SDK


#ifdef JS_SDK
#define C_EXPORT __declspec(dllexport)
#else
#define C_EXPORT __declspec(dllimport)
#endif


extern "C"
{
    typedef void(*ReceiveCallback) (int cmd, int seq, const char *data);

    /*设置读取数据回调*/
    C_EXPORT void _cdecl SetReceiveCallback(ReceiveCallback callback);

    /*
    *设置option
    */
    C_EXPORT void _cdecl SetOption(
        const char* appKey, 
        const char* tk,
        int lc, 
        int rm
    );

    /*
    *创建连接
    */
    C_EXPORT bool _cdecl CreateConnection();

    /*发送数据*/
    C_EXPORT bool _cdecl SendData(int cmd, int seq, const char *data, unsigned int len);

    /*释放连接*/
    C_EXPORT void _cdecl ReleaseConnection();
}

#endif

复制代码

ffi调用dll模块封装,代码如下:

try {
	const ffi = require('ffi');
	const path = require('path');
	const Buffer = require('buffer').Buffer;
	const libpath = path.join(APP_PATH, '..', '..', '/testSDK.dll');
	
	const sdkLib = ffi.Library(libpath, {
		'CreateConnection': ['bool', []],
		'SendData': ['bool', ['int', 'int', 'string', 'int']],
		'ReleaseConnection': ['void', []],
		'SetOption': ['void', ['string', 'string', 'int', 'int']],
		'SetReceiveCallback': ['void', ['pointer']]
	});
	
	module.exports = {
		createConnection: function(){
			sdkLib.CreateConnection();
		},
		setReceiveCallback(cb) {
			global.setReceiveCallback = ffi.Callback('void', ['int', 'int', 'string'], function(cmd, seq, data){
				cb && cb(cmd, seq, data && JSON.parse(data));
			});
			sdkLib.SetReceiveCallback(global.setReceiveCallback);
		},
		sendData: function(cmd, seq, data){
			data = JSON.stringify(data);
			sdkLib.SendData(cmd, seq, data, data.replace(/[^\x00-\xff]/g, '000').length, 0);
		},
		releaseConnection: function(){
			sdkLib.ReleaseConnection();
		},
		setOption: function (option) {
			sdkLib.SetOption(
				option.appKey,
				option.tk,
				option.lc,
				option.rm
			);
		}
	}	
} catch (error) {
	log.info(error);
}

复制代码

第一步:通过ffi注册dll接口

	const sdkLib = ffi.Library(libpath, {
		'CreateConnection': ['bool', []],
		'SendData': ['bool', ['int', 'int', 'string', 'int']],
		'ReleaseConnection': ['void', []],
		'SetOption': ['void', ['string', 'string', 'int', 'int']],
		'SetReceiveCallback': ['void', ['pointer']]
	});
	
复制代码

ffi.Library方法,第一个参数传入dll路径,第二参数JSON对象配置相关接口。

key对应dll头文件中输出的接口,例如C_EXPORT bool _cdecl CreateConnection();

value array配置参数类型,array[0]注册接口函数返回值类型,array[1]注册接口函数传入形参类型。

1、基础参数类型bool, char, short, int, long等。

2、指针类型,需要引入ref模块,如下:

var ref = require('ref');
var intPointer = ref.refType('char');
var doublePointer = ref.refType('short');
var charPointer = ref.refType('int');
var stringPointer = ref.refType('long');
var boolPointer = ref.refType('bool');
复制代码

3、回调函数指针pointer,可以通过ffi.Callback创建,如下:

global.setReceiveCallback = ffi.Callback('void', ['int', 'int', 'string'], function(cmd, seq, data){
		cb && cb(cmd, seq, data && JSON.parse(data));
	});
sdkLib.SetReceiveCallback(global.setReceiveCallback);
复制代码

回调函数参数类型配置与dll接口参数类型配置相同,这里就不多说。

这里需要注意一点,回调函数可能会被JavaScript垃圾自动回收机制回收,所以我这里是把回调函数挂载到全局对象global上。

第二步:接口调用

通过ffi.Library(libpath, {...})注册接口,可以直通过返回的sdkLib对象调用对接的接口。例如:

var bool = sdkLib.CreateConnection();
console.log(bool); // true or false;

var cmd = 0, seq = 0, data = {...};
var dataStr = JSON.stringify(data);
// JavaScript中文字符长度在C++中长度计算要*3
sdkLib.SendData(cmd, seq, data, data.replace(/[^\x00-\xff]/g, '000').length);

global.setReceiveCallback = ffi.Callback('void', ['int', 'int', 'string'], function(cmd, seq, data){
	cb(cmd, seq, data && JSON.parse(data));
});
sdkLib.SetReceiveCallback(global.setReceiveCallback);
复制代码

文章到此结束,写这篇文章目标主要是记录自己通过node调用dll从无到有以的过程以及采坑记录,文章有误的地方,欢迎各位大佬指正~

关注下面的标签,发现更多相似文章
评论