0
  • 聊天消息
  • 系统消息
  • 评论与回复
登录后你可以
  • 下载海量资料
  • 学习在线课程
  • 观看技术视频
  • 写文章/发帖/加入社区
会员中心
创作中心

完善资料让更多小伙伴认识你,还能领取20积分哦,立即完善>

3天内不再提示

鸿蒙开发接口公共事件与通知:【FFI能力(Node-API)】

jf_46214456 来源:jf_46214456 作者:jf_46214456 2024-05-21 16:38 次阅读

FFI能力(N-API)

ArkUI-X中支持的N-API接口情况

Node-API是封装底层JavaScript运行时能力的一套Native接口。OpenHarmony的N-API组件对Node-API的接口进行了重新实现,ArkUI-X同样拥有这部分能力,目前支持部分接口,支持列表。

Node-API

简介

Node-API是封装底层JavaScript运行时能力的一套Native接口。

支持的能力

Node-API屏蔽了底层不同JavaScript引擎的差异,提供一套稳定的接口。

OpenHarmony的N-API组件对Node-API的接口进行了重新实现,ArkUI-X在此基础上进行了跨平台扩展,N-API接口可以在OpenHarmony/HarmonyOS/Android/iOS多个平台上使用。当前支持[Node-API]标准库中的部分接口,如下表所示。

N-API组件扩展的符号列表

开发前请熟悉鸿蒙开发指导文档 :[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]
标准库中导出的符号列表

符号类型符号名说明
FUNCnapi_module_registernapi native模块注册接口。
FUNCnapi_get_last_error_info获取napi_extended_error_info结构体,其中包含最近一次出现的error信息
FUNCnapi_throw抛出一个js value。
FUNCnapi_throw_error抛出一个带文本信息的jsError
FUNCnapi_throw_type_error抛出一个带文本信息的jsTypeError
FUNCnapi_throw_range_error抛出一个带文本信息的jsRangeError
FUNCnapi_is_error判断napi_value是否表示为一个error对象。
FUNCnapi_create_error创建并获取一个带文本信息的jsError
FUNCnapi_create_type_error创建并获取一个带文本信息的jsTypeError
FUNCnapi_create_range_error创建并获取一个带文本信息的jsRangeError
FUNCnapi_get_and_clear_last_exception获取并清除最近一次出现的异常。
FUNCnapi_is_exception_pending判断是否出现了异常。
FUNCnapi_fatal_error引发致命错误以立即终止进程。
FUNCnapi_open_handle_scope创建一个上下文环境使用。
FUNCnapi_close_handle_scope关闭传入的上下文环境,关闭后,在其中声明的全部napi_value都将被回收。
FUNCnapi_open_escapable_handle_scope创建出一个可逃逸的handel scope,可将范围内声明的值返回到父作用域。
FUNCnapi_close_escapable_handle_scope关闭传入的可逃逸的handel scope。
FUNCnapi_escape_handle提升传入的js object的生命周期到其父作用域。
FUNCnapi_create_referencenapi_value创建一个reference,提升js对象生命周期。调用者需要自己管理reference生命周期。
FUNCnapi_delete_reference删除传入的reference。
FUNCnapi_reference_ref增加传入的reference的引用计数,并获取该计数。
FUNCnapi_reference_unref减少传入的reference的引用计数,并获取该计数。
FUNCnapi_get_reference_value获取与reference相关联的jsObject
FUNCnapi_create_array创建并获取一个jsArray
FUNCnapi_create_array_with_length创建并获取一个指定长度的jsArray
FUNCnapi_create_arraybuffer创建并获取一个指定大小的jsArrayBuffer
FUNCnapi_create_external分配一个附加有外部数据的js value。
FUNCnapi_create_external_arraybuffer分配一个附加有外部数据的jsArrayBuffer
FUNCnapi_create_object创建一个默认的jsObject
FUNCnapi_create_symbol创建一个jsSymbol
FUNCnapi_create_typedarray通过现有的ArrayBuffer创建一个jsTypeArray
FUNCnapi_create_dataview通过现有的ArrayBuffer创建一个jsDataView
FUNCnapi_create_int32通过一个C的int32_t数据创建jsNumber
FUNCnapi_create_uint32通过一个C的uint32_t数据创建jsNumber
FUNCnapi_create_int64通过一个C的int64_t数据创建jsNumber
FUNCnapi_create_double通过一个C的double数据创建jsNumber
FUNCnapi_create_string_latin1通过ISO-8859-1编码的C字符串数据创建jsString
FUNCnapi_create_string_utf8通过UTF8编码的C字符串数据创建jsString
FUNCnapi_create_string_utf16通过UTF16编码的C字符串数据创建jsString
FUNCnapi_get_array_length获取array的length。
FUNCnapi_get_arraybuffer_info获取ArrayBuffer的底层data buffer及其长度。
FUNCnapi_get_prototype获取给定jsObjectprototype
FUNCnapi_get_typedarray_info获取给定TypedArray的各种属性。
FUNCnapi_get_dataview_info获取给定DataView的各种属性。
FUNCnapi_get_value_bool获取给定jsBoolean对应的C bool值。
FUNCnapi_get_value_double获取给定jsNumber对应的C double值。
FUNCnapi_get_value_external获取先前通过napi_create_external()传递的外部数据指针。
FUNCnapi_get_value_int32获取给定jsNumber对应的C int32值。
FUNCnapi_get_value_int64获取给定jsNumber对应的C int64值。
FUNCnapi_get_value_string_latin1获取给定js vaule对应的ISO-8859-1编码的字符串。
FUNCnapi_get_value_string_utf8获取给定js vaule对应的UTF8编码的字符串。
FUNCnapi_get_value_string_utf16获取给定js vaule对应的UTF16编码的字符串。
FUNCnapi_get_value_uint32获取给定jsNumber对应的C uint32值。
FUNCnapi_get_boolean根据给定的C boolean值,获取js bool对象。
FUNCnapi_get_global获取global对象。
FUNCnapi_get_null获取null对象。
FUNCnapi_get_undefined获取undefined对象。
FUNCnapi_coerce_to_bool将给定的js value强转成jsBoolean
FUNCnapi_coerce_to_number将给定的js value强转成jsNumber
FUNCnapi_coerce_to_object将给定的js value强转成jsObject
FUNCnapi_coerce_to_string将给定的js value强转成jsString
FUNCnapi_typeof获取给定js value的js type。
FUNCnapi_instanceof判断给定object是否为给定constructor的实例。
FUNCnapi_is_array判断给定js value是否为array。
FUNCnapi_is_arraybuffer判断给定js value是否为ArrayBuffer
FUNCnapi_is_typedarray判断给定js value是否表示一个TypedArray
FUNCnapi_is_dataview判断给定js value是否表示一个DataView
FUNCnapi_is_date判断给定js value是否为jsDate对象。
FUNCnapi_strict_equals判断给定的两个js value是否严格相等。
FUNCnapi_get_property_names以字符串数组的形式获取对象的可枚举属性的名称。
FUNCnapi_set_property对给定Object设置属性。
FUNCnapi_get_property获取给定Object的给定属性。
FUNCnapi_has_property判断给定对象中是否存在给定属性。
FUNCnapi_delete_property尝试从给定Object中删除给定key属性。
FUNCnapi_has_own_property判断给定Object中是否有名为key的own property。
FUNCnapi_set_named_property对给定Object设置一个给定名称的属性。
FUNCnapi_get_named_property获取给定Object中指定名称的属性。
FUNCnapi_has_named_property判断给定Object中是否有给定名称的属性。
FUNCnapi_set_element在给定Object的指定索引处,设置元素。
FUNCnapi_get_element获取给定Object指定索引处的元素。
FUNCnapi_has_element若给定Object的指定索引处拥有属性,获取该元素。
FUNCnapi_delete_element尝试删除给定Object的指定索引处的元素。
FUNCnapi_define_properties批量的向给定Object中定义属性。
FUNCnapi_type_tag_object将tag指针的值与Object关联。
FUNCnapi_check_object_type_tag判断给定的tag指针是否被关联到了jsObject上。
FUNCnapi_call_function在Native方法中调用js function,即native call js。
FUNCnapi_create_function创建native方法给js使用,以便于js call native。
FUNCnapi_get_cb_info从给定的callback info中获取有关调用的详细信息,如参数和this指针。
FUNCnapi_get_new_target获取构造函数调用的new.target
FUNCnapi_new_instance通过给定的构造函数,构建一个实例。
FUNCnapi_define_class定义与C++类相对应的JavaScript类。
FUNCnapi_wrap在js object上绑定一个native对象实例。
FUNCnapi_unwrap从js object上获取先前绑定的native对象实例。
FUNCnapi_remove_wrap从js object上获取先前绑定的native对象实例,并解除绑定。
FUNCnapi_create_async_work创建一个异步工作对象。
FUNCnapi_delete_async_work释放先前创建的异步工作对象。
FUNCnapi_queue_async_work将异步工作对象加到队列,由底层去调度执行。
FUNCnapi_cancel_async_work取消入队的异步任务。
FUNCnapi_get_node_version获取node的版本信息。
FUNCnapi_get_version获取Node运行时支持的最高 N-API 版本。
FUNCnapi_create_promise创建一个延迟对象和js promise。
FUNCnapi_resolve_deferredresolve与js promise对象关联的延迟函数。
FUNCnapi_reject_deferredreject与js promise对象关联的延迟函数。
FUNCnapi_is_promise判断给定js value是否为promise对象。
FUNCnapi_get_uv_event_loop获取当前libuv loop实例。
FUNCnapi_create_threadsafe_function创建线程安全函数。
FUNCnapi_get_threadsafe_function_context获取线程安全函数中的context。
FUNCnapi_call_threadsafe_function调用线程安全函数。
FUNCnapi_acquire_threadsafe_function指示线程安全函数可以开始使用。
FUNCnapi_release_threadsafe_function指示线程安全函数将停止使用。
FUNCnapi_ref_threadsafe_function指示在主线程上运行的事件循环在线程安全函数被销毁之前不应退出。
FUNCnapi_unref_threadsafe_function指示在主线程上运行的事件循环可能会在线程安全函数被销毁之前退出。
FUNCnapi_create_date通过一个C的double数据创建jsDate
FUNCnapi_get_date_value获取给定jsDate对应的C double值。
FUNCnapi_create_bigint_int64通过一个C的int64数据创建jsBigInt
FUNCnapi_create_bigint_uint64通过一个C的uint64数据创建jsBigInt
FUNCnapi_create_bigint_words通过一个C的uint64数组创建单个jsBigInt
FUNCnapi_get_value_bigint_int64获取给定jsBigInt对应的C int64值。
FUNCnapi_get_value_bigint_uint64获取给定jsBigInt对应的C uint64值。
FUNCnapi_get_value_bigint_words获取给定jsBigInt对应的信息,包括符号位、64位小端序数组和数组中的元素个数。
FUNCnapi_create_buffer创建并获取一个指定大小的jsBuffer
FUNCnapi_create_buffer_copy创建并获取一个指定大小的jsBuffer,并以给定数据进行初始化。
FUNCnapi_create_external_buffer创建并获取一个指定大小的jsBuffer,并以给定数据进行初始化,该接口可为Buffer附带额外数据。
FUNCnapi_get_buffer_info获取jsBuffer底层data及其长度。
FUNCnapi_is_buffer判断给定js value是否为Buffer对象。
FUNCnapi_object_freeze冻结给定的对象。
FUNCnapi_object_seal密封给定的对象。
FUNCnapi_get_all_property_names获取一个数组,其中包含此对象过滤后的属性名称。
FUNCnapi_detach_arraybuffer分离给定ArrayBuffer的底层数据。
FUNCnapi_is_detached_arraybufferHarmonyOS与OpenHarmony鸿蒙文档籽料:mau123789是v直接拿判断给定的ArrayBuffer是否已被分离过。

搜狗高速浏览器截图20240326151547.png

ArkUI-X中N-API的使用场景

在OpenHarmony中,N-API接口可以实现ArkTS/TS/JS与C/C++(Native)之间的交互。ArkUI-X在此基础上进行了跨平台的拓展,开发者可在OpenHarmony/HarmonyOS/Android/iOS多个平台上使用N-API能力,完成跨语言工程开发。ArkUI-X中的N-API典型使用场景与OpenHarmony相同,即:

  1. 通过N-API封装Native能力,暴露相应接口到ArkTS/TS/JS层,即ArkTS/TS/JS call Native。
  2. Native代码中调用ArkTS/TS/JS提供的方法,即Native call ArkTS/TS/JS。

审核编辑 黄宇

声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。 举报投诉
  • 接口
    +关注

    关注

    33

    文章

    8582

    浏览量

    151070
  • API
    API
    +关注

    关注

    2

    文章

    1499

    浏览量

    61981
  • javascript
    +关注

    关注

    0

    文章

    516

    浏览量

    53852
  • 鸿蒙
    +关注

    关注

    57

    文章

    2347

    浏览量

    42827
收藏 人收藏

    评论

    相关推荐

    鸿蒙开发接口公共事件与通知:【@ohos.commonEvent (公共事件模块)】

    本模块首批接口API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
    的头像 发表于 05-21 11:13 1091次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b><b class='flag-5'>接口</b><b class='flag-5'>公共事</b>件与<b class='flag-5'>通知</b>:【@ohos.commonEvent (<b class='flag-5'>公共事</b>件模块)】

    鸿蒙开发接口公共事件与通知:【@ohos.events.emitter (Emitter)】

    本模块首批接口API version 7开始支持。
    的头像 发表于 05-21 16:06 1360次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b><b class='flag-5'>接口</b><b class='flag-5'>公共事</b>件与<b class='flag-5'>通知</b>:【@ohos.events.emitter (Emitter)】

    鸿蒙开发接口公共事件与通知:【Notification模块】

    本模块首批接口API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
    的头像 发表于 05-21 17:04 2198次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b><b class='flag-5'>接口</b><b class='flag-5'>公共事</b>件与<b class='flag-5'>通知</b>:【Notification模块】

    鸿蒙开发接口公共事件与通知:【@ohos.reminderAgent (后台代理提醒)】

    开发应用时,开发者可以调用后台提醒发布的接口创建定时提醒,包括倒计时、日历、闹钟三种提醒类型。使用后台代理提醒能力后,应用可以被冻结或退出,计时和弹出提醒的功能将被后台系统服务代理。
    的头像 发表于 05-25 16:27 724次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b><b class='flag-5'>接口</b><b class='flag-5'>公共事</b>件与<b class='flag-5'>通知</b>:【@ohos.reminderAgent (后台代理提醒)】

    鸿蒙开发接口公共事件与通知:【application/EventHub (EventHub)】

    EventHub模块提供了事件中心,提供订阅、取消订阅、触发事件的能力
    的头像 发表于 05-25 16:31 797次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b><b class='flag-5'>接口</b><b class='flag-5'>公共事</b>件与<b class='flag-5'>通知</b>:【application/EventHub (EventHub)】

    鸿蒙开发接口公共事件与通知:【FFI能力】 N-API在Android、iOS平台应用的使用指导

    N-API接口可以实现ArkTS/TS/JS与C/C++(Native)之间的交互,ArkUI-X中支持的N-API接口情况和使用场景请见[FFI
    的头像 发表于 05-25 16:33 1917次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b><b class='flag-5'>接口</b><b class='flag-5'>公共事</b>件与<b class='flag-5'>通知</b>:【<b class='flag-5'>FFI</b><b class='flag-5'>能力</b>】 N-<b class='flag-5'>API</b>在Android、iOS平台应用的使用指导

    鸿蒙原生应用/元服务开发-通知添加行为意图

    WantAgent提供了封装行为意图的能力,这里所说的行为意图主要是指拉起指定的应用组件及发布公共事件等能力。HarmonyOS支持以通知的形式,将WantAgent从发布方传递至接收
    发表于 01-05 15:07

    基于ArkTS语言的OpenHarmony APP应用开发公共事件的订阅和发布

    /d05_CustomCommonEvent API接口:9 2、知识准备 2.1、commonEvent模块 OpenHarmony通过CES(Common Event Service,公共事件服务)为
    发表于 09-18 13:16

    HarmonyOS应用开发-公共事件处理

    开发过程中service想要控制多个ability时,可以考虑使用公共事件处理。发布无序的公共事件: //发布公共事件 同步修改卡片与页面public void subscribeE
    发表于 11-02 15:15

    HarmonyOS-API7相对API6差异主要变更内容

    条件、循环渲染、懒加载渲染,支持自定义组件。JS新增5800+的API接口,覆盖多个能力模块:新增一系列事件通知能力接口,可实现普通
    发表于 02-15 14:35

    HarmonyOS/OpenHarmony应用开发-ArkTSAPI系统能力SystemCapability

    一、 系统能力API SysCap,全称SystemCapability,即系统能力,指操作系统中每一个相对独立的特性,如包管理、公共事件、通知
    发表于 08-10 16:39

    OpenHarmony 应用开发SDK、API 与基础工具

    ArkTS 对象的能力,使用类 Node 的 N-API 接口命名。开发者使用 C/C++开发
    发表于 09-19 15:45

    鸿蒙原生应用/元服务开发-Stage模型能力接口(四)

    一、说明 AbilityStage是HAP的运行时类。AbilityStage类提供在HAP加载的时候,通知开发者,可以在此进行该HAP的初始化(如资源预加载,线程创建等)能力。 本模块首批
    发表于 12-14 15:39

    触觉智能RK3568使用体验:NAPI 类对象导出及其生命周期管理(上)

    .js Node-API 框架扩展而来。 什么是Node.js Node-API 框架 Node.js Node-API
    的头像 发表于 02-17 09:10 885次阅读

    基于ArkTS语言的OpenHarmony APP应用开发公共事件的订阅和发布

    1、程序介绍本示例主要展示了公共事件相关的功能,实现了一个检测用户部分行为的应用。具体而言,本案例实现了如下几个公共事件功能:通过订阅系统公共事件,实现对用户操作行为(亮灭屏、断联网)的监测;通过
    的头像 发表于 09-19 08:05 448次阅读
    基于ArkTS语言的OpenHarmony APP应用<b class='flag-5'>开发</b>:<b class='flag-5'>公共事</b>件的订阅和发布