零基础开发 Node.js Addons 插件：参数与返回值处理-编程学习网

实现两个整数相加

以下是使用 C 语言写的两个整数相加的函数，很简单的一个例子。

int add(int a, int b) {
  int sum = a + b;
  return sum;
}

创建项目 n-api-calculator，文件结构如下所示：

├── app.js
├── CMakeLists.txt
└── src
    └──calculator.c

编码实现

本次我们主要实现的是 calculator.c 这个文件，首先引入如下两个头文件。

#include <assert.h>
#include <node_api.h>

定义通用的参数校验宏

Node-API 提供的一些 API 都会返回 status 供我们判断本次是否操作成功，类似这样的通用判断逻辑在代码里会出现多次，在这里首先将 status 的判断封装成一个宏，如下例代码所示，第一个参数 env 为上下文信息，第二个参数 call 为传入的回调函数；

#define NAPI_STATUS_CALL(env, call)                               \
  do {                                                            \
    napi_status status = (call);                                  \
    if (status != napi_ok) {                                      \
      const napi_extended_error_info* error_info = NULL;          \
      napi_get_last_error_info((env), &error_info);               \
      bool is_pending;                                            \
      napi_is_exception_pending((env), &is_pending);              \
      if (!is_pending) {                                          \
        const char* message = (error_info->error_message == NULL) \
            ? "empty error message"                               \
            : error_info->error_message;                          \
        napi_throw_error((env), NULL, message);                   \
        return NULL;                                              \
      }                                                           \
    }                                                             \
  } while(0)

定义 addFn 函数

napi_value addFn(napi_env env, napi_callback_info info) {
  ...
}

获取 Node.js 层传递的参数

使用 Node-API 提供的 napi_get_cb_info 方法获取 napi_callback_info上下文信息，这一块是 Node.js 层调用函数时传入的参数信息，以下是 napi_get_cb_info 方法的定义：

napi_status napi_get_cb_info(
    napi_env env,
    napi_callback_info cbinfo, // 传递给回调函数的信息，这一块就是 Node.js 层传递过来的值
    size_t* argc, // 指定提供给 argv 数组的长度，并接收的参数长度。
    napi_value* argv, // 存放参数的地方，仅复制指定的 argc 数量的参数，如果少于 argc 指定的数量，其余的参数指定为 Node-API 提供的值 undefined。
    napi_value* thisArg,// 接收 JavaScript 参数 this
    void** data // 接收回调的数据指针
)

定义参数个数 argc 为 2，同样的再定义存储参数的数组 argv，重点还是 napi_get_cb_info 这个方法。

C 语言中通过 & 符号，可以取到该变量对应的内存地址，因此 argc 这个变量会随着实际的参数个数而改变。

napi_value addFn(napi_env env, napi_callback_info info) {
  size_t argc = 2;
  napi_value argv[2];

  NAPI_STATUS_CALL(env, napi_get_cb_info(env, info, &argc, argv, NULL, NULL));
}

对 Node.js 层传入的参数做校验处理

有时候我们需要对参数获取到的参数做一些校验，如果不符合我们的期望希望能抛出一些异常，Node-API 也为我们提供了一些错误信息的 API。

例如 napi_throw_type_error 抛出一个 TypeError 类型错误，n_api_napi_throw_range_error 抛出一个 RangeError 类型错误，更多信息参考 n_api_exceptions。

napi_value addFn(napi_env env, napi_callback_info info) {
  ...
  if (argc < 2) {
    napi_throw_error(env, "BadParameter", "Two parameters are required");
    return NULL;
  }
}

错误处理还有一种是获取参数的类型，做类型校验，这可以通过napi_typeof 函数获得一个参数的类型。

napi_value addFn(napi_env env, napi_callback_info info) {
  ...
  napi_valuetype argv1Type, argv2Type;
  NAPI_STATUS_CALL(env, napi_typeof(env, argv[0], &argv1Type));
  NAPI_STATUS_CALL(env, napi_typeof(env, argv[1], &argv2Type));
  if (argv1Type != napi_number || argv2Type != napi_number) {
     napi_throw_type_error(env, "ParameterTypeError", "The parameter must be of type number");
    return NULL;
  }
}

Node-API 和 C 类型互转

Node-API 类型的参数是不能直接传递到 C 函数的，这里需要一层转换，例如在 Node.js 我们要表示一个整型会用到 Number 类型，那么如果传递到 C 函数中，可以使用 Node-API 提供的函数 napi_get_value_int32() 函数转换为 C 语言中的 int 类型。遇到其它类型也是同样的方法，参考从 Node-API 转换为 C 类型的函数。

napi_value addFn(napi_env env, napi_callback_info info) {
  ...
  
  int a, b;
  NAPI_STATUS_CALL(env, napi_get_value_int32(env, argv[0], &a));
  NAPI_STATUS_CALL(env, napi_get_value_int32(env, argv[1], &b));
}

add() 这个函数是我们使用标准的 C 类型定义的，很简单的一个示例，但是道理是相同的，现在传入我们转换之后的参数 a、b 是可以正常运算的，但是 add 函数的返回值是一个 C 类型的值，因此还要从 C 类型转换到 Node-API 支持的类型。

如下例所示，使用 Node-API 提供的 napi_create_int32() 函数转换 C 类型到 Node-API 类型，类似的其它类型也是如此，参考从 C 类型转换为 Node-API 的函数。

int add(int a, int b) {
  int sum = a + b;
  return sum;
}

napi_value addFn(napi_env env, napi_callback_info info) {
  ...
  napi_value sum;
  NAPI_STATUS_CALL(env, napi_create_int32(env, add(a, b), &sum));
  return sum;
}

模块注册

模块注册在第一篇中已经讲解过了，与之类似，我们本次注册模块名称为 calculator。

napi_value init(napi_env env, napi_value exports) {
  napi_property_descriptor properties[] = {
    {
      "add",
      NULL,
      addFn,
      NULL,
      NULL,
      NULL,
      napi_default,
      NULL
    }
  };
  NAPI_STATUS_CALL(env, napi_define_properties(env, exports, 1, properties));
  return exports;
}

NAPI_MODULE(calculator, init);

CMake.js 构建

除了 node-gyp 之外(上一篇使用的是该方式)，使用 CMake.js 也是一个不错的选择，CMake.js 是基于 CMake 的构建系统，它不需要你必须安装 Python 环境。

开始之前先使用 NPM 安装 npm install -g cmake-js。

项目根目录创建一个 CMakeLists.txt 文件，写入如下内容：

CMAKE_MINIMUM_REQUIRED(VERSION 3.2 FATAL_ERROR)

# Name of the project (will be the name of the plugin)
project(calculator)

# If there are multiple files separated by spaces
# file(GLOB COMMONM_FILES "src/calculator.c src/other.c")
file(GLOB COMMONM_FILES "src/calculator.c")
    
# If it is cross-platform, please refer to the following method
# IF(WIN32)
#   file(GLOB OS_FILES "src/win.c")
# ELSE(WIN32)
#   file(GLOB OS_FILES "src/linux.c")
# ENDIF(WIN32)
# set (SOURCE_FILES ${COMMONM_FILES} ${OS_FILES})
    
set (SOURCE_FILES ${COMMONM_FILES})

# Build a shared library named after the project from the files in `src/`
add_library(${PROJECT_NAME} SHARED ${SOURCE_FILES})

# Gives our library file a .node extension without any "lib" prefix
set_target_properties(${PROJECT_NAME} PROPERTIES PREFIX "" SUFFIX ".node")

# Essential include files to build a node addon,
# You should add this line in every CMake.js based project
target_include_directories(${PROJECT_NAME} PRIVATE ${CMAKE_JS_INC})

# Essential library files to link to a node addon
# You should add this line in every CMake.js based project
target_link_libraries(${PROJECT_NAME} ${CMAKE_JS_LIB})

运行 cmake-js build，可生成一个 ./build/Release/calculator.node 文件。

应用测试

创建 app.js 可以测试下。

const { add } = require('bindings')('calculator');
// console.log(add(1)); // Error: Two parameters are required
// console.log(add('1', 2)); // TypeError: The parameter must be of type number
console.log(add(1, 2)); // 3

Reference

https://nodejs.org/api/n-api.html

https://www.linuxjournal.com/article/6700

https://discourse.urho3d.io/t/how-do-you-include-source-in-subdirectories/871/2

文章详情

零基础开发 Node.js Addons 插件：参数与返回值处理