发布你的第一个nodejs c++插件

之前分享了如何写一个nodejs的c++插件。今天分享一下如何发布一个c++插件。

github：https://github.com/theanarkh/learn-to-write-nodejs-addons

环境

1 ubuntu18.04。 2 安装nodejs v12和npm install node-gyp -g。

写代码

写一个测试的例子。test.cc

// hello.cc using N-API
#include <node_api.h>

namespace demo {

napi_value Method(napi_env env, napi_callback_info args) {
  napi_value greeting;
  napi_status status;

  status = napi_create_string_utf8(env, "world", NAPI_AUTO_LENGTH, &greeting);
  if (status != napi_ok) return nullptr;
  return greeting;
}

napi_value init(napi_env env, napi_value exports) {
  napi_status status;
  napi_value fn;

  status = napi_create_function(env, nullptr, 0, Method, nullptr, &fn);
  if (status != napi_ok) return nullptr;

  status = napi_set_named_property(env, exports, "hello", fn);
  if (status != napi_ok) return nullptr;
  return exports;
}

NAPI_MODULE(NODE_GYP_MODULE_NAME, init)

}  // namespace demo

binding.gyp

{
  "targets": [
    {
      "target_name": "test",
      "sources": [ "./test.cc" ]
    }
  ]
}

然后执行npm init。内容如下

{
  "name": "test-addons",
  "version": "1.0.1",
  "description": "",
  "main": "./build/Release/test.node",
  "scripts": {
    "test": "echo "Error: no test specified" && exit 1",
    "install": "node-gyp rebuild"
  },
  "author": "",
  "license": "ISC",
  "gypfile": true
}

我们主要看和插件相关的两个配置

"main": "./build/Release/test.node",
"gypfile": true

main定义了插件的入口，因为我们没有为用户提供js的api。而是直接提供.node文件，所以这里定义的路径为插件的路径。gypfile标记这个包是一个c++插件，用户在使用npm安装这个包的时候，就会执行node-gyp rebuild，针对用户系统环境，生成对应的二进制代码。有些文章介绍了需要在scripts的值里加入"install": "node-gyp rebuild"，npm文档说了如果包下面有.gyp文件的话，默认就会执行这个rebuild操作。

"scripts":{"install": "node-gyp rebuild"} If there is a binding.gyp file in the root of your package and you have not defined an install or preinstall script, npm will default the install command to compile using node-gyp.

一切准备就绪，我们可以执行npm publish发布了（记得先登录npm）。

测试

我们首先安装这个包。npm install test-addons --unsafe-perm（该参数可参考https://segmentfault.com/q/1010000019365121/），然后写代码测试一下。

var addon = require("test-addons/build/Release/test");
console.log(addon.hello());

我们发现，这样显然很麻烦。所以我们最好还是在包里为用户提供js模块的接口。我们在包里增加index.js

var addon = require("./build/Release/test");
module.exports = addon;

修改测试代码

var addon = require("test-addons");
console.log(addon.hello());

这就是编写和发布一个nodejs c++插件的大致流程。