如何編寫Node.js外掛

edithfang發表於2014-08-02
Node.js在利用JavaScript編寫後端方面效果拔群,值得我們多加嘗試。不過如果大家需要一些無法直接使用的功能甚至是根本無從實現的模組使用,那麼能否從C/C++庫當中引入此類成果呢?答案是肯定的,大家要做的就是編寫一款外掛,並藉此在自己的JavaScript程式碼中使用其它程式碼庫的資源。下面我們就一同開始今天的探詢之旅。

介紹

正如Node.js在官方說明文件中所言,外掛是以動態方式進行連結的共享式物件,能夠將JavaScript程式碼與C/C++庫接駁起來。這意味著我們可以引用任何來自C/C++庫中的內容,並通過建立外掛的方式將其納入到Node.js當中。
作為例項,我們將為標準std::string物件建立一套封裝。

準備工作

在我們開始編寫工作之前,大家首先需要確保自己已經準備好所有後續模組編譯所需要的素材。大家需要node-gyp及其全部依賴關係。大家可以利用以下命令安裝node-gyp:
npm install -g node-gyp
 在依賴性方面,我們需要為Unix系統準備以下專案:• Python (要求2.7版本, 3.x無法正常起效)

• make
• 一款C++編譯器工具鏈(例如gpp或者g++)

舉例來說,在Ubuntu上大家可以利用以下命令安裝所有上述專案(其中Python 2.7應該已經預先安裝完畢了):
sudo apt-get install build-essentials 
在Windows系統環境下,大家需要的是:

• Python (2.7.3版本, 3.x無法正常起效)
• 微軟Visual Studio C++ 2010 (適用於Windows XP/Vista)
• 微軟Visual Studio C++ 2012 for Windows Desktop (適用於Windows 7/8)

強調一點,Visual Studio的Express版本也能正常起效。

binding.gyp檔案

該檔案由node-gyp使用,旨在為我們的外掛生成適當的build檔案。大家可以點選此處檢視維基百科提供的.gyp檔案說明文件,但今天我們要使用的例項非常簡單、因此只需使用以下程式碼即可:
{  
    "targets": [  
        {  
            "target_name": "stdstring",  
            "sources": [ "addon.cc", "stdstring.cc" ]  
        }  
    ]  
}
其中target_name可以設定為大家喜歡的任何內容。而sources陣列當中包含該外掛需要用到的所有原始檔。在我們的例項中還包括addon.cc,它的作用在於容納編譯外掛及stdstring.cc所必需的程式碼,外加我們的封裝類。

STDStringWrapper類

第一步,我們要做的是在stdstring.h檔案當中定義自己的類。如果大家對於C++程式設計比較熟悉,那麼也一定不會對以下兩行程式碼感到陌生。
#ifndef STDSTRING_H  
#define STDSTRING_H
這屬於標準的include guard。接下來,我們需要將以下兩個header納入include範疇:
#include  
#include
第一個面向的是std::string類,而第二個include則作用於全部與Node以及V8相關的內容。

這一步完成之後,我們可以對自己的類進行宣告:
class STDStringWrapper : public node::ObjectWrap { 
對於所有我們打算包含在外掛當中的類來說,我們必須擴充套件node::ObjectWrap類。

現在我們可以開始定義該類的private屬性了:
private:  
    std::string* s_;  
   
    explicit STDStringWrapper(std::string s = "");  
    ~STDStringWrapper();
除了建構函式與解析函式,我們還需要為std::string定義一個指標。這是該技術的核心所在,能夠被用於將C/C++程式碼庫與Node相對接——我們為該C/C++類定義一個私有指標,並將在隨後的所有方法中利用該指標實現操作。
現在我們宣告的constructor靜態屬性,它將為我們在V8中建立的類提供函式:
static v8::Persistent constructor; 
感興趣的朋友可以點選此處參閱模板說明方案以獲取更多細節資訊。

現在我們還需要一個New方法,它將被分配給前面提到的constructor,同時V8會對我們的類進行初始化:
static v8::Handle New(const v8::Arguments& args);
 作用於V8的每一個函式都應該遵循以下要求:它將接受指向v8::Arguments物件的引用,並返回一個v8::Handle>v8::Value>——這正是我們在使用強型別C++編碼時,V8處理弱型別JavaScript的一貫方式。

在此之後,我們還需要將另外兩個方法插入到物件的原型當中:
static v8::Handle add(const v8::Arguments& args);  
static v8::Handle toString(const v8::Arguments& args);
其中toString()方法允許我們在將其與普通JavaScript字串共同使用時獲得s_的值而非[Object object]的值。

最後,我們將引入初始化方法(此方法將由V8呼叫並指派給constructor函式)並關閉include guard:
public:  
        static void Init(v8::Handle exports);  
};  
   
#endif
其中exports物件在JavaScript模組中的作用等同於module.exports。

stdstring.cc檔案、建構函式與解析函式

現在來建立stdstring.cc檔案。我們首先需要include我們的header:
#include "stdstring.h" 
下面為constructor定義屬性(因為它屬於靜態函式):
v8::Persistent STDStringWrapper::constructor; 
這個為類服務的建構函式將分配s_屬性:
STDStringWrapper::STDStringWrapper(std::string s) {  
    s_ = new std::string(s);  
}
而解析函式將對其進行delete,從而避免記憶體溢位:
STDStringWrapper::~STDStringWrapper() {  
    delete s_;  
}
再有,大家必須delete掉所有與new一同分配的內容,因為每一次此類情況都有可能造成異常,因此請牢牢記住上述操作或者使用共享指標。

Init方法

該方法將由V8加以呼叫,旨在對我們的類進行初始化(分配constructor,將我們所有打算在JavaScript當中使用的內容安置在exports物件當中):
void STDStringWrapper::Init(v8::Handle exports) { 
首先,我們需要為自己的New方法建立一個函式模板:
v8::Local tpl = v8::FunctionTemplate::New(New); 
這有點類似於JavaScipt當中的new Function——它允許我們準備好自己的JavaScript類。

現在我們可以根據實際需要為該函式設定名稱了(如果大家漏掉了這一步,那麼建構函式將處於匿名狀態,即名稱為function someName() {}或者function () {}):
tpl->SetClassName(v8::String::NewSymbol("STDString")); 
我們利用v8::String::NewSymbol()來建立一個用於屬性名稱的特殊型別字串——這能為引擎的運作節約一點點時間。

在此之後,我們需要設定我們的類例項當中包含多少個欄位:
tpl->InstanceTemplate()->SetInternalFieldCount(2); 
我們擁有兩個方法——add()與toString(),因此我們將數量設定為2。現在我們可以將自己的方法新增到函式原型當中了:
tpl->PrototypeTemplate()->Set(v8::String::NewSymbol("add"), v8::FunctionTemplate::New(add)->GetFunction());  
tpl->PrototypeTemplate()->Set(v8::String::NewSymbol("toString"), v8::FunctionTemplate::New(toString)->GetFunction());
這部分程式碼量看起來比較大,但只要認真觀察大家就會發現其中的規律:我們利用tpl->PrototypeTemplate()->Set()來新增每一個方法。我們還利用v8::String::NewSymbol()為它們提供名稱與FunctionTemplate。

最後,我們可以將該建構函式安置於我們的constructor類屬性內的exports物件中:
constructor = v8::Persistent::New(tpl->GetFunction());  
    exports->Set(v8::String::NewSymbol("STDString"), constructor);  
}
New方法

現在我們要做的是定義一個與JavaScript Object.prototype.constructor運作效果相同的方法:
v8::Handle STDStringWrapper::New(const v8::Arguments& args) {
 我們首先需要為其建立一個範圍:
v8::HandleScope scope; 
在此之後,我們可以利用args物件的.IsConstructCall()方法來檢查該建構函式是否能夠利用new關鍵詞加以呼叫:
if (args.IsConstructCall()) { 
如果可以,我們首先如下所示將引數傳遞至std::string處:
v8::String::Utf8Value str(args[0]->ToString());  
std::string s(*str);
……這樣我們就能將它傳遞到我們封裝類的建構函式當中了:
STDStringWrapper* obj = new STDStringWrapper(s);
在此之後,我們可以利用之前建立的該物件的.Wrap()方法(繼承自node::ObjectWrap)來將它分配給this變數:
obj->Wrap(args.This()); 
最後,我們可以返回這個新建立的物件:
return args.This(); 
如果該函式無法利用new進行呼叫,我們也可以直接呼叫建構函式。接下來,我們要做的是為引數計數設定一個常數:
} else {  
    const int argc = 1;  
現在我們需要利用自己的引數建立一個陣列:
v8::Local argv[argc] = { args[0] }; 
然後將constructor->NewInstance方法的結果傳遞至scope.Close,這樣該物件就能在隨後發揮作用(scope.Close基本上允許大家通過將物件處理控制程式碼移動至更高範圍的方式對其加以維持——這也是函式的起效方式):
        return scope.Close(constructor->NewInstance(argc, argv));  
    }  
}  
add方法

現在讓我們建立add方法,它的作用是允許大家向物件的內部std::string新增內容:
v8::Handle STDStringWrapper::add(const v8::Arguments& args) { 
首先,我們需要為我們的函式建立一個範圍,並像之前那樣把該引數轉換到std::string當中:
v8::HandleScope scope;  
   
v8::String::Utf8Value str(args[0]->ToString());  
std::string s(*str);  
現在我們需要對該物件進行拆包。我們之前也進行過這種反向封裝操作——這一次我們是要從this變數當中獲取指向物件的指標。
STDStringWrapper* obj = ObjectWrap::Unwrap(args.This()); 
接著我們可以訪問s_屬性並使用其.append()方法:
obj->s_->append(s); 
最後,我們返回s_屬性的當前值(需要再次使用scope.Close):
return scope.Close(v8::String::New(obj->s_->c_str()));  
由於v8::String::New()方法只能將char pointer作為值來接受,因此我們需要使用obj->s_->c_str()來加以獲取。

這時大家的外掛資料夾中還應該建立出一個build目錄。

測試

現在我們可以對自己的外掛進行測試了。在我們的外掛目錄中建立一個test.js檔案以及必要的編譯庫(大家可以直接略過.node擴充套件):
var addon = require('./build/Release/addon'); 
下一步,為我們的物件建立一個新例項:
var test = new addon.STDString('test'); 
下面再對其進行操作,例如新增或者將其轉化為字串:
test.add('!');  
console.log('test\'s contents: %s', test);  
在執行之後,大家應該在控制檯中看到以下執行結果:

結論

我希望大家能在閱讀了本教程之後打消顧慮,將建立與測試以C/C++庫為基礎的定製化Node.js外掛視為一項無甚難度的任務。大家可以利用這種技術輕鬆將幾乎任何C/C++庫引入Node.js當中。如果大家願意,還可以根據實際需求為外掛新增更多功能。std::string當中提供大量方法,我們可以將它們作為練習素材。

實用連結

感興趣的朋友可以檢視以下連結以獲取更多與Node.js外掛開發、V8以及C事件迴圈庫相關的資源與詳細資訊。

• Node.js外掛說明文件

• V8說明文件

• libuv (C事件迴圈庫),來自GitHub

英文:http://code.tutsplus.com/tutorials/writing-nodejs-addons--cms-21771
評論(3)

相關文章