N-API整理

一, 函數管理

提供了一組方法,來實現C++方法被調用 和 去調用js方法的功能

1.調用JavaScript方法

/**

* @param env 環境上下文

* @param jsthis 傳遞給被調用函數的this類型,普通調用,默認使用的全局window對象

* @param func 要調用的方法對象

* @param argc 傳遞給被調用方法的參數數量

* @param argv 傳遞的參數列表,是一個napi_value 的數組形式

* @param result 被喚起的方法,的返回結果

* @return 返回napi_status 來判斷該方法是否執行成功

**/

napi_status napi_call_function(napi_env env,

napi_value recv,

napi_value func,

int argc,

const napi_value* argv,

napi_value* result)

example

//全局對象下存在該方法

// function AddTwo(num) {

// return num + 2;

// }

//在全局對象下獲取AddTwo方法

napi_value global, add_two, arg;

//獲取全局對象

napi_status status = napi_get_global;

assert(status == napi_ok);

//使用全局對象獲取函數方法

status = napi_get_named_property(env, global, "AddTwo", &add_two);

assert(status == napi_ok);

//創建參數

status = napi_create_int32(env, 1200, &arg);

assert(status == napi_ok);

napi_value* argv = &arg;

size_t argc = 1;

//創建return_value 存儲返回的數據類型

napi_value return_val;

//調用方法

status = napi_call_function(env, global, add_two, argc, argv, &return_val);

assert(status == napi_ok);

//獲取執行結果

int32_t = result;

status = napi_get_value_int32(env, return_val, &result);

assert(status == napi_ok);

2.創建JavaScript方法

該函數創建一個共給JavaScript調用的方法, 創建之後,該方法必須通過掛載一個對象暴露出去

/**

* @param env 環境上下文

* @param uft8name 創建的方法名

* @param length 方法名的長度,可以使用NAPI_AUTO_LENGTH 來自動處理

* @param cb 綁定的C++方法

* @param data 用戶提供的數據上下文

* @param result 執行結果

* @return 返回napi_status 來判斷該方法是否執行成功

**/

napi_status napi_create_function(napi_env env,

const char* utf8name,

size_t length,

napi_callback cb,

void* data,

napi_value* result);

example

//const myaddon = require('./addon');

//myaddon.sayHello();

napi_value SayHello(napi_env env, napi_callback_info info) {

printf("Hello\n");

return NULL;

}

napi_value Init(napi_env env, napi_value exports) {

napi_status status;

napi_value fn;

//創建一個方法

status = napi_create_function(env, NULL, 0, SayHello, NULL, &fn);

if (status != napi_ok) return NULL;

//掛載到exports上,對外暴露

status = napi_set_named_property(env, exports, "sayHello", fn);

if (status != napi_ok) return NULL;

return exports;

}

NAPI_MODULE(NODE_GYP_MODULE_NAME, Init)

napi_get_cb_info

獲取JavaScript傳遞的參數

/**

* @param env 環境上下文

* @param cbinfo 函數信息

* @param argc 參數長度

* @param argv 參數內容,以napi_value 數組形式

* @param thisArg 接收JavaScript 中的this 參數

* @param data 接收一個回調的數據指針

* @return 返回執行結果

**/

napi_status napi_get_cb_info(napi_env env,

napi_callback_info cbinfo,

size_t* argc,

napi_value* argv,

napi_value* thisArg,

void** data)

napi_get_new_target

當使用new 關鍵字創建對象時,返回一個 實例的對象, 其他情況返回一個NULL

/**

* @param env 環境上下文

* @parma cbinfo 函數信息

* @param result 創建結果

* @return 返回執行結果

**/

napi_status napi_get_new_target(napi_env env,

napi_callback_info cbinfo,

napi_value* result)

napi_new_instance

通過一個給定的napi_value值, 創建一個新的JavaScript實例。

//function MyObject(param) {

// this.param = param;

//}

//const arg = 'hello';

//const value = new MyObject(arg);

// Get the constructor function MyObject

napi_value global, constructor, arg, value;

//獲取全局對象

napi_status status = napi_get_global(env, &global);

if (status != napi_ok) return;

//獲取JavaScript對象的引用

status = napi_get_named_property(env, global, "MyObject", &constructor);

if (status != napi_ok) return;

// const arg = "hello" 創建字符參數

status = napi_create_string_utf8(env, "hello", NAPI_AUTO_LENGTH, &arg);

if (status != napi_ok) return;

napi_value* argv = &arg;

size_t argc = 1;

// const value = new MyObject(arg) 使用一個引用,創建一個實例

status = napi_new_instance(env, constructor, argc, argv, &value);

二, 生命週期

1. 生命週期短於原生方法

napi_open_handle_scope

創建一個新的作用域

/**

* @param env 環境上下文

* @param scope 作用域變量

* @return 返回執行結果

**/

NAPI_EXTERN napi_status napi_open_handle_scope(napi_env env,

napi_handle_scope* result);

napi_close_handle_scope

關閉一個作用域

/**

* @param env 環境上下文

* @param scope 作用域變量

* @return 返回執行結果

**/

NAPI_EXTERN napi_status napi_open_handle_scope(napi_env env,

napi_handle_scope* result);

napi_open_escapable_handle_scope

創建可逃逸的作用域

/**

* @param env 環境上下文

* @param scope 作用域

* @return 返回執行結果

**/

NAPI_EXTERN napi_status

napi_open_escapable_handle_scope(napi_env env,

napi_handle_scope* result);

napi_close_escapable_handle_scope

關閉可逃逸的作用域

/**

* @param env 環境上下文

* @param scope 作用域

* @return 返回執行結果

**/

NAPI_EXTERN napi_status

napi_close_escapable_handle_scope(napi_env env,

napi_handle_scope scope);

napi_escape_handle

逃脫作用方法

/**

* @param env 環境上下文

* @param scope 作用域

* @param escape 要逃脫的對象

* @param result 輸出逃脫對象的指針

* @return 返回執行結果

**/

napi_status napi_escape_handle(napi_env env,

napi_escapable_handle_scope scope,

napi_value escapee,

napi_value* result);

2. 生命週期長與原生方法

napi_create_reference

創建引用

/**

* @param env 環境上下文

* @param value 需要創建引用的對象

* @param initial_refcount 初始化計數器

* @param result 綁定的引用變量

* @return 返回執行結果

**/

NAPI_EXTERN napi_status napi_create_reference(napi_env env,

napi_value value,

int initial_refcount,

napi_ref* result);

napi_delete_reference

刪除引用

/**

* @param env 環境變量

* @param ref 引用

* @return 返回執行結果

**/

NAPI_EXTERN napi_status napi_delete_reference(napi_env env, napi_ref ref);

napi_reference_ref

遞增計數值(+1),並獲取

/**

* @param env 環境上下文

* @param ref 引用變量

* @param result 計數值

* @return 返回執行結果

**/

NAPI_EXTERN napi_status napi_reference_ref(napi_env env,

napi_ref ref,

int* result);

napi_reference_unref

減少計數值(-1), 並獲取

/**

* @param env 環境上下文

* @param 引用變量

* @param result 計數值

* @return 返回執行結果

**/

NAPI_EXTERN napi_status napi_reference_unref(napi_env env,

napi_ref ref,

int* result);

napi_get_reference_value

只是獲取計數值

/**

* @param env 環境上下文

* @param ref 引用變量

* @param result 計數值

* @return 返回執行結果

**/

NAPI_EXTERN napi_status napi_get_reference_value(napi_env env,

napi_ref ref,

napi_value* result);

3. 退出與清理實例

napi_add_env_cleanup_hook

在引用退出時,使用指定的參數arg調用函數func, 不同的arg 和相同的func 可以被註冊多次,但是相同的arg 和 func 不能被註冊多次

/**

* @param env 環境上下文

* @param fun 註冊的函數指針

* @param arg 參數指針

* @return 返回執行結果

**/

NAPI_EXTERN napi_status napi_remove_env_cleanup_hook(napi_env env,

void (*fun)(void* arg),

void* arg);


分享到:


相關文章: