通過實(shí)例學(xué)習(xí)鴻蒙動態(tài)庫的創(chuàng)建與使用
簡要介紹
動態(tài)共享包HSP(Harmony Shared Package),是為了實(shí)現(xiàn)在不同HAP之間代碼和資源的共享,HAR中的代碼和資源跟隨使用方編譯,但HSP中的代碼和資源可以獨(dú)立編譯,運(yùn)行時在一個進(jìn)程中,代碼也只會存在一份,不和應(yīng)用綁定在一起,和應(yīng)用是一對多的關(guān)系,這樣可以有效加快編譯速度,減小HAP包的體積。
通過查看官方文檔,我們發(fā)現(xiàn),動態(tài)庫HSP又分為應(yīng)用內(nèi)HSP和應(yīng)用間HSP。
應(yīng)用間HSP:
用于不同應(yīng)用間的代碼、資源共享。 應(yīng)用間HSP的宿主應(yīng)用是一種特殊狀態(tài)的應(yīng)用,只能由一個HSP組成,不會獨(dú)立運(yùn)行在設(shè)備上,而是被普通應(yīng)用模塊的依賴項(xiàng)引用。當(dāng)普通應(yīng)用運(yùn)行時,通過動態(tài)調(diào)用的方式使用應(yīng)用間HSP提供的能力,從而實(shí)現(xiàn)應(yīng)用自身所需要的功能。
版本比較:
概念比較不好理解,查了一下官方文檔,它和系統(tǒng)與版本有一定的聯(lián)系:
- 應(yīng)用內(nèi)HSP相關(guān)說明:
在HarmonyOS官網(wǎng)介紹文檔里指南一欄中,對應(yīng)3.1/4.0的版本有介紹。
在OpenHarmony官網(wǎng)介紹文檔里應(yīng)用開發(fā)文檔一欄中,對應(yīng)3.2Release和4.0Beta的版本都有介紹。 - 應(yīng)用間HSP相關(guān)說明:
在HarmonyOS官網(wǎng)介紹文檔里指南一欄中,沒有任何介紹。
在OpenHarmony官網(wǎng)介紹文檔里應(yīng)用開發(fā)文檔一欄中,對應(yīng)4.0Beta的版本下有介紹,對應(yīng)3.2Release版本下沒有介紹。
所以簡單捋一下,應(yīng)用內(nèi)HSP是常用的上層普通應(yīng)用動態(tài)庫,使用這種庫開發(fā)的應(yīng)用既可以運(yùn)行在鴻蒙手機(jī)HarmonyOS上,也可以運(yùn)行在鴻蒙設(shè)備OpenHarmony上。應(yīng)用間HSP,只支持在OpenHarmony系統(tǒng)上,僅對系統(tǒng)應(yīng)用開放。
由于本人沒有3.2版本或4.0版本的OpenHarmony開發(fā)設(shè)備,所以下面通過簡單的實(shí)例,只介紹一下應(yīng)用內(nèi)HSP動態(tài)庫的創(chuàng)建過程和使用方法,應(yīng)用間HSP動態(tài)庫的開發(fā)等以后有設(shè)備了之后再補(bǔ)充。
具體實(shí)現(xiàn)
1、新建主工程
新建一個普通的HarmonyOS工程,選擇Application -> Empty Ability -> Model(Stage),開發(fā)工具不允許直接新建shared library工程,文檔中說靜態(tài)庫HAR中的代碼和資源跟隨使用方編譯,所以不能單獨(dú)創(chuàng)建可以理解,可是文檔又說動態(tài)庫HSP中的代碼和資源可以獨(dú)立編譯,但通過實(shí)踐發(fā)現(xiàn)不能單獨(dú)創(chuàng)建shared library工程,這里不是很明白,可能獨(dú)立編譯不等于獨(dú)立的項(xiàng)目,依附于主工程的動態(tài)庫項(xiàng)目方便測試,更有實(shí)際意義,目前在DevEcoStudio3.1上是這樣。
單獨(dú)的工程目錄結(jié)構(gòu)如下,當(dāng)前的模塊目錄是entry目錄,字體加粗顯示。
2、建立動態(tài)庫
右擊工程名,選擇New -> Module…,選擇Shared Library。
模塊創(chuàng)建完成后,工程結(jié)構(gòu)如下圖,sharedlibrary工程目錄名粗體顯示。
打開sharedlibrary模塊下的module.json5文件,我們發(fā)現(xiàn)對應(yīng)的type的值為shared。
3、對多種形式的封裝
HSP支持ArkUI組件、接口、資源和native方法這幾種形式的封裝。基本方法和靜態(tài)庫HAR差不多,首先是在動態(tài)庫模塊中實(shí)現(xiàn)功能,并在index.ets中進(jìn)行導(dǎo)出export操作,然后在使用方的應(yīng)用page頁面中進(jìn)行導(dǎo)入import操作。
HSP對ArkUI組件的支持
功能實(shí)現(xiàn):
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,是因?yàn)樾陆▌討B(tài)庫模塊的時候,自動生成了resources/base/profile/main_pages.json,pages目錄下的頁面都在main_pages.json中進(jìn)行了登記,但靜態(tài)庫的開發(fā)時沒有遇到這個情況??赡馨裮ain_pages.json和@Entry刪掉也可以,但還沒試。
模塊導(dǎo)出:
Index.ets:
export { Greeting } from './pages/Greeting'
模塊導(dǎo)入:
導(dǎo)入hsp,或者引用HSP前,需要先配置對HAR的依賴,打開entry主模塊下的oh-package.json5文件,因?yàn)槲覀兪窃谥髂K中要引用動態(tài)庫,所以我們修改模塊級依賴配置文件oh-package.json5,dependencies下添加新建的庫,后面file:…/跟著的是工程目錄樹中靜態(tài)庫的名稱sharedlibrary。
我們在主模塊頁面index.ets中引入靜態(tài)庫的組件。
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%')
}
}
需要注意的是,導(dǎo)入動態(tài)庫時用的是import { Greeting } from “l(fā)ibrary”,from后面直接就是library,而導(dǎo)入靜態(tài)庫時的例子中用的是import { TitleManager, getRandomNum } from “@ohos/library”,后面跟的是@ohos/library。
現(xiàn)在基本完成了,編譯看看效果:
首先,可以先編譯動態(tài)庫,在項(xiàng)目樹中選擇sharedlibrary,然后點(diǎn)擊菜單欄中的build,會看到第一個菜單為 Make Module ‘sharedlibrary’,執(zhí)行后,我們發(fā)現(xiàn)在工程代碼目錄sharedlibrary\build\default\outputs\default下有一個sharedlibrary.har文件,還有一個sharedlibrary-default-unsigned.hsp,說明編譯成功了,但為啥有這兩個文件,暫時還不知道。
其次,我們再選中entry,然后點(diǎn)擊菜單欄中的build,會看到第一個菜單為 Make Module ‘entry’,執(zhí)行后,我們發(fā)現(xiàn)在工程代碼目錄entry\build\default\outputs\default下有一個entry-default-unsigned.hap文件,說明也編譯成功了。
我們想通過預(yù)覽器查看一下界面,結(jié)果是白屏。
LOG窗口提示:
09-07 11:52:52.104 E C03f00/ArkCompiler: [ArkRuntime Log] Importing shared package is not supported in the Previewer.
所以,使用了動態(tài)庫的應(yīng)用無法直接預(yù)覽,我們只好在模擬器里測試一下。
直接點(diǎn)擊DevEco工具欄中的運(yùn)行,會報如下錯誤。
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
該問題是由于運(yùn)行/調(diào)試的應(yīng)用依賴的動態(tài)共享包模塊未安裝導(dǎo)致安裝報錯。
解決辦法:
Edit Entry Configuration,Deploy Multi Hap 選中SharedLibrary。
這樣就能成功運(yùn)行了,通過模擬器查看一下運(yùn)行效果,如下:
模擬器中成功運(yùn)行,說明我們通過entry中調(diào)用sharedlibrary操作成功。
HSP對ArkUI接口的支持
功能實(shí)現(xiàn):
Src/main/ets/utils/Calc.ts:
export function add(a:number, b:number) {
return a + b;
}
模塊導(dǎo)出:
Index.ets:
export { add } from "./utils/Calc"
模塊導(dǎo)入:
由于我們是放在同一個hsp包中,所以不用重新配置對HSP的依賴。
直接在頁面文件中引入動態(tài)庫中的接口。
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,參數(shù)改為我們要測試的頁面。
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資源的支持
功能實(shí)現(xiàn):
HSP中的資源不支持對使用者直接提供,就不能像用靜態(tài)庫那種方法去調(diào)用了,可以通過封裝接口的方式去調(diào)用,這樣的話就和調(diào)用動態(tài)庫接口的方法一樣了。
ResourceManager.ets:
export class ResourceManager {
static getString() {
return $r('app.string.shared_desc')
}
static getImage() {
return $r('app.media.hsp');
}
}
模塊導(dǎo)出:
Index.ets:
export { ResourceManager } from './utils/ResourceManager'
模塊導(dǎo)入:
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%')
}
}
我們通過模擬器查看一下結(jié)果。
HSP對ArkUI中native方法的支持
功能實(shí)現(xiàn):
HSP中支持對C++編寫的so庫的支持,對于so中的native方法,HSP通過間接的方式導(dǎo)出,實(shí)際上也是以接口的方式導(dǎo)出的,與動態(tài)庫中資源的調(diào)用方式如出一轍。
我們先在另外一個工程中創(chuàng)建了一個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文件實(shí)現(xiàn)了接口功能。
import native from "libnative.so"
export function nativeMulti(a: number, b: number) {
return native.multi(a, b);
}
模塊導(dǎo)出:
Index.ets:
export { nativeMulti } from './utils/NativeFuncs'
模塊導(dǎo)入:
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%')
}
}
我們通過模擬器查看一下運(yùn)行結(jié)果。
至此,我們基本實(shí)踐了HSP包支持的四種形式。
經(jīng)驗(yàn)總結(jié)
通過這次實(shí)踐,終于把動態(tài)庫HSP的開發(fā)步驟和使用方法弄清楚了,簡單來說,動態(tài)庫中的資源和native調(diào)用基本上都是采用的和接口調(diào)用相同的方法。 這次是以應(yīng)用內(nèi)HSP為基礎(chǔ)進(jìn)行介紹的,應(yīng)用間HSP開發(fā)以后有設(shè)備了還要繼續(xù)熟悉一下。