Node.js plug-ins_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 は正しく動作しません)

• 作る

• C コンパイラ ツール チェーン (gpp や g など)

たとえば、Ubuntu では次のコマンドを使用して上記のプロジェクトをすべてインストールできます (Python 2.7 がプリインストールされている必要があります):

sudo apt-get install build-essentials 

Windows システム環境では、次のものが必要です:

• Python (バージョン 2.7.3、3.x は正しく動作しません)

• Microsoft Visual Studio C 2010 (Windows XP/Vista 用)

• Microsoft Visual Studio C 2012 for Windows デスクトップ (Windows 7/8 用)

Visual Studio の Express バージョンも正常に動作することを強調します。

binding.gyp ファイル

このファイルは、プラグインに適切なビルド ファイルを生成するために、node-gyp によって使用されます。ここをクリックすると、Wikipedia が提供する .gyp ファイルのドキュメントを表示できますが、今日使用する例は非常に単純なので、次のコードを使用するだけです:

{ 
  "targets": [ 
    { 
      "target_name": "stdstring", 
      "sources": [ "addon.cc", "stdstring.cc" ] 
    } 
  ] 
}

target_name は任意に設定できます。ソース配列には、プラグインが使用する必要があるすべてのソース ファイルが含まれています。この例では、プラグインと stdstring.cc のコンパイルに必要なコードを含めるために使用される addon.cc に加えて、ラッパー クラスも含めています。

STDStringWrapper クラス

最初のステップは、stdstring.h ファイルに独自のクラスを定義することです。 C プログラミングに慣れている場合は、次の 2 行のコードに慣れていないはずはありません。

#ifndef STDSTRING_H 
#define STDSTRING_H

これは標準のインクルード ガードです。次に、次の 2 つのヘッダーを include カテゴリに含める必要があります:

#include
#include
最初のインクルードは std::string クラス用で、2 番目のインクルードは Node と V8 に関連するすべてのものです。

このステップが完了したら、独自のクラスを宣言できます。

クラス STDStringWrapper : public Node::ObjectWrap {
プラグインに含める予定のすべてのクラスについて、node::ObjectWrap クラスを拡張する必要があります。

これで、このクラスのプライベート プロパティの定義を開始できます:

private: 
  std::string* s_; 
  
  explicit STDStringWrapper(std::string s = ""); 
  ~STDStringWrapper();

コンストラクターと解析関数に加えて、std::string のポインターを定義する必要もあります。これは、C/C コード ベースと Node のインターフェイスに使用できるテクノロジーの核心です。C/C クラスのプライベート ポインターを定義し、このポインターを使用して後続のすべてのメソッドで操作を実装します。

ここで、V8 で作成したクラスに関数を提供するコンストラクターの静的プロパティを宣言します。

静的 v8::永続コンストラクター
興味のある友人は、ここをクリックして、テンプレートの説明プランを参照して詳細を確認してください。

ここで New メソッドも必要になります。これは前述のコンストラクターに割り当てられ、V8 がクラスを初期化します。

static v8::Handle New(const v8::Arguments& args);
V8 で動作するすべての関数は、次の要件に従う必要があります。v8::Arguments オブジェクトへの参照を受け入れ、v8::Handle>v8::Value> を返します。これは、厳密に型指定された C コーディング V8 を使用しているものです。弱い型指定の JavaScript を一貫して処理します。

この後、他の 2 つのメソッドをオブジェクトのプロトタイプに挿入する必要もあります。

static v8::Handle add(const v8::Arguments& args); 
static v8::Handle toString(const v8::Arguments& args);

toString() メソッドを使用すると、通常の JavaScript 文字列で使用する場合、[Object object] の値の代わりに s_ の値を取得できます。

最後に、初期化メソッドを導入し (このメソッドは V8 によって呼び出され、コンストラクター関数に割り当てられます)、インクルード ガードをオフにします。

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