Node.js外掛程式的正確編寫方式,node.js外掛程式編寫

來源:互聯網
上載者:User

Node.js外掛程式的正確編寫方式,node.js外掛程式編寫

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


nodejs是什東西?擴充成chrome的外掛程式的?

一樓說的可是真的不對啊....

詳細的可以百度百科看~我簡單的說一下

nodejs是chrome瀏覽器的javascript解析引擎V8封裝的javascript運行平台,是可以寫後台服務的,文法99%符合javascript的文法,你可以理解為java或者.NET或者PHP之類的語言,但是和這些語言不同的是,nodejs是單線程的,非阻塞I/O基於事件驅動的語言,而這些也是javascript的特點。所以如果你前端的js寫的非常熟練,那麼只需要瞭解一些後端的理論就可以了,文法基本上是通用的,如果說有不同,那也是nodejs增加了一些偏重於後台操作的API~~差不多了~最後再說一句,這個可不是js的架構啊,這個和jquery,extjs之類的js架構是有本質再本質的區別的~
 
js寫的服務端怎使用nodejs運行?

node xxx.js就行了唄
 

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.