通過實例學習鴻蒙動態庫的創建與使用
簡要介紹
動態共享包HSP（Harmony Shared Package），是為了實現在不同HAP之間代碼和資源的共享，HAR中的代碼和資源跟隨使用方編譯，但HSP中的代碼和資源可以獨立編譯，運行時在一個進程中，代碼也只會存在一份，不和應用綁定在一起，和應用是一對多的關系，這樣可以有效加快編譯速度，減小HAP包的體積。
通過查看官方文檔，我們發現，動態庫HSP又分為應用內HSP和應用間HSP。
應用間HSP：
用于不同應用間的代碼、資源共享。 應用間HSP的宿主應用是一種特殊狀態的應用，只能由一個HSP組成，不會獨立運行在設備上，而是被普通應用模塊的依賴項引用。當普通應用運行時，通過動態調用的方式使用應用間HSP提供的能力，從而實現應用自身所需要的功能。
版本比較：
概念比較不好理解，查了一下官方文檔，它和系統與版本有一定的聯系：
- 應用內HSP相關說明：
在HarmonyOS官網介紹文檔里指南一欄中，對應3.1/4.0的版本有介紹。
在OpenHarmony官網介紹文檔里應用開發文檔一欄中，對應3.2Release和4.0Beta的版本都有介紹。 - 應用間HSP相關說明：
在HarmonyOS官網介紹文檔里指南一欄中，沒有任何介紹。
在OpenHarmony官網介紹文檔里應用開發文檔一欄中，對應4.0Beta的版本下有介紹，對應3.2Release版本下沒有介紹。
所以簡單捋一下，應用內HSP是常用的上層普通應用動態庫，使用這種庫開發的應用既可以運行在鴻蒙手機HarmonyOS上，也可以運行在鴻蒙設備OpenHarmony上。應用間HSP，只支持在OpenHarmony系統上，僅對系統應用開放。
由于本人沒有3.2版本或4.0版本的OpenHarmony開發設備，所以下面通過簡單的實例，只介紹一下應用內HSP動態庫的創建過程和使用方法，應用間HSP動態庫的開發等以后有設備了之后再補充。
具體實現
1、新建主工程
新建一個普通的HarmonyOS工程，選擇Application -> Empty Ability -> Model(Stage)，開發工具不允許直接新建shared library工程，文檔中說靜態庫HAR中的代碼和資源跟隨使用方編譯，所以不能單獨創建可以理解，可是文檔又說動態庫HSP中的代碼和資源可以獨立編譯，但通過實踐發現不能單獨創建shared library工程，這里不是很明白，可能獨立編譯不等于獨立的項目，依附于主工程的動態庫項目方便測試，更有實際意義，目前在DevEcoStudio3.1上是這樣。
單獨的工程目錄結構如下，當前的模塊目錄是entry目錄，字體加粗顯示。
2、建立動態庫
右擊工程名，選擇New -> Module…，選擇Shared Library。
模塊創建完成后，工程結構如下圖，sharedlibrary工程目錄名粗體顯示。
打開sharedlibrary模塊下的module.json5文件，我們發現對應的type的值為shared。
3、對多種形式的封裝
HSP支持ArkUI組件、接口、資源和native方法這幾種形式的封裝?；痉椒ê挽o態庫HAR差不多，首先是在動態庫模塊中實現功能，并在index.ets中進行導出export操作，然后在使用方的應用page頁面中進行導入import操作。
HSP對ArkUI組件的支持
功能實現：
Greeting.ets：
@Entry
@Component
export struct Greeting {
@State message: string = 'Hello Hsp'
build() {
Row() {
Column() {
Text(this.message)
.fontSize(50)
.fontWeight(FontWeight.Bold)
.padding(10)
.fontColor(Color.Green)
}
.width('100%')
}
.height('30%')
}
}這個組件前加了個@Entry，是因為新建動態庫模塊的時候，自動生成了resources/base/profile/main_pages.json，pages目錄下的頁面都在main_pages.json中進行了登記，但靜態庫的開發時沒有遇到這個情況。可能把main_pages.json和@Entry刪掉也可以，但還沒試。
模塊導出：
Index.ets：
export { Greeting } from './pages/Greeting'模塊導入：
導入hsp，或者引用HSP前，需要先配置對HAR的依賴，打開entry主模塊下的oh-package.json5文件，因為我們是在主模塊中要引用動態庫，所以我們修改模塊級依賴配置文件oh-package.json5，dependencies下添加新建的庫，后面file:…/跟著的是工程目錄樹中靜態庫的名稱sharedlibrary。
我們在主模塊頁面index.ets中引入靜態庫的組件。
index.ets：
import { Greeting } from "library"
@Entry
@Component
struct Index {
@State message: string = 'This is entry'
build() {
Row() {
Column() {
Greeting()
Text(this.message)
.fontSize(50)
.fontWeight(FontWeight.Bold)
}
.width('100%')
}
.height('100%')
}
}需要注意的是，導入動態庫時用的是import { Greeting } from “library”，from后面直接就是library，而導入靜態庫時的例子中用的是import { TitleManager, getRandomNum } from “@ohos/library”，后面跟的是@ohos/library。
現在基本完成了，編譯看看效果：
首先，可以先編譯動態庫，在項目樹中選擇sharedlibrary，然后點擊菜單欄中的build，會看到第一個菜單為 Make Module ‘sharedlibrary’，執行后，我們發現在工程代碼目錄sharedlibrary\build\default\outputs\default下有一個sharedlibrary.har文件，還有一個sharedlibrary-default-unsigned.hsp，說明編譯成功了，但為啥有這兩個文件，暫時還不知道。
其次，我們再選中entry，然后點擊菜單欄中的build，會看到第一個菜單為 Make Module ‘entry’，執行后，我們發現在工程代碼目錄entry\build\default\outputs\default下有一個entry-default-unsigned.hap文件，說明也編譯成功了。
我們想通過預覽器查看一下界面，結果是白屏。
LOG窗口提示：
09-07 11:52:52.104 E C03f00/ArkCompiler: [ArkRuntime Log] Importing shared package is not supported in the Previewer.所以，使用了動態庫的應用無法直接預覽，我們只好在模擬器里測試一下。
直接點擊DevEco工具欄中的運行，會報如下錯誤。
09/07 11:39:58: Launching com.example.hspproject
$ hdc shell am force-stop com.example.hspproject
$ hdc shell bm uninstall com.example.hspproject
$ hdc file send E:\Projects\HarmonyProject\HspProject\entry\build\default\outputs\default\entry-default-unsigned.hap /sdcard/555683f498f2419ca2eb0916edb18c13/entry-default-unsigned.hap
$ hdc shell bm install -p /sdcard/555683f498f2419ca2eb0916edb18c13/
Failure[MSG_ERR_INSTALL_DEPENDENT_MODULE_NOT_EXIST]
$ hdc shell rm -rf /sdcard/555683f498f2419ca2eb0916edb18c13
Error while Deploying HAP該問題是由于運行/調試的應用依賴的動態共享包模塊未安裝導致安裝報錯。
解決辦法：
Edit Entry Configuration，Deploy Multi Hap 選中SharedLibrary。
這樣就能成功運行了，通過模擬器查看一下運行效果，如下：
模擬器中成功運行，說明我們通過entry中調用sharedlibrary操作成功。
HSP對ArkUI接口的支持
功能實現：
Src/main/ets/utils/Calc.ts：
export function add(a:number, b:number) {
return a + b;
}模塊導出：
Index.ets：
export { add } from "./utils/Calc"模塊導入：
由于我們是放在同一個hsp包中，所以不用重新配置對HSP的依賴。
直接在頁面文件中引入動態庫中的接口。
InterfaceCaller.ets：
import { add } from "library"
@Entry
@Component
struct InterfaceCaller {
@State message: string = 'This is entry'
build() {
Row() {
Column() {
Row() {
Text("Add Result:" + add(2, 3))
.fontSize(20)
}
.width('100%')
.justifyContent(FlexAlign.Center)
}
.width('100%')
}
.height('100%')
}
}編譯之前我們需要改一下EntryAbility.ts中的onWindowStageCreate中的windowStage.loadContent，參數改為我們要測試的頁面。
onWindowStageCreate(windowStage: window.WindowStage) {
// Main window is created, set main page for this ability
hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onWindowStageCreate');
windowStage.loadContent('pages/InterfaceCaller', (err, data) => {我們通過模擬器查看一下界面。
HSP對ArkUI資源的支持
功能實現：
HSP中的資源不支持對使用者直接提供，就不能像用靜態庫那種方法去調用了，可以通過封裝接口的方式去調用，這樣的話就和調用動態庫接口的方法一樣了。
ResourceManager.ets：
export class ResourceManager {
static getString() {
return $r('app.string.shared_desc')
}
static getImage() {
return $r('app.media.hsp');
}
}模塊導出：
Index.ets：
export { ResourceManager } from './utils/ResourceManager'模塊導入：
ResourceCaller.ets：
import { ResourceManager } from "library"
@Entry
@Component
struct ResourceCaller {
@State message: string = 'This is entry'
build() {
Row() {
Column() {
Text("string from sharedlibrary:")
.fontSize(20)
Text(ResourceManager.getString())
.fontSize(20)
.fontWeight(FontWeight.Bold)
.margin({bottom: 20})
Image(ResourceManager.getImage())
.width(100)
.height(100)
}
.width('100%')
.justifyContent(FlexAlign.Center)
}
.height('100%')
}
}我們通過模擬器查看一下結果。
HSP對ArkUI中native方法的支持
功能實現：
HSP中支持對C++編寫的so庫的支持，對于so中的native方法，HSP通過間接的方式導出，實際上也是以接口的方式導出的，與動態庫中資源的調用方式如出一轍。
我們先在另外一個工程中創建了一個libnative.so的庫，然后把cpp目錄直接拷到sharedlibrary/src/main下。
修改sharedlibrary下的build-profile.json5，在buildOption中添加externalNativeOptions。
{
"apiType": 'stageMode',
"buildOption": {
"externalNativeOptions": {
"path": "./src/main/cpp/CMakeLists.txt",
"arguments": "",
"cppFlags": "",
}
},
"targets": [
{
"name": "default",
"runtimeOS": "HarmonyOS"
}
]
}修改oh-pakage.json5文件，添加devDependencies依賴。
{
"name": "sharedlibrary",
"version": "1.0.0",
"description": "Please describe the basic information.",
"main": "./src/main/ets/Index.ets",
"author": "",
"license": "Apache-2.0",
"dependencies": {
},
"devDependencies": {
"@types/libnative.so": "file:./src/main/cpp/types/libnative"
}
}Ets/utils/NativeFuncs.ts文件實現了接口功能。
import native from "libnative.so"
export function nativeMulti(a: number, b: number) {
return native.multi(a, b);
}模塊導出：
Index.ets：
export { nativeMulti } from './utils/NativeFuncs'模塊導入：
NativeCaller.ets：
import { nativeMulti } from "library"
@Entry
@Component
struct ResourceCaller {
@State message: string = 'This is entry'
build() {
Row() {
Column() {
Text("Result from native func: ")
.fontSize(20)
Text(nativeMulti(3, 4).toString())
.fontSize(40)
.fontWeight(FontWeight.Bold)
.margin({bottom: 20})
.fontColor(Color.Blue)
}
.width('100%')
.justifyContent(FlexAlign.Center)
}
.height('100%')
}
}我們通過模擬器查看一下運行結果。
至此，我們基本實踐了HSP包支持的四種形式。
經驗總結
通過這次實踐，終于把動態庫HSP的開發步驟和使用方法弄清楚了，簡單來說，動態庫中的資源和native調用基本上都是采用的和接口調用相同的方法。 這次是以應用內HSP為基礎進行介紹的，應用間HSP開發以后有設備了還要繼續熟悉一下。
