社区编辑申请
注册/登录
OpenHarmony 源码解析之 JavaScriptAPI NAPI-C 接口
开发 前端
NAPI机制在整个OpenHarmony系统中起着承上启下的重要作用,而框架代码中C实现的比例也很大,尤其是对接驱动这方面。

想了解更多内容,请访问:

51CTO和华为官方合作共建的鸿蒙技术社区

https://harmonyos.51cto.com

1 简介

在《OpenHarmony 源码解析之JavaScript API框架(NAPI)》一文提到,NAPI就是L2设备上的 JS API实现方式。对OpenHarmony提供的NAPI的设计思想、编程原则、Sample源码等已做说明,本文不再赘述。

NAPI机制在整个OpenHarmony系统中起着承上启下的重要作用,而框架代码中C实现的比例也很大,尤其是对接驱动这方面。

本文主要呈现的是NAPI之C接口的极简方式实现范例,适合初学者了解打通NAPI流程。

1.1 UI架构相关系列

《OpenHarmony 源码解析之ACE (JavaScript运行环境初始化)》

《OpenHarmony 源码解析之JavaScript API框架(NAPI)》

《OpenHarmony 源码解析之JavaScript API框架(NAPI-C接口)》

《OpenHarmony 源码解析之JavaScript(文件管理API)》

1.2 OpenHarmony架构图

#星光计划2.0# OpenHarmony 源码解析之JavaScriptAPI NAPI-C接口-鸿蒙HarmonyOS技术社区

1.3 NAPI概念回顾

NAPI在系统中位置示意图如下:

 #星光计划2.0# OpenHarmony 源码解析之JavaScriptAPI NAPI-C接口-鸿蒙HarmonyOS技术社区

从图中可以得出,NAPI就是JS与C/C++之间的调用方式。

1.4 NAPI 实现方式

OpenHarmony上NAPI实现方式有两种,分别是:

  • NAPI之C接口
  • NAPI之C++接口

两者的特点与区别见下图:

#星光计划2.0# OpenHarmony 源码解析之JavaScriptAPI NAPI-C接口-鸿蒙HarmonyOS技术社区

2 NAPI之C接口

2.1 实现过程解析

2.1.1 编译构建

  • 增加子系统

源码/build/subsystem_config.json中增加子系统选项,如下所示:

  1. "sample": { 
  2.     "project""hmf/sample"
  3.     "path""foundation/sample"
  4.     "name""sample"
  5.     "dir""foundation" 
  6.   } 
  • 修改产品定义

源码/productdefine/common/products/Hi3516DV300.json中增加part选项

  1. "sample:sample_show":{} 
  • 增加样例ohos.build文件

源码路径新增/foundation/sample/sample_show/ohos.build文件,定义子系统为sample,组件为sample_show,文件内容如下:

  1.   "subsystem""sample",     
  2.   "parts": {     
  3.     "sample_show": {     
  4.       "module_list": [   
  5.         "//foundation/sample/sample_show/interfaces/kits/js/declaration:sample_show",               "//foundation/sample/sample_show/interfaces/kits/napi:napi_packages"
  6.       ]  
  7.     }    
  8.   }  
  • 增加样例BUILD.gn文件

源码路径新增/foundation/sample/sample_show/interfaces/kits/napi/sample/sample_show/BUILD.gn文件,定义动态库名称为sample,对应的源文件为sample.cpp, 则生成的动态库名为libsample.z.so,烧录后可以到/system/lib/下找到对应的动态库。

  1. ohos_shared_library("sample") { 
  2.     include_dirs = [] 
  3.     sources = [ 
  4.         "sample.cpp"
  5.     ] 

2.1.2 源码编写

  • 增加NAPI模块sampleModule的注册

通过Register()注册后,sampleModule对应的NAPI接口才能被编译到系统中,应用才能对接口进行调用。

  1. extern "C" __attribute__((constructor)) void Register()  
  2.     {    
  3.         napi_module_register(&sampleModule);     
  4.     } 
  • 新增模块的定义

sampleModule全局变量定义了当前NAPI模块对应的模块名sample,以及当前模块对外接口注册函数SampleExport。

  1. static napi_module sampleModule = {  
  2.     .nm_version = 1,     
  3.     .nm_flags = 0,   
  4.     .nm_filename = nullptr,  
  5.     .nm_register_func = SampleExport,    
  6.     .nm_modname = "sample",  
  7.     .nm_priv = ((void*)0),   
  8.     .reserved = { 0 },   
  9. }; 
  • 新增模块的对外接口

在模块对外接口SampleExport中,增加NAPI接口定义,对于C语言的NAPI只需增加属性即可napi_define_properties,不需要定义类。

  1. static napi_value SampleExport(napi_env env, napi_value exports) 
  2.     static napi_property_descriptor desc[] = { 
  3.         DECLARE_NAPI_FUNCTION("test", JSTest), 
  4.         DECLARE_NAPI_FUNCTION("onCallback", JSCallback), 
  5.     };     
  6.  
  7.     napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc); 
  8.     return exports; 
  • 新增NAPI接口实现函数

样例中增加了两个接口,分别是:test、onCallback;

**test:**接口使用场景为JS调用C相关函数;

**onCallback:**接口使用场景为JS定义了一个回调函数JSFuncA,某个时机触发后,通过C语言调用JSFuncA进行回调处理。

  1. DECLARE_NAPI_FUNCTION("test", JSTest), 
  2.   DECLARE_NAPI_FUNCTION("onCallback", JSCallback), 

2.2 接口解析

2.2.1 JS->C 接口解析

JS调用的C接口定义:function test(para1: number): void;

具体NAPI的实现如下:

  1. static napi_value JSTest(napi_env env, napi_callback_info info) 
  2.     { 
  3.     size_t argc = 1; //参数个数定义 
  4.     napi_value argv[argc]; 
  5.     napi_value thisVar = nullptr; 
  6.     void *data = nullptr; 
  7.  
  8.     NAPI_CALL(env, napi_get_cb_info(env, info, &argc, argv, &thisVar, &data)); 
  9.     NAPI_ASSERT(env, argc >= 1, "JSTest Wrong number of arguments"); //参数个数校验 
  10.  
  11.     napi_value result = nullptr; 
  12.     napi_create_int32(env, 0, &result); 
  13.  
  14.     int cPara1; //定义接口入参对应的C语言变量 
  15.     for(size_t i= 0; i< argc; i++){ 
  16.  
  17.         //参数类型校验 
  18.         napi_valuetype valueType = napi_undefined; 
  19.         napi_typeof(env, argv[i], &valueType);       
  20.         NAPI_ASSERT(env, valueType == napi_number, "JSTest Wrong argument type. Number expected for parameter 1."); 
  21.          
  22.         if(i== 0) { 
  23.             //JS参数转换为C语言参数,打印其值 
  24.             napi_get_value_int32(env, argv[i], &cPara1); 
  25.             SAMPLE_LOG("JSTest cPara1 value = %{public}d!", cPara1); 
  26.          }else
  27.             SAMPLE_LOG("JSTest napi_get_value error!"); 
  28.             return result; 
  29.         } 
  30.      } 
  31.  
  32.     cFunction(cPara1); //调用框架层对应的c函数,C语言参数传递到对应的C语言函数中     
  33.     return result; 

2.2.2 C->JS 接口解析

C调用JS接口函数定义:function JSCallback(callback: Function): void;

入参即为JS的回调函数,实现如下所示:

  1. static napi_value JSCallback(napi_env env, napi_callback_info info) 
  2. {     
  3.  
  4.    size_t argc = 1; //参数个数定义 
  5.    napi_value argv[argc]; 
  6.    napi_value thisVar = nullptr; 
  7.    void *data = nullptr; 
  8. napi_ref CallbackRef; 
  9. napi_value jsObj, prop1, callback = nullptr; 
  10.  
  11.    NAPI_CALL(env, napi_get_cb_info(env, info, &argc, argv, &thisVar, &data)); 
  12.    NAPI_ASSERT(env, argc >= 1, "JSCallback Wrong number of arguments"); //参数个数校验 
  13.  
  14.    napi_valuetype callbackType = napi_undefined; 
  15.    napi_typeof(env, argv[0], &callbackType); 
  16.    NAPI_ASSERT(env, callbackType == napi_function, "parameter 1 type mismatch"); //参数类型校验,传进来的须是函数类型 
  17.          
  18. napi_create_reference(env, argv[0], 1, &CallbackRef);  //创建引用 
  19. napi_get_reference_value(env, CallbackRef, &callback); //根据引用获取回调函数callback 
  20.  
  21. int cPara = 1; 
  22. napi_create_object(env, &jsObj); //创建JS回调函数对应的参数对象 
  23. napi_create_int32(env, cPara, &prop1); 
  24. napi_set_named_property(env, jsObj, "prop", prop1); //设置JS参数对象属性值   
  25.  
  26. napi_call_function(env, nullptr, callback, 1, &jsObj, &undefine); //使用生成的JS参数,调用对应的JS回调函数        
  27.  
  28.    napi_value result = nullptr; 
  29.    napi_get_undefined(env, &result); 
  30.    return result;  
  31.    } 

3 应用代码示例

JS应用引用NAPI接口时,须先引用接口定义的对应模块,才能进行接口的调用。示例如下:

  1. //此处库名须与2.1.1.4 节BUILD.gn中定义的库名一致 
  2.    import sample from '@ohos.sample'  
  3.    ...... 
  4.    onTest: function () { 
  5.       console.log("sample.test start"
  6.       sample.test(2); //JS调用napi接口  
  7.       console.log("sample.test end"
  8.    }, 
  9.    ...... 

4 总结

NAPI在OpenHarmony应用开发中必不可少,本文档抛砖引玉介绍了NAPI之C语言接口的极简实现方式,方便大家入门,后续随着学习的深入将不断完善对NAPI接口实现方式的解读。

文章相关附件可以点击下面的原文链接前往下载

https://harmonyos.51cto.com/resource/1550

想了解更多内容,请访问:

51CTO和华为官方合作共建的鸿蒙技术社区

https://harmonyos.51cto.com

 

责任编辑:jianghua 来源: 鸿蒙社区
相关推荐

2021-12-08 15:07:51

2022-06-13 14:18:39

电源管理子系统耗电量服务

2021-09-16 15:08:08

2022-02-14 14:47:11

2022-06-07 10:33:29

Camera组件鸿蒙

2022-01-10 15:30:11

2022-04-06 11:27:05

harmonyeTS 开发NAPI开发

2021-11-08 15:04:47

2022-05-11 15:08:52

驱动开发系统移植

2022-04-02 20:45:04

Hi3516开发板操作系统鸿蒙

2022-04-15 14:31:02

鸿蒙操作系统

2021-09-13 15:15:18

2022-04-18 10:37:01

鸿蒙操作系统开发工具

2022-05-24 15:06:57

AbilityeTS FA鸿蒙

2022-04-20 20:28:40

HDF 驱动框架鸿蒙操作系统

2022-06-06 10:55:51

本地服务鸿蒙

2022-05-24 15:55:37

避障小车华为

2022-05-24 15:22:09

网络安全企业风险

2022-05-25 07:11:13

2022-06-15 16:16:21

分布式数据库鸿蒙

同话题下的热门内容

哪个版本的JVM最快?无代码软件发展简史及未来趋势携程基于 GraphQL 的前端 BFF 服务开发实践为什么会存在 1px 问题?怎么解决?一文搞定常考Vue-Router知识点EcmaScript 2022 正式发布,有哪些新特性?一文详解|增长那些事儿远程医疗:优势、前景和现有IT解决方案

编辑推荐

太厉害了,终于有人能把TCP/IP协议讲的明明白白了!牛人5次面试腾讯不成功的经验HBase原理–所有Region切分的细节都在这里了Javascript如何监听页面刷新和关闭事件如何搭建一个HTTPS服务端
我收藏的内容
点赞
收藏

51CTO技术栈公众号