HAR

2024-01-25 11:55 更新

HAR(Harmony Archive)是静态共享包,可以包含代码、C++库、资源和配置文件。通过HAR可以实现多个模块或多个工程共享ArkUI组件、资源等相关代码。HAR不同于HAP,不能独立安装运行在设备上,只能作为应用模块的依赖项被引用。

创建HAR模块

通过DevEco Studio创建一个HAR模块,详见创建库模块。HAR模块默认不开启混淆能力,开启混淆能力,需要把HAR模块的build-profile.json5文件中的artifactType字段设置为obfuscation,配置如下所示:

  1. {
  2. "apiType": "stageMode",
  3. "buildOption": {
  4. "artifactType": "obfuscation"
  5. }
  6. }

artifactType字段有以下两种取值,默认缺省为original。

  • original:不混淆。
  • obfuscation:混淆。

需要对代码资产进行保护时,建议开启混淆能力,混淆能力开启后,DevEco Studio在构建HAR时,会对代码进行编译、混淆及压缩处理,保护代码资产。

注意: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字段配置入口声明文件,配置如下所示:

  1. {
  2. "main": "Index.ets"
  3. }

导出ArkUI组件

ArkUI组件的导出方式与ts的导出方式一致,通过export导出ArkUI组件,示例如下:

  1. // library/src/main/ets/components/MainPage/MainPage.ets
  2. @Component
  3. export struct MainPage {
  4. @State message: string = 'Hello World'
  5. build() {
  6. Row() {
  7. Column() {
  8. Text(this.message)
  9. .fontSize(50)
  10. .fontWeight(FontWeight.Bold)
  11. }
  12. .width('100%')
  13. }
  14. .height('100%')
  15. }
  16. }

HAR对外暴露的接口,在Index.ets导出文件中声明如下所示:

  1. // library/Index.ets
  2. export { MainPage } from './src/main/ets/components/MainPage/MainPage'

导出ts类和方法

通过export导出ts类和方法,支持导出多个ts类和方法,示例如下所示:

  1. // library/src/main/ts/test.ets
  2. export class Log {
  3. static info(msg: string) {
  4. console.info(msg);
  5. }
  6. }
  7. export function func() {
  8. return "har func";
  9. }
  10. export function func2() {
  11. return "har func2";
  12. }

HAR对外暴露的接口,在Index.ets导出文件中声明如下所示:

  1. // library/Index.ets
  2. export { Log } from './src/main/ts/test'
  3. export { func } from './src/main/ts/test'
  4. export { func2 } from './src/main/ts/test'

导出native方法

在HAR中也可以包含C++编写的so。对于so中的native方法,HAR通过以下方式导出,以导出libnative.so的加法接口add为例:

  1. // library/src/main/ets/utils/nativeTest.ts
  2. import native from "libnative.so"
  3. export function nativeAdd(a: number, b: number) {
  4. let result: number = native.add(a, b);
  5. return result;
  6. }

HAR对外暴露的接口,在Index.ets导出文件中声明如下所示:

  1. // library/Index.ets
  2. export { nativeAdd } from './src/main/ets/utils/nativeTest'

资源

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组件,示例如下所示:

  1. // entry/src/main/ets/pages/Index.ets
  2. import { MainPage } from "library"
  3. @Entry
  4. @Component
  5. struct Index {
  6. @State message: string = 'Hello World'
  7. build() {
  8. Row() {
  9. // 引用HAR的ArkUI组件
  10. MainPage()
  11. Column() {
  12. Text(this.message)
  13. .fontSize(50)
  14. .fontWeight(FontWeight.Bold)
  15. }
  16. .width('100%')
  17. }
  18. .height('100%')
  19. }
  20. }

引用HAR的ts类和方法

通过import引用HAR导出的ts类和方法,示例如下所示:

  1. // entry/src/main/ets/pages/Index.ets
  2. import { Log } from "library"
  3. import { func } from "library"
  4. @Entry
  5. @Component
  6. struct Index {
  7. build() {
  8. Row() {
  9. Column() {
  10. Button('Button')
  11. .onClick(()=>{
  12. // 引用HAR的类和方法
  13. Log.info("har msg");
  14. func();
  15. })
  16. }
  17. .width('100%')
  18. }
  19. .height('100%')
  20. }
  21. }

引用HAR的native方法

通过import引用HAR导出的native方法,示例如下所示:

  1. // entry/src/main/ets/pages/Index.ets
  2. import { nativeAdd } from "library"
  3. @Entry
  4. @Component
  5. struct Index {
  6. @State message: string = 'Hello World'
  7. build() {
  8. Row() {
  9. Column() {
  10. Text(this.message)
  11. .fontSize(50)
  12. .fontWeight(FontWeight.Bold)
  13. Button('nativeAdd(1, 2)')
  14. .onClick(()=> {
  15. this.message = "result: " + nativeAdd(1, 2);
  16. })
  17. }
  18. .width('100%')
  19. }
  20. .height('100%')
  21. }
  22. }

引用HAR的资源

通过$r引用HAR中的资源,例如在HAR模块的src/main/resources里添加字符串资源(在string.json中定义,name:hello_har)和图片资源(icon_har.png),然后在Entry模块中引用该字符串和图片资源的示例如下所示:

  1. // entry/src/main/ets/pages/Index.ets
  2. @Entry
  3. @Component
  4. struct Index {
  5. build() {
  6. Row() {
  7. Column() {
  8. // 引用HAR的字符串资源
  9. Text($r("app.string.hello_har"))
  10. .fontSize(50)
  11. .fontWeight(FontWeight.Bold)
  12. // 引用HAR的图片资源
  13. Image($r("app.media.icon_har"))
  14. }
  15. .width('100%')
  16. }
  17. .height('100%')
  18. }
  19. }
以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号