Nodejs Native AddOn的编写

本文主要是介绍Nodejs Native AddOn的编写，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

本文地址 http://blog.csdn.net/wangjia184/article/details/18940165

如果要在nodejs中调用动态链接库中的导出方法，或者从动态链接库中回调nodejs中的某个方法，可以采用 node-ffi（https://github.com/rbranson/node-ffi )。不过我试了很久都没有成功，貌似ffi对于回调的支持有问题，无法正确区分 _stdcall 与 _cdecl。而另一种实现方式就非常简单直接了，通过编写nodejs addon的方式直接实现。

nodejs中的addon使用C编写，其编译链接的工具链不是常见的makefile autoconf之类，而是从Chromium移植来的node-gyp。所以，如果直接将复杂的C/C++代码在addon中实现，容易产生编译或者链接冲突。比较简单的方式是，addon只作为adapter使用，在addon中通过dlopen/LoadLibrary去操纵动态链接库或者回调js.

http://nodejs.org/api/addons.html 有实现Addon的基本讲解。

AddOn的基本结构

首先新建adapter.cc, 贴图如下代码

[cpp]  view plain copy  
 print ? 
 #include <node.h>  
 #include <v8.h>  
 using namespace v8;  
   
   
 void init(Handle<Object> exports) {  
    
 }  
 NODE_MODULE(mq, init)  

这是一个“空”的addon，啥事都没干。 NODE_MODULE 宏的第一个参数是该模块的名称；第二个参数是初始化函数init，此函数在addon加载后调用。

然后在adapter.cc同目录中新建文件building.gyp，它的内容是JSON格式

[javascript]  view plain copy  
 print ? 
 {  
   "targets": [  
     {  
       "target_name": "mq",  
       "sources": [ "adapter.cc" ]  
     }  
   ]  
 }  

需要注意的是， target_name 必须和NODE_MODULE的第一个参数相同。

然后就可以在此目录下，使用gyp编译了

[plain]  view plain copy  
 print ? 
 node-gyp configure  
 node-gyp rebuild  

编译的结果在build/release目录下，文件的扩展名是 *.node, 而文件名就是之前指定的模块名。

将此*.node文件拷贝到nodejs工程中的node_modules文件夹下，就可以进行加载了。

[javascript]  view plain copy  
 print ? 
 var MQ = require('mq.node');  
 console.log(MQ);  

Addon中注册方法供NodeJS调用

在Addon中被NodeJS调用的函数原型必须是 Handle<Value> method(const Arguments& args), 在模块初始化的时候注册此方法。如：

[cpp]  view plain copy  
 print ? 
 Handle<Value> XXXXXX(const Arguments& args) {  
     HandleScope scope;  
   
     return scope.Close(Undefined());  
 }  
   
   
 void init(Handle<Object> exports) {  
   exports->Set(String::NewSymbol("XXXXXX"),  
       FunctionTemplate::New(XXXXXX<span style="font-family: Arial, Helvetica, sans-serif;">)->GetFunction());</span>  
 }  

在nodejs中即可调用此方法

[javascript]  view plain copy  
 print ? 
 var MQ = require('mq.node');  
 MQ.XXXXXX( 2, false, 'Text');  

从javascript这样的弱类型语言向C强类型语言传递参数，在输入时需要做好类型检查与类型转换。

Addon中回调NodeJS方法

首先在NodeJS中将需要被回调的函数地址通过参数传入。

[javascript]  view plain copy  
 print ? 
 MQ.setLogCallback(function (level, message) {  
     console.log('[' + level + '] : ' + message)  
 });  

在Addon中，将传递进来的回调函数进行保存

[cpp]  view plain copy  
 print ? 
 static Persistent<Function> s_logCallback;  
 Handle<Value> setLogCallback(const Arguments& args) {  
     HandleScope scope;  
     if (args.Length() < 1 || !args[0]->IsFunction() ) {  
         return ThrowException(Exception::TypeError(String::New("Invalid parameter.")));  
     }  
   
     s_logCallback.Dispose();  
     s_logCallback = Persistent<Function>::New(Local<Function>::Cast(args[0]));  
   
     return scope.Close(Undefined());  
 }  

在Addon中，当需要回调此函数的时候，直接调用即可。如

[cpp]  view plain copy  
 print ? 
 if( !s_logCallback.IsEmpty() ){  
     const unsigned argc = 2;  
     Local<Value> argv[argc] = {   
         Local<Value>::New(Number::New(1)) ,  
         Local<Value>::New(String::New("Test Message"))   
     };  
     s_logCallback->Call(Context::GetCurrent()->Global(), argc, argv);  
 }  

多线程环境下回调

NodeJS中的V8引擎是以单线程执行的，回调JS方法也必须在V8的主线程中进行，否则会发生未知的后果甚至crash掉整个进程。NodeJS底层的libuv提供了相应的通知机制来实现主线程中的调用。

首先需要定义 uv_async_t 变量

[cpp]  view plain copy  
 print ? 
 static uv_async_t s_async = {0};  

在主线程中初始化此变量，并注册在主线程中此通知触发时回调的方法。此步骤可以在init中执行。

[cpp]  view plain copy  
 print ? 
 uv_async_init( uv_default_loop(), &s_async, onCallback);  

而onCallback方法则在主线程中，通知发生后执行

[cpp]  view plain copy  
 print ? 
 void onCallback(uv_async_t* handle, int status){  
     if( !s_logCallback.IsEmpty() ){  
         const unsigned argc = 2;  
         Local<Value> argv[argc] = {   
             Local<Value>::New(Number::New(1)) ,  
             Local<Value>::New(String::New("Callback is happening"))   
         };  
         s_logCallback->Call(Context::GetCurrent()->Global(), argc, argv);  
     }  
 }  

在任何线程中，都可以通过 uv_async_send 来触发此回调的执行。

[cpp]  view plain copy  
 print ? 
 uv_async_send(&s_async);  

当不再需要回调的时候，可以调用 uv_close 来取消注册此回调方法。

[cpp]  view plain copy  
 print ? 
 uv_close( &s_async, NULL);  

这里特别需要注意的是，uv_async_send触发回调的次数并不是一一对应的。它只能保证最少一次的触发。可能会出现这样一种情况，连续调用了3次uv_async_send方法,但回调只被触发了一次（调用第1、2、3次的时候，NodeJS的主循环可能忙于其它处理而直到检测到此通知时，3次调用都已经发生了，而此时只会进行一次回调）。针对这种情况，应该设计相应的队列结构来传递数据到回调中依次处理。

异步调用

NodeJS的主线程只负责event loop和V8的执行，如果addon中某个导出方法在调用时会发生阻塞，会严重地影响到NodeJS的整体性能。因此，libuv设计了异步调用的方式--将阻塞类操作放入其它线程中处理，在处理完成后回调。

例如，JS调用如下导出方法

[cpp]  view plain copy  
 print ? 
 AddOn.lookupIpCountry( ip, function(countryCode){  
     // get the country code  
     // ...  
 });  

在AddOn中，定义一个结构体在异步调用中传递数据。

[cpp]  view plain copy  
 print ? 
 struct LookupIpCountryBaton {  
     uv_work_t work;  
     Persistent<Function> callback;  
     char ip[IP_LEN];  
     char country_code[COUNTRY_CODE_LEN];  
 };  

导出方法首先保存回调函数，并验证和解析传入参数

[cpp]  view plain copy  
 print ? 
 // lookup country by ip  
 // 1st argument is ip address  
 // 2nd argument is the callback function  
 Handle<Value> lookupIpCountry(const Arguments& args) {  
     HandleScope scope;  
     if (args.Length() < 2 ||  
         !args[1]->IsFunction() ||  
         (!args[0]->IsStringObject() && !args[0]->IsString())  ) {  
         return ThrowException(Exception::TypeError(String::New("Invalid parameter.")));  
     }  
   
     String::Utf8Value param1(args[0]->ToString());  
     char * ip = *param1;  
   
   
     LookupIpCountryBaton * baton = new LookupIpCountryBaton();  
     baton->work.data = baton;  
     memset( baton->country_code, 0, COUNTRY_CODE_LEN);  
     memset( baton->ip, 0, IP_LEN);  
     strncpy( baton->ip, ip, IP_LEN);  
     baton->callback = Persistent<Function>::New(Local<Function>::Cast(args[1]));  
       
     uv_queue_work( uv_default_loop(), &baton->work, lookupIpCountryAsync, lookupIpCountryCompleted);  
   
     return Undefined();  
 }  

这里最关键的是 uv_queue_work , 它将请求压入队列交由其它线程执行，同时指定在线程中执行的函数（ lookupIpCountryAsyc )，亦指定了调用结束后完成的函数( lookupIpCountryCompleted )

在lookupIpCountryAsyc函数中，进行阻塞调用。这里要注意，此函数不是在主线程中运行，所以不能访问或者调用任何V8有关的函数或数据。

[cpp]  view plain copy  
 print ? 
 void lookupIpCountryAsync(uv_work_t * work){  
     LookupIpCountryBaton * baton = (LookupIpCountryBaton*)work->data;  
   
     // block thread for 3 seconds  
     sleep(3);  
     // save the result  
     strncpy( baton->country_code, "CN", COUNTRY_CODE_LEN - 1);  
 }  

当此函数执行完后， lookupIpCountryCompleted 函数会在主线程中被执行，完成回调和清理工作。

[cpp]  view plain copy  
 print ? 
 void lookupIpCountryCompleted(uv_work_t * work, int){  
     LookupIpCountryBaton * baton = (LookupIpCountryBaton*)work->data;  
   
     const unsigned argc = 1;  
     Local<Value> argv[argc] = {   
         Local<Value>::New(String::New(baton->country_code)) ,  
     };  
     baton->callback->Call(Context::GetCurrent()->Global(), argc, argv);  
   
     baton->callback.Dispose();  
     delete baton;  
 }  
  