写点什么

如何使用 DevEco Studio 创建 Native C++ 应用

  • 2023-02-22
    上海
  • 本文字数:3167 字

    阅读完需:约 10 分钟

简介

本篇主要介绍如何使用 DevEco Studio for OpenAtom OpenHarmony (以下简称“OpenHarmony”)创建一个 Native C++应用。应用采用“Native C++”模板,实现了通过 Node-API 调用 C 标准库的功能。本示例通过调用 C 标准库接口来演示调用过程,具体接口是 C 标准库的计算两个给定数和,并将结果返回到页面展示。通过这个应用我们可以掌握 OpenHarmony 系统的 ArkTS/JS 与 C/C++混合开发。ArkTS/JS 与 C/C++ 混合开发是 OpenHarmony 系统中的一套原生模块扩展开发框架,它基于 Node.js N-API 规范开发,为开发者提供了 ArkTS/JS 与 C/C++模块之间相互调用的交互能力。这套机制对于 OpenHarmony 系统开发的价值有两方面:

1、OpenHarmony 系统可以将框架层丰富的模块功能通过 js 接口开放给上层应用使用。

2、应用开发者也可以选择将一些对性能、底层系统调用有要求的核心功能用 C/C++封装实现,再通过 js 接口使用,提高应用本身的执行效率。

效果图

实现效果如下图所示:



通过 ArkTS 编写界面,根据界面展示点击输入框输入两个数,再点击计算按钮调用接口,将数据传入到 C++端,C++端计算后再作为返回值到 ArkTS 端。

环境搭建

我们首先要完成应用开发环境的搭建,本示例运行 RK3568 开发板上。

1、 搭建应用开发环境

1.1、开始前请参考应用开发快速上手链接,完成 DevEco Studio 的安装和开发环境配置:参考链接

1.2、开发环境配置完成后,创建工程(模板选择“Native C++”),选择 JS 或者 eTS 语言开发。



2、应用调测

工程创建完成后,选择使用真机进行调测。

2.1、将搭载 OpenHarmony 标准系统的开发板与电脑连接。

2.2、点击 File> Project Structure... > Project>SigningConfigs 界面勾选“Automatically generate signature”,等待自动签名完成即可,最后点击“OK”。如下图所示:



在编辑窗口右上角的工具栏,点击"

"按钮运行。

源码结构

代码结构分析,整个工程的代码结构如下:



文件说明如下:


├── cpp:// C++代码区│   ├── types:// 接口存放文件夹│   │   └── libadd              │   │       ├── index.d.ts       // 接口文件│   │       └── package.json // 接口注册配置文件│   ├── CmakeList.text     // Cmake打包配置文件│   └── add.cpp                // C++源代码└── ets                               // ets代码区    └── Application    │   └── AbilityStage.ts  // Hap包运行时类    ├── MainAbility    │   └── MainAbility.ts   //对Ability生命周期管理    └── pages        └── index.ets            // 主页面
复制代码


C++端方法实现

C++端方法源码是工程的 entry/src/main/cpp/add.cpp 文件。

1、 注册模块

先定义一个模块,对应结构体为 napi_module,模块定义好后,调用 NAPI 提供的模块注册函数 napi_module_register(napi_module* mod)注册到系统中;参考如下示例,nm_modname 可以根据实际情况修改。


static napi_module demoModule = {    .nm_version =1,    .nm_flags = 0,    .nm_filename = nullptr,    .nm_register_func = Init,    .nm_modname = "libadd",    .nm_priv = ((void*)0),    .reserved = { 0 },};
extern "C" __attribute__((constructor)) void RegisterHelloModule(void){ napi_module_register(&demoModule);}
复制代码


2、 接口定义

接口定义是固定写法,在 napi_property_descriptor desc[]中,我们需要将编写的“hyPotC”方法(从左至右第三个参数)与对应暴露的接口“hyPot”接口(从左至右第一个参数)进行关联,其他参考示例默认填写即可。如下所示,其中 Add 对应的是 Native C++的接口,其应用端的接口对应为 add,NAPI 通过 napi_define_properties 接口将 napi_property_descriptor 结构体中的 2 个接口绑定在一起,并通过 exports 变量对外导出,使应用层可以调用 add 方法。


EXTERN_C_STARTstatic napi_value Init(napi_env env, napi_value exports){    napi_property_descriptor desc[] = {        { "add", nullptr, Add, nullptr, nullptr, nullptr, napi_default, nullptr }    };    napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc);    return exports;}EXTERN_C_END
复制代码


3、 接口实现


#include "napi/native_api.h"static napi_value Add(napi_env env, napi_callback_info info){    size_t requireArgc = 2;    size_t argc = 2;    napi_value args[2] = {nullptr};    napi_get_cb_info(env, info, &argc, args , nullptr, nullptr);    napi_valuetype valuetype0;    napi_typeof(env, args[0], &valuetype0);    napi_valuetype valuetype1;    napi_typeof(env, args[1], &valuetype1);    double value0;    napi_get_value_double(env, args[0], &value0);    double value1;    napi_get_value_double(env, args[1], &value1);    napi_value sum;    napi_create_double(env, value0 + value1, &sum);    return sum;}
复制代码


4、 接口对外配置

4.1、修改 index.d.ts 用于对外提供方法、说明(名字可以更改,点击方法可以直接链接到 index.d.ts)。


export const add: (a: number, b: number) => number;
复制代码


4.2、在 package.json 文件中将 index.d.ts 与 cpp 文件关联起来。


{  "name": "libadd.so",  "types": "./index.d.ts"}
复制代码


4.3、CMakeLists.txt 配置 CMake 打包参数,CMakeLists.txt 是 CMake 打包的配置文件,里面的大部分内容无需修改,project、add_library 方法中的内容可以根据实际情况修改。


# the minimum version of CMake.cmake_minimum_required(VERSION 3.4.1)project(MyApplication)
set(NATIVERENDER_ROOT_PATH ${CMAKE_CURRENT_SOURCE_DIR})
include_directories(${NATIVERENDER_ROOT_PATH} ${NATIVERENDER_ROOT_PATH}/include)
add_library(add SHARED add.cpp)target_link_libraries(add PUBLIC libace_napi.z.so)
复制代码


ArkTS 端实现

界面整体规划效果如下图所示:



界面实现部分代码,具体请查看源码(见参考链接源码路径)。


@Entry@Componentstruct Index {  ...  build() {    Row() {      Column() {      }      .width('100%')    }    .height('100%')  }}
复制代码


ArkTS 调用 C++方法流程

在 ArkTS 调用 C++流程的过程中,需要使用到 Node_API、Cmake 等工具来做中间转换,整个流程如下:



(1) add.cpp 源码用来编写 C++代码,并通过 index.d.ts 文件对外提供接口。

(2) C++代码通过 Cmake 打包工具打包成动态链接库 SO 文件。

(3) arkTs 端 index.ets 源码通过引入 SO 包的方式去调用 SO 文件中的接口,最终通过 hivgor 一起打包成可执行的 xxx.hap 包。

1、导入 SO 包

在 index.ets 文件中引入编译好的 SO 包。


import libAdd from 'libadd.so'
复制代码


2、添加点击事件

Button 组件添加点击事件,调用 libadd.so 中的方法。


Button(this.buttonSubmit)    .fontSize(40)    .fontWeight(FontWeight.Bold)    .margin({top:5})    .height(100)    .width(200)    .onClick(() => {        this.result = libAdd.add(this.num1,this.num2) })
复制代码


3、hivgor 打包

hivgor 打包将 SO 文件与 eTS 代码一起打包成 hap 包。

4、安装 hap 包

点击"

"按钮安装 hap 包运行。

总结

通过本篇介绍,我们了解了 C++代码如何与 ArkTS 实现关联,ArkTS 如何调用 SO 包中的接口等,同时也掌握了 C++代码的具体编写与打包流程。

参考链接

DevEco Studio 安装和开发环境配置

https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/quick-start/start-overview.md#%E5%B7%A5%E5%85%B7%E5%87%86%E5%A4%87

源码路径

https://gitee.com/openharmony-sig/knowledge/tree/knowledge/typical_demo/NativeApp

NAPI 课程学习路径

https://gitee.com/openharmony-sig/knowledge_demo_temp/tree/master/docs/napi%E7%B3%BB%E5%88%97%E5%AD%A6%E4%B9%A0



用户头像

OpenHarmony开发者官方账号 2021-12-15 加入

OpenHarmony是由开放原子开源基金会(OpenAtom Foundation)孵化及运营的开源项目,目标是面向全场景、全连接、全智能时代,基于开源的方式,搭建一个智能终端设备操作系统的框架和平台,促进万物互联产业的繁荣发展

评论

发布
暂无评论
如何使用DevEco Studio创建Native C++应用_OpenHarmony_OpenHarmony开发者_InfoQ写作社区