共享包概述(HAR)
OpenHarmony提供了兩種共享包,HAR(Harmony Archive)
靜態共享包,和HSP(Harmony Shared Package)動態共享包。HAR與HSP都是為了實現代碼和資源的共享,都可以包含代碼、C++庫、資源和配置文件
-
HAR與HSP最大的不同之處在于:
- HAR中的代碼和資源跟隨使用方編譯,如果有多個使用方,它們的編譯產物中會存在多份相同拷貝;
- 而HSP中的代碼和資源可以獨立編譯,運行時在一個進程中代碼也只會存在一份。
1. HSP旨在解決HAR存在的幾個問題:
- 多個HAP引用相同的HAR,導致的APP包大小膨脹問題。
- 多個HAP引用相同的HAR,HAR中的一些狀態變量無法共享的問題。
2. HSP的一些約束:
- HSP及其使用方都必須是Stage模型。
- HSP及其使用方都必須使用esmodule編譯模式。
- HSP不支持在配置文件中聲明abilities、extensionAbilities標簽。
HSP按照使用場景可以分為應用內HSP和應用間HSP,應用間HSP暫不支持。
HAR
- HAR(Harmony
Archive)是靜態共享包,可以包含代碼、C++庫、資源和配置文件。通過HAR可以實現多個模塊或多個工程共享ArkUI組件、資源等相關代碼。HAR不同于HAP,不能獨立安裝運行在設備上,只能作為應用模塊的依賴項被引用。
一、創建HAR模塊
- HAR模塊默認不開啟混淆能力,開啟混淆能力,需要把HAR模塊的build-profile.json5文件中的artifactType字段設置為obfuscation,詳見創建庫模塊
配置如下所示:
{
"apiType": "stageMode",
"buildOption": {
"artifactType": "obfuscation" // 開啟混淆
// "artifactType": "original" // 不開啟混淆
}}
- 注意:artifactType字段設置為obfuscation時,apiType字段必須設置為stageMode,因為Stage模型才支持混淆。
- HAR開發注意事項
- HAR不支持在配置文件中聲明abilities、extensionAbilities組件。
- HAR不支持在配置文件中聲明pages頁面。
- HAR不支持在build-profile.json5文件的buildOption中配置worker。
- FA模型與Stage模型的HAR不支持相互引用。
- Stage模型的HAR,不能引用AppScope內的內容。在編譯構建時APPScope中的內容不會打包到HAR中,導致HAR資源引用失敗。
二、導出HAR的ArkUI組件、接口、資源
- index.ets文件是HAR導出聲明文件的入口,HAR需要導出的接口,統一在index.ets文件中導出。index.ets文件是DevEco
Studio默認自動生成的,用戶也可以自定義,在模塊的oh-package.json5文件中的main字段配置入口聲明文件,配置如下所示:{ "main": "index.ets" }
三、導出ArkUI組件
1. ArkUI組件的導出方式與ts的導出方式一致,通過export導出ArkUI組件,示例如下:
// library/src/main/ets/components/MainPage/MainPage.ets
@Component
export struct MainPage {
@State message: string = 'Hello World'
build() {
Row() {
Column() {
Text(this.message)
.fontSize(50)
.fontWeight(FontWeight.Bold)
}
.width('100%')
}
.height('100%')
}
}
2. HAR對外暴露的接口,在index.ets導出文件中聲明如下所示:
// library/index.ets
export { MainPage } from './src/main/ets/components/MainPage/MainPage'
四、導出ts類和方法
1. 通過export導出ts類和方法,支持導出多個ts類和方法,示例如下所示:
// library/src/main/ts/test.ets
export class Log {
static info(msg) {
console.info(msg);
}
}
export function func() {
return "har func";
}
export function func2() {
return "har func2";
}
2. HAR對外暴露的接口,在index.ets導出文件中聲明如下所示:
// library/index.ets
export { Log } from './src/main/ts/test'
export { func } from './src/main/ts/test'
export { func2 } from './src/main/ts/test'
資源
- HAR模塊編譯打包時會把資源打包到HAR中。在編譯構建HAP時,DevEco Studio會從HAP模塊及依賴的模塊中收集資源文件,如果不同模塊下的資源文件出現重名沖突時,DevEco
Studio會按照以下優先級進行覆蓋(優先級由高到低)- AppScope(僅API9的Stage模型支持)。
- HAP包自身模塊。
- 依賴的HAR模塊,如果依賴的多個HAR之間有資源沖突,會按照依賴順序進行覆蓋(依賴順序在前的優先級較高)。
一、引用HAR的ArkUI組件、接口、資源
- 引用HAR前,需要先配置對HAR的依賴,配置方式可參考引用HAR文件和資源。
二、引用HAR的ArkUI組件
- HAR的依賴配置成功后,可以引用HAR的ArkUI組件。ArkUI組件的導入方式與ts的導入方式一致,通過import引入HAR導出的ArkUI組件,示例如下所示:
// entry/src/main/ets/pages/index.ets
import { MainPage } from "@ohos/library"
@Entry
@Component
struct Index {
@State message: string = 'Hello World'
build() {
Row() {
// 引用HAR的ArkUI組件
MainPage()
Column() {
Text(this.message)
.fontSize(50)
.fontWeight(FontWeight.Bold)
}
.width('100%')
}
.height('100%')
}
}
三、引用HAR的類和方法
- 通過import引用HAR導出的ts類和方法,示例如下所示:
// entry/src/main/ets/pages/index.ets
import { Log } from "@ohos/library"
import { func } from "@ohos/library"
@Entry
@Component
struct Index {
build() {
Row() {
Column() {
Button('Button')
.onClick(()=>{
// 引用HAR的類和方法
Log.info("har msg");
func();
})
}
.width('100%')
}
.height('100%')
}
}
四、引用HAR的資源
- 通過$r引用HAR中的資源,例如在HAR模塊的src/main/resources里添加字符串資源(在string.json中定義,name:hello_har)和圖片資源(icon_har.png),然后在Entry模塊中引用該字符串和圖片資源的示例如下所示:
// entry/src/main/ets/pages/index.ets
@Entry
@Component
struct Index {
build() {
Row() {
Column() {
// 引用HAR的字符串資源
Text($r("app.string.hello_har"))
.fontSize(50)
.fontWeight(FontWeight.Bold)
// 引用HAR的圖片資源
Image($r("app.media.icon_har"))
}
.width('100%')
}
.height('100%')
}
}