前言

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

至于準(zhǔn)備環(huán)境什么的，網(wǎng)上一抓一大把，就不再詳述 。

主要參考兩個(gè)地方：

• nodejs官方文檔
• v8文檔

其中第一個(gè)是nodejs的官方文檔，里面介紹了幾個(gè)不錯(cuò)的參考例子。

第二個(gè)是v8引擎的文檔，c++的，編寫c++模塊主要看這個(gè)文檔。

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

Hello World

不能免俗，第一個(gè)先上來寫個(gè)Hello World吧，畢竟程序員認(rèn)識(shí)的第一個(gè)程序就是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)

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

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

如無意外，將會(huì)在終端打印Hello World!。

我們簡單來看一下代碼，第一行#include <node.h>是C++中引入node.h頭文件的代碼。頭文件可理解為接口，我們?cè)诶锩嬷欢x了接口方法，并未實(shí)現(xiàn)，然后通過其他文件實(shí)現(xiàn)，C++鏈接器負(fù)責(zé)將這兩個(gè)鏈接在一起。

然后定義了一個(gè)方法hello() ，沒有返回值。方法參數(shù)通過const v8::FunctionCallbackInfo<v8::Value> &args傳遞，注意，這里我們加了v8::前綴注解，也可以直接在文件開始使用using v8;這樣就可以不用每次都使用這個(gè)注解了。

v8::Isolate *isolate = args.GetIsolate();這里，我們?cè)诤瘮?shù)中訪問了javascript的作用域。

auto message = v8::String::NewFromUtf8(isolate, "Hello World!");我們創(chuàng)建了一個(gè)字符串類型的變量，賦值Hello World!并將其綁定到作用域。

我們通過args.GetReturnValue()獲取了我們函數(shù)的返回值。

Initialize()方法用于初始化模塊方法，將方法和要導(dǎo)出的模塊的方法名進(jìn)行綁定。

最后NODE_MODULE導(dǎo)出這個(gè)模塊。

上面這個(gè)例子很簡單，如果是js代碼的話：

'use strict';
let hello = function hello() {
 let message = "Hello World!";
 return message;
};
module.exports = {
 hello:hello
};

好了，第一個(gè)HelloWorld就結(jié)束了。網(wǎng)上很多介紹nodejs C++模塊的博客文章，到這里就結(jié)束了?？赐曛?，一臉懵逼，啥啊這是？我想再寫個(gè)傳參數(shù)，并對(duì)參數(shù)做簡單操作的方法該怎么寫？

sum(a,b)

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

js中代碼簡單到下：

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

那么，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());
}

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

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

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

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

這里其實(shí)是v8引擎內(nèi)部類型，基本和js的內(nèi)置對(duì)象是一一對(duì)應(yīng)的?？梢圆殚唙8類型說明文檔。

上面這個(gè)圖是不是很熟悉，和js的類型系統(tǒng)特別像。

js的Array,Date,Function,String等等都是繼承自O(shè)bject，而v8引擎內(nèi)部，Object和Primitive都是繼承自Value類型。

這里的IsNumber()方法就是Value類型的方法。那么除了這個(gè)方法，還有什么方法呢？

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

v8的接口實(shí)現(xiàn)的也很完善了，即使并不精通C++的開發(fā)者也可以照貓畫虎的實(shí)現(xiàn)個(gè)簡單的模塊。

args[0]->NumberValue()返回的是一個(gè)double的值，是的，這里是實(shí)打?qū)嵉腃++里的double類型，可以直接進(jìn)行加減運(yùn)算的。類似的還有BooleanValue()方法等等，都是獲取不同類型的值使用的方法。

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

sumOfArray(array)

下面將方法升級(jí)一下，傳遞一個(gè)數(shù)組，然后求數(shù)組中所有值的和。js的話：

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

邏輯很簡單，就是將傳過來的數(shù)組進(jìn)行遍歷一遍，然后將所有項(xiàng)累加即可。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);
}

先判斷是否是數(shù)組，沒什么問題。

然后我們定義了一個(gè)Object類型的received_v8_obj屬性，將其賦值為args[0]->ToObject() 。這里調(diào)用ToObject()方法將其轉(zhuǎn)換為一個(gè)對(duì)象。

然后調(diào)用這個(gè)對(duì)象的GetOwnPropertyNames()方法獲取所有的鍵，然后根據(jù)鍵獲取對(duì)象的值，進(jìn)行累加。

為什么不直接將其轉(zhuǎn)換為數(shù)組，然后進(jìn)行遍歷呢？

我們都知道，js中的數(shù)組并不是真正的數(shù)組，其實(shí)質(zhì)還是對(duì)象。其內(nèi)部都是鍵值對(duì)存儲(chǔ)的。因此這里也是一樣，Value類型并不提供直接轉(zhuǎn)換為數(shù)組的ToArray()方法，而是將其轉(zhuǎn)換為Object對(duì)象，通過對(duì)象的形式進(jìn)行操作。

那么對(duì)象有哪些操作呢，看文檔。

但是你會(huì)發(fā)現(xiàn)，v8確實(shí)有個(gè)Array類，繼承自O(shè)bject類。那么Array有什么方法呢？

看文檔就知道了，少的可憐：

所以，對(duì)數(shù)組的操作都將轉(zhuǎn)換為對(duì)象操作。

createObj()

說到對(duì)象了，那么我們就來寫一個(gè)創(chuàng)建對(duì)象的方法。傳遞兩個(gè)參數(shù)，一個(gè)name,一個(gè)age，創(chuàng)建一個(gè)對(duì)象，表示一個(gè)人，名叫啥，多大年紀(jì)。

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);
}

這個(gè)方法，參照文檔，基本沒啥可說的。

通過Object::New(isolate)創(chuàng)建一個(gè)對(duì)象，然后設(shè)置兩個(gè)屬性name,age，將參數(shù)依次賦值給這兩個(gè)屬性，然后返回這個(gè)對(duì)象即可。

如果用js寫：

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

callback

上面說的，都沒提到j(luò)s中一個(gè)重要的東西，回調(diào)函數(shù)。如果參數(shù)中傳一個(gè)回調(diào)函數(shù)，那么我們?cè)撊绾螆?zhí)行呢？

來一個(gè)簡單的例子。

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

這個(gè)例子很簡單，我們傳兩個(gè)數(shù)字類型參數(shù)a,b和一個(gè)回調(diào)函數(shù)fn，然后將a,b作為fn的參數(shù)調(diào)用fn回調(diào)函數(shù)。這里我們對(duì)a,b的操作轉(zhuǎn)交給回調(diào)函數(shù)?；卣{(diào)函數(shù)里我們可以求和，也可以求積，隨你。

這個(gè)例子中，暫時(shí)還沒涉及到的是如何調(diào)用回調(diào)函數(shù)。

先上代碼：

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);
}

上面三個(gè)判斷參數(shù)類型，略過。

我們定義一個(gè)Function類型屬性jsfn，將args[2]強(qiáng)制轉(zhuǎn)換為Function并賦值給jsfn。

然后定義一個(gè)具有兩個(gè)值的參數(shù)argv，這兩個(gè)值就是args[0] , args[1]的數(shù)字值。

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

argv是一個(gè)數(shù)組，其個(gè)數(shù)我們?cè)诙x時(shí)指定，2個(gè)。

Call()方法為函數(shù)類型的值進(jìn)行調(diào)用的方法。

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

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

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

總結(jié)

以上就是這篇文章的全部內(nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作能帶來一定的幫助，如果有疑問大家可以留言交流，謝謝大家對(duì)腳本之家的支持。

最新評(píng)論