HarmonyOS鸿蒙最新【坚果派-坚果】Napi入门_libace_napi(1)，HarmonyOS鸿蒙 studio用户界面设计

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化的资料的朋友，可以戳这里获取

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

设置 libentry.so 库和 index.d.ts 相关联，便于在 TS 文件中引入 libentry.so 时调用库中的相关方法。

CMakeLists.txt解读

CMake 是一个开源跨平台的构建工具，旨在构建、测试和打包软件，CMake 是 makefile 的上层工具，用于跨平台构建环境，生成可移植的 makefile 并简化自动动手写 makefile 的工作量，在 cpp 目录下默认生成的 CMakeLists.txt 内容如下所示：

the minimum version of CMake.

声明使用 CMAKE 的最小版本号

cmake_minimum_required(VERSION 3.4.1)

声明项目的名称

project(oh_0400_napi)

set命令，格式为set(key value)，表示设置key的值为value，其中value可以是路径，也可以是许多文件。

本例中设置NATIVERENDER_ROOT_PATH的值为${CMAKE_CURRENT_SOURCE_DIR}

set(NATIVERENDER_ROOT_PATH ${CMAKE_CURRENT_SOURCE_DIR})

添加项目编译所需要的头文件的目录

include_directories(${NATIVERENDER_ROOT_PATH}
${NATIVERENDER_ROOT_PATH}/include)

生成目标库文件libentry.so，entry表示最终的库名称，SHARED表示生成的是动态链接库，

hello.cpp表示最终生成的libentry.so中所包含的源码

如果要生成静态链接库，把SHARED该成STATIC即可

add_library(entry SHARED hello.cpp)

把libentry.so链接到libace_napi.z.so上

target_link_libraries(entry PUBLIC libace_napi.z.so)

hello.cpp解读

在 cpp 目录下默认生成的 hello.cpp 文件，源码如下所示：

#include “napi/native_api.h”
#include <js_native_api.h>
#include <js_native_api_types.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;

}

EXTERN_C_START
static 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

static napi_module demoModule = {
.nm_version =1,
.nm_flags = 0,
.nm_filename = nullptr,
.nm_register_func = Init,
.nm_modname = “entry”,
.nm_priv = ((void*)0),
.reserved = { 0 },
};

extern “C” __attribute__((constructor)) void RegisterEntryModule(void)
{
napi_module_register(&demoModule);
}

hello.cpp 的代码不是很复杂，我们可以做如下拆分：

• 引入头文件

#include “napi/native_api.h”
#include <js_native_api.h>
#include <js_native_api_types.h>

引入头文件，作用和 TS 里的 import 类似，不再详述。

• 注册napi模块

static napi_module demoModule = {
.nm_version =1,//nm_version：nm版本号，默认值为 1。
.nm_flags = 0,//nm标记符，默认值为 0。
.nm_filename = nullptr,//暂不关注，使用默认值即可。
.nm_register_func = Init,//指定nm的入口函数。
.nm_modname = “entry”,//指定 TS 页面导入的模块名，例如：import testNapi from 'libentry.so' 中的 testNapi
//就是当前的nm_modname。
.nm_priv = ((void*)0),//暂不关注，使用默认值即可。
.reserved = { 0 },//暂不关注，使用默认值即可。
};

extern “C” __attribute__((constructor)) void RegisterEntryModule(void)
{
napi_module_register(&demoModule);
}

定义 NAPI 模块，类型为 napi_module 结构体，各字段说明如下：

• nm_version：nm版本号，默认值为 1。
• nm_flags：nm标记符，默认值为 0。
• nm_filename：暂不关注，使用默认值即可。
• nm_register_func：指定nm的入口函数。
• nm_modname：指定 TS 页面导入的模块名，例如：import testNapi from 'libentry.so' 中的 testNapi 就是当前的nm_modname。
• nm_priv：暂不关注，使用默认值即可。
• reserved：暂不关注，使用默认值即可。extern "C" 简单理解就是告诉编译器这部分代码按照 C 语言进行编译而不是 C++ 语言编译。__attribute__((constructor)) 声明方法的执行时机，它表示 RegisterEntryModule() 方法在 main() 方法执行前执行， RegisterEntryModule() 方法内调用了 napi_module_register() 方法，该方法是 NAPI 提供的模块注册方法，表示把定义的 demoModule 模块注册到系统中。

• 方法定义

EXTERN_C_START
static 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

Init() 方法内声明了 napi_property_descriptor 结构体，结构体的定义看第一个和第三个参数即可，第一个参数 add 表示应用层 JS 声明的方法，Add 表示 Native C++ 实现的方法，然后调用 NAPI 的 napi_define_properties() 方法将 add 和 Add 做个映射，最后通过 exports 变量对外导出，实现 JS 端调用 add 方法时进而调用到 C++ 的 Add() 方法。

• 方法实现

static napi_value Add(napi_env env, napi_callback_info info)
{
// 获取 2 个参数，napi_value是对 JS 类型的封装
size_t requireArgc = 2;
size_t argc = 2;
napi_value args[2] = {nullptr};
// 调用napi_get_cb_info方法，从 info 中读取传递进来的参数放入args里
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);

// 调用napi_get_value_double把 napi_value 类型转换成 C++ 的 double 类型
double value0;
napi_get_value_double(env, args[0], &value0);
double value1;
napi_get_value_double(env, args[1], &value1);

// 调用napi_create_double方法把 C++类型转换成 napi_value 类型
napi_value sum;
napi_create_double(env, value0 + value1, &sum);

// 返回 napi_value 类型
return sum;

}

Add() 方法注释的很清楚，首先从 napi_callback_info 中读取 napi_value 类型的参数放入到 args 中，然后从 args 中读取参数并把 napi_value 类型转换成 C++ 类型后进行加操作，最后把相加的结果转换成 napi_value 类型并返回。

• 模块导入

import testNapi from ‘libentry.so’

根据前边的编译配置，cpp 目录下的源码最终打包成了 libentry.so，使用前直接引入即可。

• 方法调用

import hilog from ‘@ohos.hilog’;
import testNapi from ‘libentry.so’

@Entry
@Component
struct Index {
@State message: string = ‘Hello World’

build() {
Row() {
Column() {
Text(this.message)
.fontSize(50)
.fontWeight(FontWeight.Bold)
.onClick(() => {
this.message = “值为”+testNapi.add(2, 3)
hilog.info(0x0000, ‘testTag’, ‘Test NAPI 2 + 3 = %{public}d’, testNapi.add(2, 3));

})
}
.width(‘100%’)
}
.height(‘100%’)
}
}

引入 libentry.so 模块后，就可以直接调用 add() 方法了。

NAPI数据类型

napi_value数据类型

OpenHarmony NAPI 将 ECMAScript 标准中定义的 Boolean、Null、Undefined、Number、BigInt、String、Symbol和 Object 这八种数据类型以及函数对应的 Function 类型统一封装成了 napi_value 类型，它是 JS 数据类型和 C/C++ 数据类型之间的桥梁，napi_value (opens new window)官网说明如下

napi_value 表示 JS 值的不透明指针，在 C/C++ 端要使用 JS 端传递的数据类型，都是通过 NAPI 提供的相关方法把napi_value转换成 C/C++ 类型后再使用，同理当需要把 C/C++的数据传递给 JS 应用层也要通过 NAPI 提供的方法把 C/C++ 端的数据转换成 napi_value 再向上传递。

C/C++转napi_value

NAPI提供了 napi_create_ 开头的方法表示把 C/C++ 类型转换成 napi_value 类型，常见方法如下所示：

int类型转换

NAPI_EXTERN napi_status napi_create_int32(napi_env env,
int32_t value,
napi_value* result);
NAPI_EXTERN napi_status napi_create_uint32(napi_env env,
uint32_t value,
napi_value* result);
NAPI_EXTERN napi_status napi_create_int64(napi_env env,
int64_t value,
napi_value* result);

把 C/C++ 的 int32_t、uint32_t 以及 int64_t 类型转换成 napi_value 类型，参数说明如下：

• env：方法调用者的运行环境，包含 JS 引擎等。
• value：C/C++端的 int 类型的值。
• result：napi_value，返回给 JS 应用层的数据。

double类型转换

NAPI_EXTERN napi_status napi_create_double(napi_env env,
double value,
napi_value* result);

把 C/C++ 端的 double 类型转换成 napi_value 类型，参数说明如下：

• env：方法调用者的运行环境，包含 JS 引擎等。
• value：C/C++ 端的 double 类型的值。
• result：napi_value，返回给 JS 应用层的数据。

string类型转换

NAPI_EXTERN napi_status napi_create_string_latin1(napi_env env,
const char* str,
size_t length,
napi_value* result);
NAPI_EXTERN napi_status napi_create_string_utf8(napi_env env,
const char* str,
size_t length,
napi_value* result);
NAPI_EXTERN napi_status napi_create_string_utf16(napi_env env,
const char16_t* str,
size_t length,
napi_value* result);

把 C/C++ 端的 char 类型转换成 napi_value 类型，参数说明如下：

• env：方法调用者的运行环境，包含 JS 引擎等。
• str：C/C++端的字符串类型的值。
• size_t：str 的长度。
• result：napi_value，返回给 JS 应用层的数据。

napi_value转C/C++

NAPI提供了 napi_get_value_ 开头的方法表示把 napi_value 转换成 C/C++ 类型，常见方法如下所示：

int类型转换

NAPI_EXTERN napi_status napi_get_value_int32(napi_env env,
napi_value value,
int32_t* result);
NAPI_EXTERN napi_status napi_get_value_uint32(napi_env env,
napi_value value,
uint32_t* result);
NAPI_EXTERN napi_status napi_get_value_int64(napi_env env,
napi_value value,
int64_t* result);

把 JS 端的 number 类型转换成 C/C++ 的对应数据类型，参数说明如下：

• env：方法调用者的运行环境，包含 JS 引擎等。
• value：JS 端传递进来的数据。
• result：接收 value 的值。

double类型转换

NAPI_EXTERN napi_status napi_get_value_double(napi_env env,
napi_value value,
double* result);

把 JS 端的 number 类型转换成 C/C++ 的 double 类型，参数说明如下：

• env：方法调用者的运行环境，包含 JS 引擎等。
• value：JS 端传递进来的数据。
• result：接收 value 的值。

深知大多数程序员，想要提升技能，往往是自己摸索成长，但自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上鸿蒙开发知识点，真正体系化！

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新

需要这份系统化的资料的朋友，可以戳这里获取

碰到天花板技术停滞不前！**

[外链图片转存中…(img-P93PeSnu-1715305738054)]
[外链图片转存中…(img-FzO8Fkvx-1715305738054)]

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上鸿蒙开发知识点，真正体系化！

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新

需要这份系统化的资料的朋友，可以戳这里获取