HarmonyOS Node-API支持的数据类型

一、Node-API的数据类型 

1、napi_status

        是一个枚举数据类型，表示Node-API接口返回的状态信息。每当调用一个Node-API函数，都会返回该值，表示操作成功与否的相关信息。

typedef enum {
    napi_ok,
    napi_invalid_arg,
    napi_object_expected,
    napi_string_expected,
    napi_name_expected,
    napi_function_expected,
    napi_number_expected,
    napi_boolean_expected,
    napi_array_expected,
    napi_generic_failure,
    napi_pending_exception,
    napi_cancelled,
    napi_escape_called_twice,
    napi_handle_scope_mismatch,
    napi_callback_scope_mismatch,
    napi_queue_full,
    napi_closing,
    napi_bigint_expected,
    napi_date_expected,
    napi_arraybuffer_expected,
    napi_detachable_arraybuffer_expected,
    napi_would_deadlock, /* unused */
    napi_no_external_buffers_allowed,
    napi_cannot_run_js
} napi_status;

2、napi_extended_error_info

        一个结构体，在调用函数不成功时存储了较为详细的错误信息。

typedef struct {
    const char *error_message;
    void *engine_reserved;
    uint32_t engine_error_code;
    napi_status error_code;
} napi_extended_error_info;

3、napi_value

        napi_value是一个C的结构体指针，表示一个JavaScript对象的引用。napi_value持有了JS对象，同时，napi_value受handle_scope管理，scope中napi_value持有的JS对象不会被释放；出scope后，napi_value将失效，不再持有对应的JS对象。

4、napi_env

• 用于表示Node-API执行时的上下文，Native侧函数入参，并传递给函数中的Node-API接口。

• napi_env与JS线程绑定，JS线程退出后，napi_env将失效。

• 禁止缓存napi_env，禁止在不同Worker中传递napi_env。

5、napi_threadsafe_function

        napi_threadsafe_function用来创建一个线程安全的JavaScript函数，可以在不同的线程中调用。可以用于将异步操作的结果传递给JavaScript环境，例如从另一个线程中读取数据或执行计算密集型操作。此外，它还可以用于从JavaScript环境中调用C++代码中的函数，以便在另一个线程中执行。通过使用napi_threadsafe_function，可以实现JavaScript和C++之间的高效通信，同时保持线程安全性。

 6、napi_threadsafe_function_release_mode

        该枚举类型定义了两个常量，用于指定在何时释放线程安全函数的回调函数。

typedef enum {
  napi_tsfn_release,
  napi_tsfn_abort
} napi_threadsafe_function_release_mode;

// 该值会传给napi_release_threadsafe_function
napi_release_threadsafe_function(napi_threadsafe_function func,
                                 napi_threadsafe_function_release_mode mode);

• mode值为napi_tsfn_release时：表示当前线程不再调用此tsfn。

• mode值为napi_tsfn_abort时：表示除了当前线程，其他线程不能再调用此tsfn。

  如果设置为napi_tsfn_abort，利用napi_call_threadsafe_function接口调用此tsfn时将返回napi_closing，tsfn函数并不会被放入queue中。

 7、napi_threadsafe_function_call_mode

        该枚举类型定义了两个常量，用于指定线程安全函数的调用模式。

        数据结构如下所示：

typedef enum {
  napi_tsfn_nonblocking,
  napi_tsfn_blocking
} napi_threadsafe_function_call_mode;

• napi_tsfn_nonblocking：napi_call_threadsafe_function是非阻塞的，如果队列已满，则返回napi_queue_full，从而阻止数据添加到队列中。

• napi_tsfn_blocking：napi_call_threadsafe_function是阻塞的，直至队列中有空间可用。

二、内存管理类型

1、napi_handle_scope

        napi_handle_scope数据类型是用来管理JavaScript对象的生命周期的。它允许JavaScript对象在一定范围内保持活动状态，以便在JavaScript代码中使用。在创建napi_handle_scope时，所有在该范围内创建的JavaScript对象都会保持活动状态，直到结束。这样可以避免在JavaScript代码中使用已经被释放的对象，从而提高代码的可靠性和性能。

2、napi_escapable_handle_scope

• 由napi_open_escapable_handle_scope接口创建，由napi_close_escapable_handle_scope接口关闭。

• 表示一种特殊类型的句柄范围，用于将在escapable_handle_scope范围内创建的值返回给父scope。

• 用于napi_escape_handle接口，将escape_handle_scope提升到JS对象，以便在外部作用域使用。

3、napi_ref

        指向napi_value，允许用户管理JavaScript值的生命周期。

4、napi_type_tag

        该结构体定义了一个包含两个无符号64位整数的类型标签，用于标识一个Node-API值的类型信息。

typedef struct {
  uint64_t lower;
  uint64_t upper;
} napi_type_tag;

• 存储了两个无符号64位整数的128位值，用它来标记JavaScript对象，确保它们属于某种类型。

• 比napi_instanceof更强的类型检查，如果对象的原型被操纵，napi_instanceof可能会报告误报。

• type_tag与napi_wrap结合非常有用，因为它确保从包装对象检索的指针可以安全地转换为与先前应用于JavaScript对象的类型标记相对应的Native类型。

5、napi_async_cleanup_hook_handle

        napi_async_cleanup_hook_handle用于注册异步操作的回调函数。它主要用于在异步操作完成或被取消时执行清理操作，例如释放资源或撤销操作。使用napi_async_cleanup_hook_handle可以确保在异步操作完成或被取消时，相关资源得到正确的释放和清理，从而避免内存泄漏等问题。

三、回调类型

1、napi_callback_info

        Native侧获取JS侧参数信息，传递给napi_get_cb_info，用于获取JS侧入参信息。

2、napi_callback

        表示用户定义的Native函数，暴露给JavaScript，即JS侧调用的接口；一般不在此callback中创建handle或者callback scope。

typedef napi_value (*napi_callback)(napi_env, napi_callback_info);

3、napi_finalize

        函数指针，用于传入napi_create_threadsafe_function和napi_set_instance_data接口。napi_finalize在对象被回收时会被调用。

4、napi_async_execute_callback

        函数指针，用于napi_create_async_work接口。

• 异步执行的Native函数，从工作池线程调用，可与主事件循环线程并行执行。

• 函数实现中必须避免执行JavaScript或与JavaScript对象交互的Node-API调用。

• Node-API调用可以在napi_async_complete_callback中执行。

5、napi_async_complete_callback

        napi_async_complete_callback用于异步操作完成后的回调。当需要进行异步操作时，可以使用napi_create_async_work函数创建一个异步操作任务，并指定一个napi_async_complete_callback回调函数，在异步操作完成后会自动调用该回调函数，以便进行后续的处理。该回调函数的参数包括当前异步操作任务的状态和返回值等信息，可以根据这些信息进行相应的处理。

6、napi_threadsafe_function_call_js

        函数指针，在主线程中与独立线程中的JavaScript代码进行交互，从而实现更加复杂的功能，用于napi_create_threadsafe_function(napi_env env,…,napi_threadsafe_function_call_js call_js_cb,...)接口。

7、napi_cleanup_hook

        函数指针，用于napi_add_env_cleanup_hook接口，当环境销毁时会被执行。

8、napi_async_cleanup_hook

        函数指针，用于napi_add_async_cleanup_hook接口，当环境销毁时会被执行。

四、调度优先级

        QoS决定了线程调度的优先级，等级定义如下：

typedef enum {
  napi_qos_background = 0,
  napi_qos_utility = 1,
  napi_qos_default = 2,
  napi_qos_user_initiated = 3,
} napi_qos_t;

五、事件循环模式

        napi提供了运行底层事件循环的两种模式, 其定义如下：

typedef enum {
    napi_event_mode_default = 0,
    napi_event_mode_nowait = 1,
} napi_event_mode;

六、线程安全任务优先级

        napi提供了线程安全任务的优先级, 底层任务队列中的任务会根据其优先级被依次执行, 优先级的定义如下：

typedef enum {
    napi_priority_immediate = 0,
    napi_priority_high = 1,
    napi_priority_low = 2,
    napi_priority_idle = 3,
} napi_task_priority;