如何從C++ Addon角度上看Napi的實現

這篇文章主要介紹“如何從C++ Addon角度上看Napi的實現”，在日常操作中，相信很多人在如何從C++ Addon角度上看Napi的實現問題上存在疑惑，小編查閱了各式資料，整理出簡單好用的操作方法，希望對大家解答”如何從C++ Addon角度上看Napi的實現”的疑惑有所幫助！接下來，請跟著小編一起來學習吧！

1 導出給js使用的功能

#include <node_api.h> NAPI_MODULE(NODE_GYP_MODULE_NAME, Init)

上面的代碼是使用napi時的通用模式，我們只需要實現Init函數就行(當然也可以叫其他名字)。接下來我們看看Init的實現。

napi_value Init(napi_env env, napi_value exports) {   napi_value func;   // 創建一個函數并且設置為exports對象的getArray屬性的值   napi_create_function(env,                       NULL,                       NAPI_AUTO_LENGTH,                       newArray,                       NULL,                       &func);   napi_set_named_property(env, exports, "getArray", func);   return exports; }

napi_create_function也是napi提供的api，他的作用是創建一個函數，具體可以參考napi的文檔。接著把這個函數導出給js使用，名字是getArray。當js執行getArray的時候就會執行newArray函數。

2 newArray的實現

static napi_value newArray(napi_env env, napi_callback_info info) {    size_t argc = 1;    napi_value args[1];    // 拿到js層的入參，這里是一個    napi_get_cb_info(env, info, &argc, args, NULL, NULL);    int len;    // js傳入的是一個數字，v8轉成了對象，這里再次把入參轉成int型    napi_get_value_int32(env, args[0], &len);    napi_value ret;    // 創建一個數組    napi_create_array(env, &ret);    // 根據js入參設置數組的初始值    for (int i = 0; i < len; i++) {      napi_value num;      napi_create_int32(env, i, &num);      napi_set_element(env, ret, i, num);    }    return ret; }

3 使用c++ addon

const { getArray } = require('./build/Release/test.node'); console.log(getArray(20));

執行上面代碼最后輸出

[    0,  1,  2,  3,  4,  5,  6,    7,  8,  9, 10, 11, 12, 13,   14, 15, 16, 17, 18, 19 ]

4 分析

上面的代碼并不復雜，本文主要是分析napi提供的api，看看napi到底做了什么。很多api的原理是類似的，這里只以數組的api為例子。因為v8的api中，使用的參數基本都是v8提供的對象。napi做的事情其實就是幫我們處理這些對象的轉換。我們首先看看napi_create_array的實現。

// 創建一個數組，對應js的數組 napi_status napi_create_array(napi_env env, napi_value* result) {   // 調用v8接口v8::Array::New創建一個數組對象，然后轉成napi的類型，并設置返回值   *result = v8impl::JsValueFromV8LocalValue(v8::Array::New(env->isolate));   return napi_clear_last_error(env); }

我們看到napi_create_array的實現非常簡單，就是對v8接口的封裝，然后轉換成napi的類型，最后清除錯誤信息。這是napi典型的api使用方式。主要包括下面幾個

1 入參需要傳入env對象，并傳入一個二級指針napi_value  *，用于保存接口返回值。napi的返回值不是通過函數體的return返回的，return返回的是api的執行狀態(成功或失敗)。

2 處理v8的api

3 清除或返回錯誤信息  每次執行napi提供的api時，如果執行出錯則通過napi_set_last_error設置到env中并返回錯誤碼，如果沒有則通過napi_clear_last_error清除錯誤信息并返回napi_ok。我們看一下實現

// 設置當前函數調用的錯誤信息 static inline napi_status napi_set_last_error(napi_env env, napi_status error_code,                                 uint32_t engine_error_code = 0,                                 void* engine_reserved = nullptr) {   env->last_error.error_code = error_code;   env->last_error.engine_error_code = engine_error_code;   env->last_error.engine_reserved = engine_reserved;   return error_code; }  // 清除上次調用的錯誤信息 static inline napi_status napi_clear_last_error(napi_env env) {   env->last_error.error_code = napi_ok;    // TODO(boingoing): Should this be a callback?   env->last_error.engine_error_code = 0;   env->last_error.engine_reserved = nullptr;   return napi_ok; }

調用方在調用完api后，如果產生了錯誤，則可以通過napi_get_last_error_info接口獲取執行api的錯誤信息。

// 獲取上一個調用函數的錯誤信息 napi_status napi_get_last_error_info(napi_env env,                                      const napi_extended_error_info** result) {   // 初始化為非法值   const int last_status = napi_detachable_arraybuffer_expected;   // 根據錯誤碼設置錯誤描述信息（每次調用api后調用結果存到env中）   env->last_error.error_message =       error_messages[env->last_error.error_code];    *result = &(env->last_error);   return napi_ok; }

言歸正傳，調用napi_create_array后，我們拿到一個返回值，比如下面的ret。

napi_value ret; napi_create_array(env, &ret);

之前分析過napi_value本質上是一個一級指針。接著我們看如何使用從napi中拿到的數組。我們可以通過napi_set_element設置數組的內容。

// ret是數組，i是索引，num是一個napi_value變量，本質是一個v8對象，即索引對應的值 napi_set_element(env, ret, i, num);

下面我們看看napi_set_element的實現。

// 設置key對應的值，key是數字 napi_status napi_set_element(napi_env env,                              napi_value object,                              uint32_t index,                              napi_value value) {   v8::Local<v8::Context> context = env->context();   v8::Local<v8::Object> obj;   // 把napi_value object轉成v8的Object，數組繼承Object   CHECK_TO_OBJECT(env, context, obj, object);   // 把值napi_value value轉成v8對象   v8::Local<v8::Value> val = v8impl::V8LocalValueFromJsValue(value);   // 調用v8 Object對象的Set方法設置對象的屬性，即數組的元素   auto set_maybe = obj->Set(context, index, val);   // 執行結果處理   RETURN_STATUS_IF_FALSE(env, set_maybe.FromMaybe(false), napi_generic_failure);    return GET_RETURN_STATUS(env); }

從上面的分析中，我們大致可以看到napi實現中的一些規律，get的api的邏輯是調用v8接口拿到v8類型的對象，然后轉成napi_value類型返回給調用方，set的api是傳入napi_value類型，然后轉成v8類型的對象。

到此，關于“如何從C++ Addon角度上看Napi的實現”的學習就結束了，希望能夠解決大家的疑惑。理論與實踐的搭配能更好的幫助大家學習，快去試試吧！若想繼續學習更多相關知識，請繼續關注億速云網站，小編會繼續努力為大家帶來更多實用的文章！