Node.js在利用JavaScript編寫后端方面效果拔群，值得我們多加嘗試。不過如果大家需要一些無法直接使用的功能甚至是根本無從實(shí)現(xiàn)的模塊使用，那么能否從C/C++庫(kù)當(dāng)中引入此類成果呢？答案是肯定的，大家要做的就是編寫一款插件，并借此在自己的JavaScript代碼中使用其它代碼庫(kù)的資源。下面我們就一同開始今天的探詢之旅。

介紹

正如Node.js在官方說明文檔中所言，插件是以動(dòng)態(tài)方式進(jìn)行鏈接的共享式對(duì)象，能夠?qū)avaScript代碼與C/C++庫(kù)接駁起來。這意味著我們可以引用任何來自C/C++庫(kù)中的內(nèi)容，并通過創(chuàng)建插件的方式將其納入到Node.js當(dāng)中。

作為實(shí)例，我們將為標(biāo)準(zhǔn)std::string對(duì)象創(chuàng)建一套封裝。

準(zhǔn)備工作

在我們開始編寫工作之前，大家首先需要確保自己已經(jīng)準(zhǔn)備好所有后續(xù)模塊編譯所需要的素材。大家需要node-gyp及其全部依賴關(guān)系。大家可以利用以下命令安裝node-gyp：

npm install -g node-gyp

 在依賴性方面，我們需要為Unix系統(tǒng)準(zhǔn)備以下項(xiàng)目：• Python (要求2.7版本, 3.x無法正常起效)

• make

• 一款C++編譯器工具鏈（例如gpp或者g++）

舉例來說，在Ubuntu上大家可以利用以下命令安裝所有上述項(xiàng)目（其中Python 2.7應(yīng)該已經(jīng)預(yù)先安裝完畢了）：

sudo apt-get install build-essentials 

在Windows系統(tǒng)環(huán)境下，大家需要的是：

• Python (2.7.3版本, 3.x無法正常起效)

• 微軟Visual Studio C++ 2010 (適用于Windows XP/Vista)

• 微軟Visual Studio C++ 2012 for Windows Desktop (適用于Windows 7/8)

強(qiáng)調(diào)一點(diǎn)，Visual Studio的Express版本也能正常起效。

binding.gyp文件

該文件由node-gyp使用，旨在為我們的插件生成適當(dāng)?shù)腷uild文件。大家可以點(diǎn)擊此處查看維基百科提供的.gyp文件說明文檔，但今天我們要使用的實(shí)例非常簡(jiǎn)單、因此只需使用以下代碼即可：

{ 
  "targets": [ 
    { 
      "target_name": "stdstring", 
      "sources": [ "addon.cc", "stdstring.cc" ] 
    } 
  ] 
}

其中target_name可以設(shè)置為大家喜歡的任何內(nèi)容。而sources數(shù)組當(dāng)中包含該插件需要用到的所有源文件。在我們的實(shí)例中還包括addon.cc，它的作用在于容納編譯插件及stdstring.cc所必需的代碼，外加我們的封裝類。

STDStringWrapper類

第一步，我們要做的是在stdstring.h文件當(dāng)中定義自己的類。如果大家對(duì)于C++編程比較熟悉，那么也一定不會(huì)對(duì)以下兩行代碼感到陌生。

#ifndef STDSTRING_H 
#define STDSTRING_H

這屬于標(biāo)準(zhǔn)的include guard。接下來，我們需要將以下兩個(gè)header納入include范疇：

#include 
#include
第一個(gè)面向的是std::string類，而第二個(gè)include則作用于全部與Node以及V8相關(guān)的內(nèi)容。

這一步完成之后，我們可以對(duì)自己的類進(jìn)行聲明：

class STDStringWrapper : public node::ObjectWrap {
對(duì)于所有我們打算包含在插件當(dāng)中的類來說，我們必須擴(kuò)展node::ObjectWrap類。

現(xiàn)在我們可以開始定義該類的private屬性了：

private: 
  std::string* s_; 
  
  explicit STDStringWrapper(std::string s = ""); 
  ~STDStringWrapper();

除了構(gòu)造函數(shù)與解析函數(shù)，我們還需要為std::string定義一個(gè)指針。這是該技術(shù)的核心所在，能夠被用于將C/C++代碼庫(kù)與Node相對(duì)接——我們?yōu)樵揅/C++類定義一個(gè)私有指針，并將在隨后的所有方法中利用該指針實(shí)現(xiàn)操作。

現(xiàn)在我們聲明的constructor靜態(tài)屬性，它將為我們?cè)赩8中創(chuàng)建的類提供函數(shù)：

static v8::Persistent constructor;
感興趣的朋友可以點(diǎn)擊此處參閱模板說明方案以獲取更多細(xì)節(jié)信息。

現(xiàn)在我們還需要一個(gè)New方法，它將被分配給前面提到的constructor，同時(shí)V8會(huì)對(duì)我們的類進(jìn)行初始化：

static v8::Handle New(const v8::Arguments& args);
 作用于V8的每一個(gè)函數(shù)都應(yīng)該遵循以下要求：它將接受指向v8::Arguments對(duì)象的引用，并返回一個(gè)v8::Handle>v8::Value>——這正是我們?cè)谑褂脧?qiáng)類型C++編碼時(shí)，V8處理弱類型JavaScript的一貫方式。

在此之后，我們還需要將另外兩個(gè)方法插入到對(duì)象的原型當(dāng)中：

static v8::Handle add(const v8::Arguments& args); 
static v8::Handle toString(const v8::Arguments& args);

其中toString()方法允許我們?cè)趯⑵渑c普通JavaScript字符串共同使用時(shí)獲得s_的值而非[Object object]的值。

最后，我們將引入初始化方法（此方法將由V8調(diào)用并指派給constructor函數(shù)）并關(guān)閉include guard：

public: 
    static void Init(v8::Handle exports); 
}; 
  
#endif

其中exports對(duì)象在JavaScript模塊中的作用等同于module.exports。

stdstring.cc文件、構(gòu)造函數(shù)與解析函數(shù)

現(xiàn)在來創(chuàng)建stdstring.cc文件。我們首先需要include我們的header：

#include "stdstring.h" 

下面為constructor定義屬性（因?yàn)樗鼘儆陟o態(tài)函數(shù)）：

v8::Persistent STDStringWrapper::constructor; 

這個(gè)為類服務(wù)的構(gòu)造函數(shù)將分配s_屬性：

STDStringWrapper::STDStringWrapper(std::string s) { 
  s_ = new std::string(s); 
}

而解析函數(shù)將對(duì)其進(jìn)行delete，從而避免內(nèi)存溢出：

STDStringWrapper::~STDStringWrapper() { 
  delete s_; 
}

再有，大家必須delete掉所有與new一同分配的內(nèi)容，因?yàn)槊恳淮未祟惽闆r都有可能造成異常，因此請(qǐng)牢牢記住上述操作或者使用共享指針。

Init方法

該方法將由V8加以調(diào)用，旨在對(duì)我們的類進(jìn)行初始化（分配constructor，將我們所有打算在JavaScript當(dāng)中使用的內(nèi)容安置在exports對(duì)象當(dāng)中）：

void STDStringWrapper::Init(v8::Handle exports) {
首先，我們需要為自己的New方法創(chuàng)建一個(gè)函數(shù)模板：

v8::Local tpl = v8::FunctionTemplate::New(New);
這有點(diǎn)類似于JavaScipt當(dāng)中的new Function——它允許我們準(zhǔn)備好自己的JavaScript類。

現(xiàn)在我們可以根據(jù)實(shí)際需要為該函數(shù)設(shè)定名稱了（如果大家漏掉了這一步，那么構(gòu)造函數(shù)將處于匿名狀態(tài)，即名稱為function someName() {}或者function () {}）：

tpl->SetClassName(v8::String::NewSymbol("STDString"));
我們利用v8::String::NewSymbol()來創(chuàng)建一個(gè)用于屬性名稱的特殊類型字符串——這能為引擎的運(yùn)作節(jié)約一點(diǎn)點(diǎn)時(shí)間。

在此之后，我們需要設(shè)定我們的類實(shí)例當(dāng)中包含多少個(gè)字段：

tpl->InstanceTemplate()->SetInternalFieldCount(2);
我們擁有兩個(gè)方法——add()與toString()，因此我們將數(shù)量設(shè)置為2。現(xiàn)在我們可以將自己的方法添加到函數(shù)原型當(dāng)中了：

tpl->PrototypeTemplate()->Set(v8::String::NewSymbol("add"), v8::FunctionTemplate::New(add)->GetFunction()); 
tpl->PrototypeTemplate()->Set(v8::String::NewSymbol("toString"), v8::FunctionTemplate::New(toString)->GetFunction());
這部分代碼量看起來比較大，但只要認(rèn)真觀察大家就會(huì)發(fā)現(xiàn)其中的規(guī)律：我們利用tpl->PrototypeTemplate()->Set()來添加每一個(gè)方法。我們還利用v8::String::NewSymbol()為它們提供名稱與FunctionTemplate。

最后，我們可以將該構(gòu)造函數(shù)安置于我們的constructor類屬性內(nèi)的exports對(duì)象中：

constructor = v8::Persistent::New(tpl->GetFunction()); 
  exports->Set(v8::String::NewSymbol("STDString"), constructor); 
}

New方法

現(xiàn)在我們要做的是定義一個(gè)與JavaScript Object.prototype.constructor運(yùn)作效果相同的方法：

v8::Handle STDStringWrapper::New(const v8::Arguments& args) {

 我們首先需要為其創(chuàng)建一個(gè)范圍：

v8::HandleScope scope; 

在此之后，我們可以利用args對(duì)象的.IsConstructCall()方法來檢查該構(gòu)造函數(shù)是否能夠利用new關(guān)鍵詞加以調(diào)用：

if (args.IsConstructCall()) { 

如果可以，我們首先如下所示將參數(shù)傳遞至std::string處：

v8::String::Utf8Value str(args[0]->ToString()); 
std::string s(*str);

……這樣我們就能將它傳遞到我們封裝類的構(gòu)造函數(shù)當(dāng)中了：

STDStringWrapper* obj = new STDStringWrapper(s);

在此之后，我們可以利用之前創(chuàng)建的該對(duì)象的.Wrap()方法（繼承自node::ObjectWrap）來將它分配給this變量：

obj->Wrap(args.This()); 

最后，我們可以返回這個(gè)新創(chuàng)建的對(duì)象：

return args.This(); 

如果該函數(shù)無法利用new進(jìn)行調(diào)用，我們也可以直接調(diào)用構(gòu)造函數(shù)。接下來，我們要做的是為參數(shù)計(jì)數(shù)設(shè)置一個(gè)常數(shù)：

} else { 
  const int argc = 1; 

現(xiàn)在我們需要利用自己的參數(shù)創(chuàng)建一個(gè)數(shù)組：

v8::Local argv[argc] = { args[0] }; 

然后將constructor->NewInstance方法的結(jié)果傳遞至scope.Close，這樣該對(duì)象就能在隨后發(fā)揮作用（scope.Close基本上允許大家通過將對(duì)象處理句柄移動(dòng)至更高范圍的方式對(duì)其加以維持——這也是函數(shù)的起效方式）：

    return scope.Close(constructor->NewInstance(argc, argv)); 
  } 
} 

add方法

現(xiàn)在讓我們創(chuàng)建add方法，它的作用是允許大家向?qū)ο蟮膬?nèi)部std::string添加內(nèi)容：

v8::Handle STDStringWrapper::add(const v8::Arguments& args) { 

首先，我們需要為我們的函數(shù)創(chuàng)建一個(gè)范圍，并像之前那樣把該參數(shù)轉(zhuǎn)換到std::string當(dāng)中：

v8::HandleScope scope; 
  
v8::String::Utf8Value str(args[0]->ToString()); 
std::string s(*str); 

現(xiàn)在我們需要對(duì)該對(duì)象進(jìn)行拆包。我們之前也進(jìn)行過這種反向封裝操作——這一次我們是要從this變量當(dāng)中獲取指向?qū)ο蟮闹羔槨?/p>

STDStringWrapper* obj = ObjectWrap::Unwrap(args.This()); 

接著我們可以訪問s_屬性并使用其.append()方法：

obj->s_->append(s); 

最后，我們返回s_屬性的當(dāng)前值（需要再次使用scope.Close）：

return scope.Close(v8::String::New(obj->s_->c_str())); 

由于v8::String::New()方法只能將char pointer作為值來接受，因此我們需要使用obj->s_->c_str()來加以獲取。

這時(shí)大家的插件文件夾中還應(yīng)該創(chuàng)建出一個(gè)build目錄。

測(cè)試

現(xiàn)在我們可以對(duì)自己的插件進(jìn)行測(cè)試了。在我們的插件目錄中創(chuàng)建一個(gè)test.js文件以及必要的編譯庫(kù)（大家可以直接略過.node擴(kuò)展）：

var addon = require('./build/Release/addon'); 

下一步，為我們的對(duì)象創(chuàng)建一個(gè)新實(shí)例：

var test = new addon.STDString('test'); 

下面再對(duì)其進(jìn)行操作，例如添加或者將其轉(zhuǎn)化為字符串：

test.add('!'); 
console.log('test\'s contents: %s', test); 

在運(yùn)行之后，大家應(yīng)該在控制臺(tái)中看到以下執(zhí)行結(jié)果：

結(jié)論

我希望大家能在閱讀了本教程之后打消顧慮，將創(chuàng)建與測(cè)試以C/C++庫(kù)為基礎(chǔ)的定制化Node.js插件視為一項(xiàng)無甚難度的任務(wù)。大家可以利用這種技術(shù)輕松將幾乎任何C/C++庫(kù)引入Node.js當(dāng)中。如果大家愿意，還可以根據(jù)實(shí)際需求為插件添加更多功能。std::string當(dāng)中提供大量方法，我們可以將它們作為練習(xí)素材。

實(shí)用鏈接

感興趣的朋友可以查看以下鏈接以獲取更多與Node.js插件開發(fā)、V8以及C事件循環(huán)庫(kù)相關(guān)的資源與詳細(xì)信息。

• Node.js插件說明文檔

• V8說明文檔

• libuv (C事件循環(huán)庫(kù))，來自GitHub

英文：http://code.tutsplus.com/tutorials/writing-nodejs-addons--cms-21771

最新評(píng)論