#打卡不停更#三方库移植之NAPI开发[3]通过IDE开发NAPI工程

Posted 2022-10-28

• 在三方库移植之NAPI开发[1]—Hello OpenHarmony NAPI一文中，笔者开发的是一个rom包的napi工程。该工程需要编译烧录固件，C ++的动态库会集成到开发板的ROM中。
• 在本篇文章中，笔者使用三方库移植之NAPI开发[1]—Hello OpenHarmony NAPI中一样的hellonapi.cpp和index.ets源码，通过IDE开发一个RAM包的NAPI工程（集成C ++的动态库到开发板的RAM中），直接编译安装hap包到开发板即可。两个开发方式的hap包运行效果一致。

---

往期回顾： 三方库移植之NAPI开发[1]—Hello OpenHarmony NAPI

三方库移植之NAPI开发[2]C/C++与JS的数据类型转换

(目录)

开发环境：

• IDE:DevEco Studio 3.0 Release
• 开发板：润和DAYU200开发板

创建工程

打开IDE，创建一个Native C++工程。 SDK选择API9，model选择Stage。

源码实现

• 新建的Native C++工程有一个默认的hello world教程，接下来需要编辑的文件如下

C++方法实现

将默认的hello.cpp文件重命名为hellonapi.cpp，选中右键选中重构重命名。 hellonapi.cpp内容如下：

#include "napi/native_api.h"
#include <string>

//接口业务实现C/C++代码
//std::string 需要引入string头文件，#include <string>
static napi_value getHelloString(napi_env env, napi_callback_info info) 
  napi_value result;
  std::string words = "Hello OpenHarmony NAPI";
  //NAPI_CALL(env, napi_create_string_utf8(env, words.c_str(), words.length(), &result));
  napi_create_string_utf8(env, words.c_str(), words.length(), &result);
  
  return result;


// napi_addon_register_func
//2.指定模块注册对外接口的处理函数，具体扩展的接口在该函数中声明

static napi_value registerFunc(napi_env env, napi_value exports)

    static napi_property_descriptor desc[] = 
        // 声明该napi_module对外具体的提供的API
         "getHelloString", nullptr, getHelloString, nullptr, nullptr, nullptr, napi_default, nullptr 
    ;
    //NAPI_CALL(env, napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc));
    napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc);
    return exports;


// 1.先定义napi_module，指定当前NAPI模块对应的模块名
//以及模块注册对外接口的处理函数，具体扩展的接口在该函数中声明
// nm_modname: 模块名称，对应eTS代码为import nm_modname from @ohos.ohos_shared_library_name
//示例对应eTS代码为：import hellonapi from @ohos.hellonapi
static napi_module hellonapiModule = 
    .nm_version = 1,
    .nm_flags = 0,
    .nm_filename = nullptr,
    .nm_register_func = registerFunc, // 模块对外接口注册函数
    .nm_modname = "hellonapi",  // 自定义模块名
    .nm_priv = ((void*)0),
    .reserved =  0 ,
;

//3.模块定义好后，调用NAPI提供的模块注册函数napi_module_register(napi_module* mod)函数注册到系统中。
// register module，设备启动时自动调用此constructor函数，把模块定义的模块注册到系统中
extern "C" __attribute__((constructor)) void hellonapiModuleRegister()

    napi_module_register(&hellonapiModule);

此时的native_api.h文件是在sdk\\native\\3.2.7.5\\sysroot\\usr\\include\\napi目录下

CMakeLists.txt编译配置文件编写

• 和开发rom包的NAPI工程需要在BUILD.gn文件中指定编译so库需要的头文件和源文件、动态库名称、依赖的库一样，通过IDE开发ROM包时也需要在CMakeLists.txt中指定编译so库需要的头文件和源文件、动态库名称、依赖的库，内容如下：

# the minimum version of CMake.指明了对cmake的最低(高)版本的要求
cmake_minimum_required(VERSION 3.4.1)

#配置项目信息（新建native C++工程时候的工程名称）
project(MyApplication3)

#指定编程语言
set(NATIVERENDER_ROOT_PATH $CMAKE_CURRENT_SOURCE_DIR)

#设置头文件的搜索目录
include_directories($NATIVERENDER_ROOT_PATH
                    $NATIVERENDER_ROOT_PATH/include)
# 添加名为xxx的库
add_library(hellonapi SHARED hellonapi.cpp)

#构建此可执行文件需要链接的库
target_link_libraries(hellonapi PUBLIC libace_napi.z.so)

• NATIVERENDER_ROOT_PATH路径指的是sdk\\native\\3.2.7.5\\sysroot\\usr
• add_library(hellonapi SHARED hellonapi.cpp)表示编译libhellonapi.so需要的是hellonapi.cpp
• target_link_libraries(hellonapi PUBLIC libace_napi.z.so)表示编译编译libhellonapi.so依赖libace_napi.z.so 开发ROM包的NAPI工程时，libhellonapi.z.so也依赖libace_napi.z.so，以下为开发ROM包的NAPI工程时BUILD.gn文件

index.d.ts声明文件编写

index.d.ts内容如下：

export const getHelloString: () => string;

界面设计

index.ets和三方库移植之NAPI开发[1]—Hello OpenHarmony NAPI一文中一致。

import prompt from @system.prompt
import hellonapi from libhellonapi.so

@Entry
@Component
export struct HelloNAPI 
  build() 
    Flex( direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center ) 
      Button("NAPI: hellonapi.getHelloString()").margin(10).fontSize(24).onClick(() => 
        // 调用getHelloString接口
        let strFromNAPI = hellonapi.getHelloString()
        prompt.showToast( message: strFromNAPI )
      )
    
    .width(100%)
    .height(100%)
  

json配置文件编写

• package.json内容如下

  "name": "libhellonapi.so",
  "types": "./index.d.ts"

• entry/package-lock.json内容如下

	"@types/libhellonapi.so":"file:./src/main/cpp/types/libhellonapi"

有报错就删除原有的libentry.so符号链接

• entry/package.json内容如下

    "@types/libhellonapi.so": 
      "version": "file:src/main/cpp/types/libhellonapi",

• 修改原有的libentry为libhellonapi

• 设置hap为自动签名

hap包运行效果

和三方库移植之NAPI开发[1]—Hello OpenHarmony NAPI一文效果一致

总结：RAM包的NAPI工程和ROM包的NAPI工程的异同

• 动态库的命名方式的不同，RAM包的NAPI工程（通过IDE开发NAPI工程）使用的动态库libhellonapi.so，而ROM包的NAPI工程编译出来使用的动态库是libhellonapi.z.so。

• 开发ROM包的NAPI工程需要加入OHOS编译体系，编写BULID.gn、ohos.build等,开发过程较为繁琐。而RAM包的NAPI工程不需要加入OHOS编译体系，编写CMakeLists.txt配置编译需要的源文件、头文件、依赖的库等。因此开发RAM包的NAPI工程相对简洁。

• .d.ts声明文件的编写不同 开发ROM包的NAPI工程时，笔者编写的@ohos.hellonapi.d.ts内容为 开发RAM包的NAPI工程时，笔者编写的@ohos.hellonapi.d.ts内容为 编写.d.ts声明文件时，RAM包开发的NAPI工程定义功能方法getHelloString: () => string比ROM包多了=>符号。

知识点附送

• 以下为开发ROM包的NAPI工程时，需要添加进入sdk的声明文件模板 @ohos.模块名.d.ts文件：

/**
* 模块描述
* @since API版本号，IT Release3 对应 4，以此类推
* @sysCap 系统能力
* @devices 支持设备
* @import 导入模块
* @permission 权限列表
*/
declare namespace 模块名 
// 在此处定义功能方法

export default 模块名;

附件链接：https://ost.51cto.com/posts/18336

本文作者：离北况归

想了解更多关于开源的内容，请访问：​​

​​51CTO 开源基础软件社区​​

​​https://ost.51cto.com/#bkwz​​