一, 函數(shù)管理
提供了一組方法摊溶，來實(shí)現(xiàn)C++方法被調(diào)用 和 去調(diào)用js方法的功能
1.調(diào)用JavaScript方法
/**
* @param env 環(huán)境上下文
* @param jsthis 傳遞給被調(diào)用函數(shù)的this類型，普通調(diào)用瘾婿，默認(rèn)使用的全局window對(duì)象
* @param func 要調(diào)用的方法對(duì)象
* @param argc 傳遞給被調(diào)用方法的參數(shù)數(shù)量
* @param argv 傳遞的參數(shù)列表，是一個(gè)napi_value 的數(shù)組形式
* @param result 被喚起的方法,的返回結(jié)果
* @return 返回napi_status 來判斷該方法是否執(zhí)行成功
**/
napi_status napi_call_function(napi_env env,
napi_value recv,
napi_value func,
int argc,
const napi_value* argv,
napi_value* result)
example
//全局對(duì)象下存在該方法
// function AddTwo(num) {
// return num + 2;
// }
//在全局對(duì)象下獲取AddTwo方法
napi_value global, add_two, arg;
//獲取全局對(duì)象
napi_status status = napi_get_global;
assert(status == napi_ok);
//使用全局對(duì)象獲取函數(shù)方法
status = napi_get_named_property(env, global, "AddTwo", &add_two);
assert(status == napi_ok);
//創(chuàng)建參數(shù)
status = napi_create_int32(env, 1200, &arg);
assert(status == napi_ok);
napi_value* argv = &arg;
size_t argc = 1;
//創(chuàng)建return_value 存儲(chǔ)返回的數(shù)據(jù)類型
napi_value return_val;
//調(diào)用方法
status = napi_call_function(env, global, add_two, argc, argv, &return_val);
assert(status == napi_ok);
//獲取執(zhí)行結(jié)果
int32_t = result;
status = napi_get_value_int32(env, return_val, &result);
assert(status == napi_ok);
2.創(chuàng)建JavaScript方法
該函數(shù)創(chuàng)建一個(gè)共給JavaScript調(diào)用的方法稍坯， 創(chuàng)建之后俊鱼，該方法必須通過掛載一個(gè)對(duì)象暴露出去
/**
* @param env 環(huán)境上下文
* @param uft8name 創(chuàng)建的方法名
* @param length 方法名的長度，可以使用NAPI_AUTO_LENGTH 來自動(dòng)處理
* @param cb 綁定的C++方法
* @param data 用戶提供的數(shù)據(jù)上下文
* @param result 執(zhí)行結(jié)果
* @return 返回napi_status 來判斷該方法是否執(zhí)行成功
**/
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;
//創(chuàng)建一個(gè)方法
status = napi_create_function(env, NULL, 0, SayHello, NULL, &fn);
if (status != napi_ok) return NULL;
//掛載到exports上锹安，對(duì)外暴露
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傳遞的參數(shù)
/**
* @param env 環(huán)境上下文
* @param cbinfo 函數(shù)信息
* @param argc 參數(shù)長度
* @param argv 參數(shù)內(nèi)容短荐，以napi_value 數(shù)組形式
* @param thisArg 接收J(rèn)avaScript 中的this 參數(shù)
* @param data 接收一個(gè)回調(diào)的數(shù)據(jù)指針
* @return 返回執(zhí)行結(jié)果
**/
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
當(dāng)使用new 關(guān)鍵字創(chuàng)建對(duì)象時(shí)，返回一個(gè) 實(shí)例的對(duì)象叹哭， 其他情況返回一個(gè)NULL
/**
* @param env 環(huán)境上下文
* @parma cbinfo 函數(shù)信息
* @param result 創(chuàng)建結(jié)果
* @return 返回執(zhí)行結(jié)果
**/
napi_status napi_get_new_target(napi_env env,
napi_callback_info cbinfo,
napi_value* result)
napi_new_instance
通過一個(gè)給定的napi_value值, 創(chuàng)建一個(gè)新的JavaScript實(shí)例忍宋。
//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;
//獲取全局對(duì)象
napi_status status = napi_get_global(env, &global);
if (status != napi_ok) return;
//獲取JavaScript對(duì)象的引用
status = napi_get_named_property(env, global, "MyObject", &constructor);
if (status != napi_ok) return;
// const arg = "hello" 創(chuàng)建字符參數(shù)
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) 使用一個(gè)引用，創(chuàng)建一個(gè)實(shí)例
status = napi_new_instance(env, constructor, argc, argv, &value);
二, 生命周期
1. 生命周期短于原生方法
napi_open_handle_scope
創(chuàng)建一個(gè)新的作用域
/**
* @param env 環(huán)境上下文
* @param scope 作用域變量
* @return 返回執(zhí)行結(jié)果
**/
NAPI_EXTERN napi_status napi_open_handle_scope(napi_env env,
napi_handle_scope* result);
napi_close_handle_scope
關(guān)閉一個(gè)作用域
/**
* @param env 環(huán)境上下文
* @param scope 作用域變量
* @return 返回執(zhí)行結(jié)果
**/
NAPI_EXTERN napi_status napi_open_handle_scope(napi_env env,
napi_handle_scope* result);
napi_open_escapable_handle_scope
創(chuàng)建可逃逸的作用域
/**
* @param env 環(huán)境上下文
* @param scope 作用域
* @return 返回執(zhí)行結(jié)果
**/
NAPI_EXTERN napi_status
napi_open_escapable_handle_scope(napi_env env,
napi_handle_scope* result);
napi_close_escapable_handle_scope
關(guān)閉可逃逸的作用域
/**
* @param env 環(huán)境上下文
* @param scope 作用域
* @return 返回執(zhí)行結(jié)果
**/
NAPI_EXTERN napi_status
napi_close_escapable_handle_scope(napi_env env,
napi_handle_scope scope);
napi_escape_handle
逃脫作用方法
/**
* @param env 環(huán)境上下文
* @param scope 作用域
* @param escape 要逃脫的對(duì)象
* @param result 輸出逃脫對(duì)象的指針
* @return 返回執(zhí)行結(jié)果
**/
napi_status napi_escape_handle(napi_env env,
napi_escapable_handle_scope scope,
napi_value escapee,
napi_value* result);
2. 生命周期長與原生方法
napi_create_reference
創(chuàng)建引用
/**
* @param env 環(huán)境上下文
* @param value 需要?jiǎng)?chuàng)建引用的對(duì)象
* @param initial_refcount 初始化計(jì)數(shù)器
* @param result 綁定的引用變量
* @return 返回執(zhí)行結(jié)果
**/
NAPI_EXTERN napi_status napi_create_reference(napi_env env,
napi_value value,
int initial_refcount,
napi_ref* result);
napi_delete_reference
刪除引用
/**
* @param env 環(huán)境變量
* @param ref 引用
* @return 返回執(zhí)行結(jié)果
**/
NAPI_EXTERN napi_status napi_delete_reference(napi_env env, napi_ref ref);
napi_reference_ref
遞增計(jì)數(shù)值（+1）话速，并獲取
/**
* @param env 環(huán)境上下文
* @param ref 引用變量
* @param result 計(jì)數(shù)值
* @return 返回執(zhí)行結(jié)果
**/
NAPI_EXTERN napi_status napi_reference_ref(napi_env env,
napi_ref ref,
int* result);
napi_reference_unref
減少計(jì)數(shù)值（-1）, 并獲取
/**
* @param env 環(huán)境上下文
* @param 引用變量
* @param result 計(jì)數(shù)值
* @return 返回執(zhí)行結(jié)果
**/
NAPI_EXTERN napi_status napi_reference_unref(napi_env env,
napi_ref ref,
int* result);
napi_get_reference_value
只是獲取計(jì)數(shù)值
/**
* @param env 環(huán)境上下文
* @param ref 引用變量
* @param result 計(jì)數(shù)值
* @return 返回執(zhí)行結(jié)果
**/
NAPI_EXTERN napi_status napi_get_reference_value(napi_env env,
napi_ref ref,
napi_value* result);
3. 退出與清理實(shí)例
napi_add_env_cleanup_hook
在引用退出時(shí)讶踪，使用指定的參數(shù)arg調(diào)用函數(shù)func, 不同的arg 和相同的func 可以被注冊(cè)多次，但是相同的arg 和 func 不能被注冊(cè)多次
/**
* @param env 環(huán)境上下文
* @param fun 注冊(cè)的函數(shù)指針
* @param arg 參數(shù)指針
* @return 返回執(zhí)行結(jié)果
**/
NAPI_EXTERN napi_status napi_remove_env_cleanup_hook(napi_env env,
void (*fun)(void* arg),
void* arg);
