node-gyp编译c++编写的node扩展

Posted 2022-12-02 luffy5459

    node有一个模块addon，翻译过来，是插件，但是有的地方也叫扩展，这部分是用c++来编写的，最后可以通过node-gyp来针对各个平台编译适合自己平台的扩展，做到了跨平台。而编译后的这部分，node可以直接调用，无需额外代码。

    而通过node-gyp编译，在windows下，需要msbuild环境，可以直接安装visual studio 2017，也可以通过npm install -g windows-build-tools来安装，另外，还需要python环境，这个对python版本没有要求，只要有就可以。既然是node-gyp编译，自然需要全局安装node-gyp，最简单的还是npm install -g node-gyp。

    下面通过一个简单的示例来演示，node如何编译以及调用c++扩展。

     先准备一个c++代码，hello_world.cc

#include <node.h>

void Method(const v8::FunctionCallbackInfo<v8::Value>& args) 
  v8::Isolate* isolate = args.GetIsolate();
  args.GetReturnValue().Set(v8::String::NewFromUtf8(
      isolate, "world").ToLocalChecked());


void Initialize(v8::Local<v8::Object> exports) 
  NODE_SET_METHOD(exports, "hello", Method);


NODE_MODULE(NODE_GYP_MODULE_NAME, Initialize)

    这里定义了一个返回值为world的函数hello，通过关键字exports,module我们大概知道，这类似于node模块对外暴露方法：module.exports = hello 

     binding.gyp

  "targets": [
    
      "target_name": "hello_world",
      "sources": [ "hello_world.cc" ]
    
  ]

     callhello.js

const binding = require('./build/Release/hello_world');
console.log(binding.hello());

    这里我们通过require引入的是hello_world.node模块，他是通过node-gyp build生成的。 

     package.json

  "dependencies": 
    "java": "^0.12.2"
  ,
  "scripts": 
    "start": "node callhello.js",
	"build":"node-gyp configure && node-gyp build"
  

    在命令行下先运行构建命令：

npm run build

 

    可以看到用到了系统安装的python 、visual studio 2017编译环境。 

    最后生成一个hello_world.node的扩展。

    执行调用：

 

    这种调用的确很简单，但是对环境要求很高，需要从源码编译。而编写c++扩展，它不是纯c的内容，它需要严重依赖node库，api侵入很深，基本上借助c++来写了一个贴合node语言的扩展，所以在调用的时候，直接require就可以使用了。

    以前我写过c++动态链接库，然后通过node调用，这种动态库，完全脱离了node api，纯粹使用c来实现，但是最后编译成动态库，node还需要通过三方库ffi来调用，就没有那么方便了。

    node扩展偏向于node  api，适合熟悉node的人编写，最后调用也简单。动态库，偏向于c原生的语法，适合熟悉c/c++的人编写，最后生成的动态链接库需要三方ffi依赖调用，显然复杂度更高一些。