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는 제대로 작동하지 않음)

• 만들기

• 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용)

• Windows 데스크톱용 Microsoft Visual Studio C 2012(Windows 7/8용)

Visual Studio의 Express 버전도 정상적으로 작동한다는 점을 강조합니다.

binding.gyp 파일

이 파일은 node-gyp에서 플러그인에 적합한 빌드 파일을 생성하는 데 사용됩니다. 여기를 클릭하시면 위키피디아에서 제공하는 .gyp 파일 문서를 보실 수 있지만, 오늘 사용할 예제는 매우 간단하므로 다음 코드를 사용하시면 됩니다.

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

target_name은 원하는 대로 설정할 수 있습니다. 소스 배열에는 플러그인이 사용해야 하는 모든 소스 파일이 포함되어 있습니다. 이 예에서는 플러그인과 stdstring.cc를 컴파일하는 데 필요한 코드를 포함하는 데 사용되는 addon.cc와 래퍼 클래스도 포함합니다.

STDStringWrapper 클래스

첫 번째 단계는 stdstring.h 파일에 자체 클래스를 정의하는 것입니다. C 프로그래밍에 익숙하다면 다음 두 줄의 코드도 전혀 낯설지 않을 것입니다.

#ifndef STDSTRING_H 
#define STDSTRING_H

표준 포함 가드입니다. 다음으로, 다음 두 헤더를 포함 카테고리에 포함해야 합니다.

#포함
#포함
첫 번째는 std::string 클래스용이고 두 번째 포함은 Node 및 V8과 관련된 모든 것에 대한 것입니다.

이 단계가 완료되면 자체 클래스를 선언할 수 있습니다.

클래스 STDStringWrapper : 공개 노드::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를 일관되게 처리합니다.

이후에는 객체의 프로토타입에 두 가지 다른 메서드도 삽입해야 합니다.

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