建站
咨詢
售后
建站咨詢
新聞中心
實現兩個整數相加
以下是使用 C 語言寫的兩個整數相加的函數，很簡單的一個例子。
int add(int a, int b) {
int sum = a + b;
return sum;
}創(chuàng)建項目 n-api-calculator，文件結構如下所示：
├── app.js
├── CMakeLists.txt
└── src
└──calculator.c
編碼實現
本次我們主要實現的是 calculator.c 這個文件，首先引入如下兩個頭文件。
#include
#include
定義通用的參數校驗宏
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 環(huán)境。
開始之前先使用 NPM 安裝 npm install -g cmake-js。
項目根目錄創(chuàng)建一個 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 文件。
應用測試
創(chuàng)建 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)); // 3Reference
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
文章標題：零基礎開發(fā)Node.jsAddons插件：參數與返回值處理
標題來源：http://m.fisionsoft.com.cn/article/djhdopo.html
