很久以前埋下的一個坑——用Node.js重構NBUT的在線評測系統,連評測端也得重寫一遍。總之,我們現在要做的,說白了就是——用C/C++來實現Node.js的模塊。這篇文章先從最基礎的Hello World講起。
工欲善其事,必先利其器。
node-gyp。首先需要一個node-gyp模塊。在任意目錄執行:
$ npm install node-gyp -g
Python。然後需要一個Python環境,請自行到官網下載。注意:根據node-gyp的GitHub說明,請務必保證Python版本介於2.5.0與3.0.0之間。
編譯環境。編譯器的具體需求可移步node-gyp文檔查看並配置好。
先準備一個C++文件,比如就叫hello.cc。第一步,引入頭文件並定義命名空間:
#include <node.h> #include <v8.h> using namespace v8;
接著寫一個函數,其返回值為 Handle<Value>:
Handle<Value> Hello(const Arguments& args)
{
//... 嗷嗷待寫
}
Handle<Value>。V8裡使用Handle類型來托管JavaScript對象,與C++的shared_ptr類似,Handle間賦值都是直接傳遞對象引用,但不同的是V8用自己的GC來管理對象生命周期,而非智能指針常用的引用計數。JavaScript類型在C++中都有對應的自定義類型,如String、Integer、Object、Date、Array等,使用時必須用Handle托管。而這裡的Value,其實就是JavaScript中各種對象的基類。所以上面那段聲明的意思是:我們寫一個Hello函數,返回一個不定類型的值。注意:只能返回Handle托管下的String、Integer等類型。
Arguments。這就是傳入函數的參數了。在Node.js中參數個數是随意的,而這些參數傳到C++中時,就變成了Arguments類型的對象。
Handle<Value> Hello(const Arguments& args)
{
HandleScope scope;
return scope.Close(String::New("world"));
}
這兩句話的意思是返回一個Node.js中的字符串 "world"。
HandleScope。Handle的生命周期與C++智能指針不同,並非在{}包圍的scope內生存,而需通過HandleScope手動指定。HandleScope只能分配在棧上,它聲明後建立的Handle都由它管理生命周期,對象析構後,其管理的Handle將由GC判斷是否回收。
那為什麼不直接寫 return String::New("world"); 呢?因為當函數返回時scope會被析構,其管理的Handle都將被回收,這個String就變得沒有意義了。於是V8想出了HandleScope::Close(Handle<T> Value)這個函數——它會關閉當前Scope,並把參數轉交給上一個Scope管理。於是我們就有了 scope.Close(String::New("world")) 這樣的寫法。
String::New。這個String類對應Node.js中原生的字符串類,繼承自Value類。與此類似的還有Array、Integer、Boolean、Object、Date、Number、Function等。而New就是新建一個String對象。至此,主要函數解析完畢。
如果是在Node.js裡,我們這樣導出函數:
exports.hello = function() {}
那麼C++中該怎麼做呢?首先寫個初始化函數:
void init(Handle<Object> exports)
{
//...
}
這是硬性規定:傳入的參數一定是一個 Handle<Object>,代表我們將在它上面導出東西。然後在裡面寫上導出的內容:
void init(Handle<Object> exports)
{
exports->Set(String::NewSymbol("hello"),
FunctionTemplate::New(Hello)->GetFunction());
}
大意就是:為exports對象添加一個叫hello的字段,對應的是Hello函數。用偽代碼寫直白點就是 exports.Set("hello", function hello);。
真·導出。最後一步,在代碼末尾加上這一行:
NODE_MODULE(hello, init)
NODE_MODULE是一個宏,意思是採用init這個初始化函數,把要導出的東西導出到hello中。那這個hello哪來呢?它來自文件名!你編譯好的二進制文件名叫什麼,這裡的hello就填什麼(除去後綴名)。注意NODE_MODULE後面沒有分號,因為它不是函數。
再新建一個類似Makefile的歸檔文件 binding.gyp:
{
"targets": [
{
"target_name": "hello",
"sources": [ "hello.cc" ]
}
]
}
文件準備好後,在該目錄執行:
$ node-gyp configure
一切正常會生成build目錄,裡面按平台不同可能是Visual Studio的vcxproj文件,也可能是Makefile。接著執行:
$ node-gyp build
編譯完成後,build/Release目錄下就會有一個hello.node文件——這就是C++要交給Node.js的成果了。
在同一目錄下新建jianfeizao.js:
var addon = require("./build/Release/hello");
console.log(addon.hello());
看到沒,出來了!addon.hello() 就是我們之前在C++中寫的 Handle<Value> Hello(const Arguments& args),現在就把它的返回值輸出了出來。至此,最基礎的Hello World擴展就完成了。下一節我們再深入一點。