零基础开发 Node.js Addons 插件：实现一个跨平台 sleep 函数

通过前两节已知道怎么去写一个简单的 Node.js Addons 插件，包括接收参数、类型转换等，之前插件编译我们只考虑了一个平台，但是实际中我们调用 C/C++ 的一些函数，有可能会涉及到不同平台，那么在编译时也要根据平台选择编译。

以简单易理解为主，我们知道 Node.js 里是没有 sleep 这样的系统函数，这也是因为其是单线程的缘故，如果主线程睡眠了，后面的操作就只能等待了，因此我们经常使用 setTimeout 来模拟延迟执行的任务，但也可以借助 C/C++ 里面提供的一些函数来为 Node.js 实现一个 sleep 函数，也可以选择在工作线程中使用。

编码实现

这个示例可参考 GitHub https://github.com/qufei1993/easy-sleep。

项目结构

src 目录下的文件是我们重点要去做的，可以看到有 Linux 也有 Windows。

├── binding.gyp
├── index.d.ts
├── index.js
├── package.json
├── src
│   ├── sleep.h
│   ├── sleep_init.c
│   ├── sleep_linux.c
│   └── sleep_win.c

核心编码实现

sleep_init.c

这是我们初始化的入口文件，看过前两节的这个就不陌生了，这个文件主要做模块的注册、导出我们定义的方法。

有两点需要注意 #include "sleep.h" 这个宏定义是我们自己实现的，代码中 os_usleep() 这个函数是在这个文件中定义的，继续往下看。

#include "sleep.h"
#include <node_api.h>
napi_value usleepFn(napi_env env, napi_callback_info info) {
  size_t argc = 1;
  napi_value argv[1];
  NAPI_STATUS_CALL(env, napi_get_cb_info(env, info, &argc, argv, NULL, NULL));
  if (argc < 1) {
    napi_throw_type_error(env, NULL, "microseconds is required");
    return NULL;
  }
  napi_valuetype valueType;
  napi_typeof(env, argv[0], &valueType);
  if (valueType != napi_number) {
    napi_throw_type_error(env, NULL, "microseconds must be a number");
    return NULL;
  }
  int64_t microseconds;
  NAPI_STATUS_CALL(env, napi_get_value_int64(env, argv[0], &microseconds));
  // Return 0 on success, return -1 on error
  int usleepRes = os_usleep(microseconds);
  napi_value result;
  NAPI_STATUS_CALL(env, napi_create_int64(env, usleepRes, &result));
  return result;
}
napi_value init(napi_env env, napi_value exports) {
  napi_property_descriptor descriptor = {
    "usleep",
    NULL,
    usleepFn,
    NULL,
    NULL,
    NULL,
    napi_default,
    NULL
  };
  NAPI_STATUS_CALL(env, napi_define_properties(env, exports, 1, &descriptor));
  return exports;
}
NAPI_MODULE(sleep, init);

sleep.h

NAPI_STATUS_CALL 这个和之前一样忽略掉，这里重点就是对函数 os_usleep() 的声明，通常在 C/C++ 程序中建议把所有的常量、宏、函数原型写在头文件中，实现是在引入该头文件的地方，后续当我们需要掉用一些函数，只要引用这个头文件即可。

#include <node_api.h>
#define NAPI_STATUS_CALL(env, call)                               \
  ...
int os_usleep(unsigned int microseconds);

sleep_linux.c

Linux 系统下睡眠函数的实现，usleep() 单位是微秒，需要引入 unistd.h 头文件。

#include "sleep.h"
#include <unistd.h>
int os_usleep(unsigned int microseconds) {
  // Return 0 on success, return -1 on error
  int usleepRes = usleep(microseconds);
  return usleepRes;
}

sleep_win.c

Windows 下需要引入 windows.h 头文件，注意首字母为大写，单位为毫秒。

#include "sleep.h"
#include <windows.h>
/**
 * The unit of Windows system Sleep() is microseconds
 */
int os_usleep(unsigned int microseconds) {
  unsigned int miliseconds = microseconds / 1000;
  Sleep(miliseconds);
  return 0;
}

构建

创建 bingding.gyp 文件

sources 是加载所有 C 源码，具体编译哪些文件，还需通过 conditions 判断，根据不同的系统从 sources 中排除，如下所示：

{
  "targets": [
    {
      "target_name": "easy-sleep",
      "sources": [
        "src/sleep_init.c",
        "src/sleep.h",
        "src/sleep_win.c",
        "src/sleep_linux.c"
      ],
      "conditions": [
        [
          'OS == "win"', {
            "sources!": ["src/sleep_linux.c"]
          },
          'OS != "win"', {
            "sources!": ["src/sleep_win.c"]
          }
        ]
      ]
    }
  ]
}

编译

项目根目录执行如下命令，进行编译。

node-gyp configure build

测试

和第一讲的方式一样，创建 app.js 文件，引入我们编译之后的 .node 文件，因为我们在 C 里面实现时单位微秒，所以要在转换下。

const { usleep  } = require('./build/Release/easy-sleep.node');
console.log(1)
usleep(2000 * 1000); // 等待 2 秒
console.log(2)

总结

上述还有一个不完美的地方就是构建 C 源码部分，通常必须要求用户本地也有一个能够编译 C/C++ 代码的环境，例如我们使用 node-gyp 工具在 Linux 系统要安装 Python、GCC，Windows 系统同样也要安装相应的构建环境，对于用户来说是一个极大的障碍，总不能要求用户同样也安装这些工具。

如果我们想实现跨平台支持，又无需用户在本地安装 C/C++ 工具链该怎么做？可以自己先思考下，也可以关注下节内容，node-pre-gyp 结合 Github Actions 预先构建二进制包。