如何在Windows下开发NodeJS的C/C++原生扩展

Posted 2023-03-18

一、编写Node.js原生扩展

Node.js是一个强大的平台，理想状态下一切都都可以用javascript写成。然而，你可能还会用到许多遗留的库和系统，这样的话使用c++编写Node.JS扩展会是一个不错的注意。

以下所有例子的源代码可在node扩展示例中找到 。

编写Node.js C + +扩展很大程度上就像是写V8的扩展； Node.js增加了一些接口，但大部分时间你都是在使原始的V8数据类型和方法，为了理解以下的代码，你必须首先阅读V8引擎嵌入指南。

Javascript版本的Hello World

在讲解C++版本的例子之前，先让我们来看看在Node.js中用Javascript编写的等价模块是什么样子。这是一个最简单的Hello World，也不是通过HTTP，但它展示了node模块的结构，而其接口也和大多数C++扩展要提供的接口差不多：

HelloWorldJs = function()

this.m_count = 0;

;

HelloWorldJs.prototype.hello = function()



this.m_count++;

return “Hello World”;

;

exports.HelloWorldJs = HelloWorldJs;

正如你所看到的，它使用prototype为HelloWorldJs类创建了一个新的方法。请注意，上述代码通过将HelloWorldJS添加到exports变量来暴露构造函数。

要在其他地方使用该模块，请使用如下代码：

var helloworld = require(‘helloworld_js’);

var hi = new helloworld.HelloWorldJs();

console.log(hi.hello()); // prints “Hello World” to stdout

C++版本的Hello World

要开始编写C++扩展，首先要能够编译Node.js（请注意，我们使用的是Node.js 2.0版本）。本文所讲内容应该兼容所有未来的0.2.x版本。一旦编译安装完node，编译模块就不在需要额外的东西了。

完整的源代码可以在这里找到 。在使用Node.js或V8之前，我们需要包括相关的头文件：

#include <v8.h>

#include <node.h>

using namespace node;

using namespace v8;

在本例子中我直接使用了V8和node的命名空间，使代码更易于阅读。虽然这种用法和谷歌的自己的C++编程风格指南相悖，但由于你需要不停的使用V8定义的类型，所以目前为止的大多数node的扩展仍然使用了V8的命名空间。

接下来，声明HelloWorld类。它继承自node::ObjectWrap类 ，这个类提供了几个如引用计数、在V8内部传递contex等的实用功能。一般来说，所有对象应该继承ObjectWrap：

class HelloWorld: ObjectWrap



private:

int m_count;

public:

声明类之后，我们定义了一个静态成员函数，用来初始化对象并将其导入Node.js提供的target对象中。设个函数基本上是告诉Node.js和V8你的类是如何创建的，和它将包含什么方法：

static Persistent<FunctionTemplate> s_ct;

static void Init(Handle<Object> target)



HandleScope scope;

Local<FunctionTemplate> t = FunctionTemplate::New(New);

s_ct = Persistent<FunctionTemplate>::New(t);

s_ct->InstanceTemplate()->SetInternalFieldCount(1);

s_ct->SetClassName(String::NewSymbol(“HelloWorld”));

NODE_SET_PROTOTYPE_METHOD(s_ct, “hello”, Hello);

target->Set(String::NewSymbol(“HelloWorld”),

s_ct->GetFunction());



在上面这个函数中target参数将是模块对象，即你的扩展将要载入的地方。（译著：这个函数将你的对象及其方法连接到
这个模块对象，以便外界可以访问）首先我们为New方法创建一个FunctionTemplate，将于稍后解释。我们还为该对象添加一个内部字段，并命
名为HelloWorld。然后使用NODE_SET_PROTOTYPE_METHOD宏将hello方法绑定到该对象。最后，一旦我们建立好这个函数模板后，将他分配给target对象的HelloWorld属性，将类暴露给用户。

接下来的部分是一个标准的C++构造函数：

HelloWorld() :

m_count(0)





~HelloWorld()





接下来，在::New 方法中V8引擎将调用这个简单的C++构造函数：

static Handle<Value> New(const Arguments& args)



HandleScope scope;

HelloWorld* hw = new HelloWorld();

hw->Wrap(args.This());

return args.This();



此段代码相当于上面Javascript代码中使用的构造函数。它调用new HelloWorld
创造了一个普通的C++对象，然后调用从ObjectWrap继承的Wrap方法，
它将一个C++HelloWorld类的引用保存到args.This()的值中。在包装完成后返回args.This()，整个函数的行为和
javascript中的new运算符类似，返回this指向的对象。

现在我们已经建立了对象，下面介绍在Init函数中被绑定到hello的函数：

static Handle<Value> Hello(const Arguments& args) 参考技术A 编写node的C/C++原生扩展
[1]打开Windows命令行cmd.exe，进入D:\node-v0.10.5，执行vcbuild.bat release，最后会在D:\node-v0.10.5\Release目录下可以找到编译好的node.exe、node.lib等文件。
[2]制作编译安装批处理文件，此处命名为nodins.bat，文件内容如下：

@echo off
if "%1"=="" goto help
mkdir "%1"
mkdir "%1"\include

copy /y src\node.h "%1"\include
copy /y src\node_object_wrap.h "%1"\include
copy /y src\node_buffer.h "%1"\include
copy /y src\node_version.h "%1"\include

copy /y deps\v8\include\*.h "%1"\include\

copy /y deps\uv\include\*.h "%1"\include\

mkdir "%1"\include\uv-private
copy /y deps\uv\include\uv-private\*.h "%1"\include\uv-private

mkdir "%1"\include\ev
copy /y deps\uv\src\ev\*.h "%1"\include\ev

mkdir "%1"\include\c-ares
copy /y deps\uv\include\ares.h "%1"\include\c-ares
copy /y deps\uv\include\ares_version.h "%1"\include\c-ares

mkdir "%1"\lib
copy /y Release\node.lib "%1"\lib

copy /y Release\node.exe "%1"

echo =================================
echo Install succeefully!
goto exit

if not errorlevel 0 echo Error "install-path" & goto exit

:help
echo nodins.bat install-path

:exit

[3]打开Windows命令行cmd.exe，切换 进入D:\node-v0.10.5目录。将文件nodins.bat拷贝到D:\node-v0.10.5中，在命令行执行：nodins.bat D:\nodejs，则生成编译C/C++扩展的编译环境（包括头文件、库和可执行文件）D:\nodejs目录，内容如下：

[4]用Visual Studio 2010创建一个DLL工程空白工程hellonode放在D:\目录下，新建项目—>win32控制台程序，然后进入如下页面：

[5]创建一个C++文件如hellonode.cpp，代码如下：

#define BUILDING_NODE_EXTENSION
#include <node.h>

using namespace v8;

Handle<Value> Hello(const Arguments& args)
HandleScope scope;
return scope.Close(String::New("Hello world!"));


Handle<Value> Add(const Arguments& args)
HandleScope scope;

if (args.Length() < 2)
ThrowException(Exception::TypeError(String::New("Wrong number of arguments")));
return scope.Close(Undefined());


if (!args[0]->IsNumber() || !args[1]->IsNumber())
ThrowException(Exception::TypeError(String::New("Wrong arguments")));
return scope.Close(Undefined());


Local<Number> num = Number::New(args[0]->NumberValue() +
args[1]->NumberValue());
return scope.Close(num);


void init(Handle<Object> target)
NODE_SET_METHOD(target, "hello", Hello);
NODE_SET_METHOD(target, "add", Add);


NODE_MODULE(hellonode, init)

[6]在工程属性的配置属性-常规中将输出目录改为.\；

[7]在工程属性的配置属性-常规中将目标文件扩展名改为.node；

[8]在工程属性的配置属性-C/C++-常规-附加包含目录添加头文件目录为：D:\nodejs\include

[9]在工程属性的配置属性-链接器-常规-附加库目录添加目录：D:\nodejs\lib

[10]在工程属性的配置属性-链接器-输入-附加依赖项添加lib库：node.lib

[11]编译生成后在D:\hellonode\hellonode中生成一个文件hellonode.node；
[12]在D:\hellonode目录创建js测试代码test.js，代码如下：
var addons = require('./hellonode');
console.log('C/C++ addons.hello() =', addons.hello());
console.log('C/C++ addons.add(200, 300) =', addons.add(200, 300));

[13]在命令行执行node .\test.js（若未配置node.exe的路径变量，则执行：D:\nodejs\node .\test.js） 参考技术B 北漂的心酸，公众号，最新node.js从入门到精通及服务器搭建课程