使用C/C++編寫nodejs原生模塊

一直想了解一下使用C/C++編寫nodejs原生模塊,從網上找到的博客,大多都停留在如何搭建環境,然后一個Hello World完事。連更多的參考資料也沒有。于是就自己整理了一下,備份成此博客,分享于此。

至于準備環境什么的,網上一抓一大把,就不再詳述 。

主要參考兩個地方:

其中第一個是nodejs的官方文檔,里面介紹了幾個不錯的參考例子。
第二個是v8引擎的文檔,c++的,編寫c++模塊主要看這個文檔。

好了,我們開始幾個例子,逐步的了解如何使用c++編寫nodejs模塊。

Hello World

不能免俗,第一個先上來寫個Hello World吧,畢竟程序員認識的第一個程序就是Hello World。

#include <node.h>
void hello(const v8::FunctionCallbackInfo<v8::Value> &args) {
    v8::Isolate *isolate = args.GetIsolate();
    auto message = v8::String::NewFromUtf8(isolate, "Hello World!");
    args.GetReturnValue().Set(message);
}
void Initialize(v8::Local<v8::Object> exports) {
    NODE_SET_METHOD(exports, "hello", hello);
}

NODE_MODULE(module_name, Initialize)

好了,這是最簡單的一個HelloWorld,我們將文件命名為addon.cc,我們使用node-gyp編譯一下,然后在我們的js文件中直接使用require引入模塊,然后就可以調用了。

const myAddon = require('./build/Release/addon') ;
console.log(myAddon.hello());

如無意外,將會在終端打印Hello World!

我們簡單來看一下代碼,第一行#include <node.h>是C++中引入node.h頭文件的代碼。頭文件可理解為接口,我們在里面只定義了接口方法,并未實現,然后通過其他文件實現,C++鏈接器負責將這兩個鏈接在一起。

然后定義了一個方法hello(),沒有返回值。方法參數通過const v8::FunctionCallbackInfo<v8::Value> &args傳遞,注意,這里我們加了v8::前綴注解,也可以直接在文件開始使用using v8;這樣就可以不用每次都使用這個注解了。
v8::Isolate *isolate = args.GetIsolate();這里,我們在函數中訪問了javascript的作用域。
auto message = v8::String::NewFromUtf8(isolate, "Hello World!");我們創建了一個字符串類型的變量,賦值Hello World!并將其綁定到作用域。
我們通過args.GetReturnValue()獲取了我們函數的返回值。

Initialize()方法用于初始化模塊方法,將方法和要導出的模塊的方法名進行綁定。

最后NODE_MODULE導出這個模塊。

上面這個例子很簡單,如果是js代碼的話:

'use strict';

let hello = function hello() {
    let message = "Hello World!";
    return message;
};

module.exports = {
    hello:hello
};

好了,第一個HelloWorld就結束了。網上很多介紹nodejs C++模塊的博客文章,到這里就結束了。看完之后,一臉懵逼,啥啊這是?我想再寫個傳參數,并對參數做簡單操作的方法該怎么寫?

sum(a,b)

好吧。那我們就再寫一個sum(a,b)函數,傳遞兩個數字類型參數a,b,并求兩個參數的和返回。

js中代碼簡單到下:

let sum = function(a,b){
    if(typeof a == 'number' && typeof b == 'number'){
        return a + b;
    }else{
        throw new Error('參數類型錯誤');
    }
}

那么,C++該如何編寫:

void sum(const FunctionCallbackInfo<Value> &args) {
    Isolate *isolate = args.GetIsolate();

    if(!args[0]->IsNumber()){
        isolate->ThrowException(v8::Exception::TypeError(
            v8::String::NewFromUtf8(isolate, "args[0] must be a number")));
        return ;
    }
    if(!args[1]->IsNumber()){
        isolate->ThrowException(v8::Exception::TypeError(
            v8::String::NewFromUtf8(isolate, "args[1] must be a number")));
        return ;
    }
    args.GetReturnValue().Set(args[0]->NumberValue() + args[1]->NumberValue());
}

首先判斷兩個參數是否是Number類型,如果不是,直接拋出異常。如果是,則將返回值設置為兩個參數的和。

這里我們并沒有在參數列表中,直接使用a,b作為參數,而是直接使用 args 對象。 這和js是類似的,第一個參數是 args[0],第二個參數是 args[1]。

調用IsNumber()來判斷是否是數字類型。如果不是,拋出一個TypeError類型錯誤異常。
如果類型沒問題,使用args[0]->NumberValue()獲取參數的數字值,然后相加,賦值給返回值。

可能你會問,args[0] 這是個啥?它的IsNumber()方法又是怎么來的?哪里有文檔可以查閱呢?

這里其實是v8引擎內部類型,基本和js的內置對象是一一對應的。可以查閱v8類型說明文檔

v8 Types

上面這個圖是不是很熟悉,和js的類型系統特別像。
js的Array,Date,Function,String等等都是繼承自Object,而v8引擎內部,Object和Primitive都是繼承自Value類型。

這里的IsNumber()方法就是Value類型的方法。那么除了這個方法,還有什么方法呢?

Value方法

上面這張圖,我只是截了一小部分,全部的可以直接去查閱文檔。看,這里有各種方法,判斷是否是數字類型的IsNumber(),判斷是否是日期類型的IsDate(),判斷是否是數組的IsArray()方法等等。

v8的接口實現的也很完善了,即使并不精通C++的開發者也可以照貓畫虎的實現個簡單的模塊。

args[0]->NumberValue()返回的是一個double的值,是的,這里是實打實的C++里的double類型,可以直接進行加減運算的。類似的還有BooleanValue()方法等等,都是獲取不同類型的值使用的方法。

第二個例子中,我們簡單實現了一個sum()方法,傳遞兩個參數,求和。但是這里涉及到的只是整型的值,那如果有其他類型的值怎么辦呢?比如數組。

sumOfArray(array)

下面將方法升級一下,傳遞一個數組,然后求數組中所有值的和。js的話:

let sumOfArray = function(array){
    if(!Array.isArray(array)){
        throw new Error('參數錯誤,必須為Array類型');
    }
    let sum = 0;
    for(let item of array){
        sum += item;
    }

    return sum;
}

邏輯很簡單,就是將傳過來的數組進行遍歷一遍,然后將所有項累加即可。C++也是如此:

void sumOfArray(const FunctionCallbackInfo<Value> &args){
    Isolate *isolate = args.GetIsolate();
    if(!args[0]->IsArray()){
        isolate->ThrowException(v8::Exception::TypeError(
            v8::String::NewFromUtf8(isolate, "args[0] must be an Array")));
        return ;
    }

    Local<Object>  received_v8_obj = args[0]->ToObject();
    Local<Array> keys = received_v8_obj->GetOwnPropertyNames();
    int length = keys->Length();
    double sum = 0;
    for(int i=0;i<length;i++){
        sum += received_v8_obj->Get(keys->Get(i))->NumberValue();
    }
    args.GetReturnValue().Set(sum);
}

先判斷是否是數組,沒什么問題。

然后我們定義了一個Object類型的received_v8_obj屬性,將其賦值為args[0]->ToObject()。這里調用ToObject()方法將其轉換為一個對象。
然后調用這個對象的GetOwnPropertyNames()方法獲取所有的鍵,然后根據鍵獲取對象的值,進行累加。

為什么不直接將其轉換為數組,然后進行遍歷呢?

我們都知道,js中的數組并不是真正的數組,其實質還是對象。其內部都是鍵值對存儲的。因此這里也是一樣,Value類型并不提供直接轉換為數組的ToArray()方法,而是將其轉換為Object對象,通過對象的形式進行操作。

那么對象有哪些操作呢,看文檔

但是你會發現,v8確實有個Array類,繼承自Object類。那么Array有什么方法呢?
看文檔就知道了,少的可憐:

Array方法

所以,對數組的操作都將轉換為對象操作。

createObj()

說到對象了,那么我們就來寫一個創建對象的方法。傳遞兩個參數,一個name,一個age,創建一個對象,表示一個人,名叫啥,多大年紀。

void createObj(const FunctionCallbackInfo<Value> &args){
    Isolate *isolate = args.GetIsolate();
    Local<Object> obj = Object::New(isolate);
    obj->Set(String::NewFromUtf8(isolate,"name"),args[0]->ToString());
    obj->Set(String::NewFromUtf8(isolate,"age"),args[1]->ToNumber());
    args.GetReturnValue().Set(obj);
}

這個方法,參照文檔,基本沒啥可說的。

通過Object::New(isolate)創建一個對象,然后設置兩個屬性name,age,將參數依次賦值給這兩個屬性,然后返回這個對象即可。

如果用js寫:

let createObj = function(name,age){
    let obj = {};
    obj.name = name;
    obj.age = age;
    return obj;
};

callback

上面說的,都沒提到js中一個重要的東西,回調函數。如果參數中傳一個回調函數,那么我們該如何執行呢?

來一個簡單的例子。

let cb = function(a,b,fn){
    if(typeof a !== 'number' || typeof b !== 'number'){
        throw new Error('參數類型錯誤,只能是Number類型');
    }
    if(typeof fn !== 'function'){
        throw new Error('參數fn類型錯誤,只能是Function類型');
    }
    fn(a,b);
};

這個例子很簡單,我們傳兩個數字類型參數a,b和一個回調函數fn,然后將a,b作為fn的參數調用fn回調函數。這里我們對a,b的操作轉交給回調函數。回調函數里我們可以求和,也可以求積,隨你。

這個例子中,暫時還沒涉及到的是如何調用回調函數。

先上代碼:

void cb(const FunctionCallbackInfo<Value> &args){
    Isolate *isolate = args.GetIsolate();
    if(!args[0]->IsNumber()){
        isolate->ThrowException(v8::Exception::TypeError(
            v8::String::NewFromUtf8(isolate, "args[0] must be a Number")));
    }
    if(!args[1]->IsNumber()){
        isolate->ThrowException(v8::Exception::TypeError(
            v8::String::NewFromUtf8(isolate, "args[1] must be a Number")));
    }
    if(!args[2]->IsFunction()){
        isolate->ThrowException(v8::Exception::TypeError(
            v8::String::NewFromUtf8(isolate, "args[2] must be a Function")));
    }
    Local<Function> jsfn = Local<Function>::Cast(args[2]);

    Local<Value> argv[2] = { Number::New(isolate,args[0]->NumberValue()),Number::New(isolate,args[1]->NumberValue())};

    Local<Value> c = jsfn->Call(Null(isolate),2,argv);
    args.GetReturnValue().Set(c);

}

上面三個判斷參數類型,略過。

我們定義一個Function類型屬性jsfn,將args[2]強制轉換為Function并賦值給jsfn。

然后定義一個具有兩個值的參數argv,這兩個值就是args[0],args[1]的數字值。

然后通過jsfn->Call(Null(isolate),2,argv)調用回調函數。

argv是一個數組,其個數我們在定義時指定,2個。

Call()方法為函數類型的值進行調用的方法。

Local< Value >  |  Call (Handle< Value > recv, int argc, Handle< Value > argv[])

查閱文檔,可以看出,Call()方法傳3個參數,第一個參數是執行上下文,用于綁定代碼執行時的this,第二個參數為參數個數,第三個為參數列表,數組形式。

上面幾個例子,只是冰山一角,連一角都算不上。只為了解一下nodejs使用C/C++編寫原生模塊,如果要編寫一個可用的,高性能的C模塊,那么,要求程序員一定要精通C/C++,并且對js底層也很精通,包括v8和libuv等等。

所以,簡單了解一下,裝裝逼就好了。真要真槍實彈的上,我等渣渣就算了。至少,現在還不行,慢慢鉆研吧。

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,739評論 6 534
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,634評論 3 419
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,653評論 0 377
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,063評論 1 314
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,835評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,235評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,315評論 3 442
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,459評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,000評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,819評論 3 355
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,004評論 1 370
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,560評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,257評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,676評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,937評論 1 288
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,717評論 3 393
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,003評論 2 374

推薦閱讀更多精彩內容