三方庫移植之NAPI開發（三）通過IDE開發NAPI工程

作者：離北況歸 2022-10-25 15:05:17

系統 OpenHarmony

在本篇文章中，筆者使用三方庫移植之NAPI開發[1]—Hello OpenHarmony NAPI中一樣的hellonapi.cpp和index.ets源碼.

??想了解更多關于開源的內容，請訪問：??

??51CTO 開源基礎軟件社區??

??https://ost.51cto.com??

在三方庫移植之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包運行效果一致。

開發環境：

IDE:??DevEco Studio 3.0 Release??
開發板：潤和DAYU200開發板

創建工程

打開IDE，創建一個Native C++工程。

#打卡不停更#三方庫移植之NAPI開發[3]通過IDE開發NAPI工程-開源基礎軟件社區

SDK選擇API9，model選擇Stage。

#打卡不停更#三方庫移植之NAPI開發[3]通過IDE開發NAPI工程-開源基礎軟件社區

源碼實現

新建的Native C++工程有一個默認的hello world教程，接下來需要編輯的文件如下：

#打卡不停更#三方庫移植之NAPI開發[3]通過IDE開發NAPI工程-開源基礎軟件社區

C++方法實現

將默認的hello.cpp文件重命名為hellonapi.cpp，選中右鍵選中重構重命名。

#打卡不停更#三方庫移植之NAPI開發[3]通過IDE開發NAPI工程-開源基礎軟件社區

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編譯配置文件編寫

#打卡不停更#三方庫移植之NAPI開發[3]通過IDE開發NAPI工程-開源基礎軟件社區

和開發rom包的NAPI工程需要在BUILD.gn文件中指定編譯so庫需要的頭文件和源文件、動態庫名稱、依賴的庫一樣，通過IDE開發ROM包時也需要在CMakeLists.txt中指定編譯so庫需要的頭文件和源文件、動態庫名稱、依賴的庫，內容如下：

cmake_minimum_required(VERSION 3.4.1)
project(MyApplication3)
set(NATIVERENDER_ROOT_PATH ${CMAKE_CURRENT_SOURCE_DIR})
include_directories(${NATIVERENDER_ROOT_PATH}
                    ${NATIVERENDER_ROOT_PATH}/include)

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文件

#打卡不停更#三方庫移植之NAPI開發[3]通過IDE開發NAPI工程-開源基礎軟件社區

libhellonapi.so依賴的libace_napi.z.so在sdk\native\3.2.7.5\sysroot\usr\lib\aarch64-linux-ohos目錄下。

#打卡不停更#三方庫移植之NAPI開發[3]通過IDE開發NAPI工程-開源基礎軟件社區

sdk\native\3.2.7.5\sysroot\usr\lib\arm-linux-ohos目錄下也有開發ROM包的NAPI時候可能依賴的動態庫。

index.d.ts聲明文件編寫

#打卡不停更#三方庫移植之NAPI開發[3]通過IDE開發NAPI工程-開源基礎軟件社區

index.d.ts內容如下：

export const getHelloString: () => string;

界面設計

#打卡不停更#三方庫移植之NAPI開發[3]通過IDE開發NAPI工程-開源基礎軟件社區

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"

#打卡不停更#三方庫移植之NAPI開發[3]通過IDE開發NAPI工程-開源基礎軟件社區

有報錯就刪除原有的libentry.so符號鏈接。

#打卡不停更#三方庫移植之NAPI開發[3]通過IDE開發NAPI工程-開源基礎軟件社區

entry/package.json內容如下：

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

修改原有的libentry為libhellonapi

設置hap為自動簽名

hap包運行效果

和三方庫移植之NAPI開發[1]—Hello OpenHarmony NAPI一文效果一致。

#打卡不停更#三方庫移植之NAPI開發[3]通過IDE開發NAPI工程-開源基礎軟件社區

總結：RAM包的NAPI工程和ROM包的NAPI工程的異同

以下為個人總結，希望各位老師和同學批評指正

動態庫的命名方式的不同，RAM包的NAPI工程（通過IDE開發NAPI工程）使用的動態庫libhellonapi.so，而ROM包的NAPI工程編譯出來使用的動態庫是libhellonapi.z.so。

#打卡不停更#三方庫移植之NAPI開發[3]通過IDE開發NAPI工程-開源基礎軟件社區

libhellonapi.so位于hap包源碼路徑如下：

entry\build\default\intermediates\libs\default\arm64-v8a
entry\build\default\intermediates\cmake\default\obj\arm64-v8a
entry\build\default\intermediates\libs\default\armeabi-v7a
entry\build\default\intermediates\cmake\default\obj\armeabi-v7a

開發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內容為：

#打卡不停更#三方庫移植之NAPI開發[3]通過IDE開發NAPI工程-開源基礎軟件社區

編寫.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 模塊名;