• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# HAR
2HAR(Harmony Archive)是静态共享包,可以包含代码、C++库、资源和配置文件。通过HAR可以实现多个模块或多个工程共享ArkUI组件、资源等相关代码。HAR不同于HAP,不能独立安装运行在设备上,只能作为应用模块的依赖项被引用。
3
4## 创建HAR模块
5通过DevEco Studio创建一个HAR模块,创建方式可[参考](https://developer.harmonyos.com/cn/docs/documentation/doc-guides-V3/creating_har_api9-0000001518082393-V3#section143510369612)。HAR模块默认不开启混淆能力,开启混淆能力,需要把HAR模块的build-profile.json5文件中的artifactType字段设置为obfuscation,配置如下所示:
6
7```json
8{
9  "apiType": "stageMode",
10  "buildOption": {
11      "artifactType": "obfuscation"
12  }
13}
14```
15artifactType字段有以下两种取值,默认缺省为original。
16- original:不混淆。
17- obfuscation:混淆,目前仅支持uglify混淆。
18
19需要对代码资产进行保护时,建议开启混淆能力,混淆能力开启后,DevEco Studio在构建HAR时,会对代码进行编译、混淆及压缩处理,保护代码资产。
20注意:artifactType字段设置为obfuscation时,apiType字段必须设置为stageMode,因为Stage模型才支持混淆。
21
22## HAR开发注意事项
23- HAR不支持在配置文件中声明abilities、extensionAbilities组件。
24- HAR不支持在配置文件中声明pages页面。
25- HAR不支持在build-profile.json5文件的buildOption中配置worker。
26- FA模型与Stage模型的HAR不支持相互引用。
27- Stage模型的HAR,不能引用AppScope内的内容。在编译构建时APPScope中的内容不会打包到HAR中,导致HAR资源引用失败。
28
29## 导出HAR的ArkUI组件、接口、资源
30index.ets文件是HAR导出声明文件的入口,HAR需要导出的接口,统一在index.ets文件中导出。index.ets文件是DevEco Studio默认自动生成的,用户也可以自定义,在模块的oh-package.json5文件中的main字段配置入口声明文件,配置如下所示:
31```json
32{
33  "main": "index.ets"
34}
35```
36### 导出ArkUI组件
37ArkUI组件的导出方式与ts的导出方式一致,通过`export`导出ArkUI组件,示例如下:
38```js
39// library/src/main/ets/components/MainPage/MainPage.ets
40@Component
41export struct MainPage {
42  @State message: string = 'Hello World'
43  build() {
44    Row() {
45      Column() {
46        Text(this.message)
47          .fontSize(50)
48          .fontWeight(FontWeight.Bold)
49      }
50      .width('100%')
51    }
52    .height('100%')
53  }
54}
55```
56HAR对外暴露的接口,在index.ets导出文件中声明如下所示:
57```js
58// library/index.ets
59export { MainPage } from './src/main/ets/components/MainPage/MainPage'
60```
61### 导出ts类和方法
62通过`export`导出ts类和方法,支持导出多个ts类和方法,示例如下所示:
63```js
64// library/src/main/ts/test.ets
65export class Log {
66    static info(msg) {
67        console.info(msg);
68    }
69}
70
71export function func() {
72  return "har func";
73}
74
75export function func2() {
76  return "har func2";
77}
78```
79HAR对外暴露的接口,在index.ets导出文件中声明如下所示:
80```js
81// library/index.ets
82export { Log } from './src/main/ts/test'
83export { func } from './src/main/ts/test'
84export { func2 } from './src/main/ts/test'
85```
86### 资源
87HAR模块编译打包时会把资源打包到HAR中。在编译构建HAP时,DevEco Studio会从HAP模块及依赖的模块中收集资源文件,如果不同模块下的资源文件出现重名冲突时,DevEco Studio会按照以下优先级进行覆盖(优先级由高到低):
88- AppScope(仅API9的Stage模型支持)。
89- HAP包自身模块。
90- 依赖的HAR模块,如果依赖的多个HAR之间有资源冲突,会按照依赖顺序进行覆盖(依赖顺序在前的优先级较高)。
91
92## 引用HAR的ArkUI组件、接口、资源
93引用HAR前,需要先配置对HAR的依赖,配置方式可[参考](https://developer.harmonyos.com/cn/docs/documentation/doc-guides-V3/creating_har_api9-0000001518082393-V3#section611662614153)94
95### 引用HAR的ArkUI组件
96
97HAR的依赖配置成功后,可以引用HAR的ArkUI组件。ArkUI组件的导入方式与ts的导入方式一致,通过`import`引入HAR导出的ArkUI组件,示例如下所示:
98```js
99// entry/src/main/ets/pages/index.ets
100import { MainPage } from "@ohos/library"
101
102@Entry
103@Component
104struct Index {
105  @State message: string = 'Hello World'
106  build() {
107    Row() {
108      // 引用HAR的ArkUI组件
109      MainPage()
110      Column() {
111        Text(this.message)
112          .fontSize(50)
113          .fontWeight(FontWeight.Bold)
114      }
115      .width('100%')
116    }
117    .height('100%')
118  }
119}
120```
121### 引用HAR的类和方法
122通过`import`引用HAR导出的ts类和方法,示例如下所示:
123```js
124// entry/src/main/ets/pages/index.ets
125import { Log } from "@ohos/library"
126import { func } from "@ohos/library"
127
128@Entry
129@Component
130struct Index {
131  build() {
132    Row() {
133      Column() {
134        Button('Button')
135          .onClick(()=>{
136            // 引用HAR的类和方法
137            Log.info("har msg");
138            func();
139        })
140      }
141      .width('100%')
142    }
143    .height('100%')
144  }
145}
146```
147### 引用HAR的资源
148通过`$r`引用HAR中的资源,例如在HAR模块的`src/main/resources`里添加字符串资源(在string.json中定义,name:hello_har)和图片资源(icon_har.png),然后在Entry模块中引用该字符串和图片资源的示例如下所示:
149```js
150// entry/src/main/ets/pages/index.ets
151@Entry
152@Component
153struct Index {
154  build() {
155    Row() {
156      Column() {
157        // 引用HAR的字符串资源
158        Text($r("app.string.hello_har"))
159          .fontSize(50)
160          .fontWeight(FontWeight.Bold)
161        // 引用HAR的图片资源
162        Image($r("app.media.icon_har"))
163      }
164      .width('100%')
165    }
166    .height('100%')
167  }
168}
169```
170
171## 发布HAR
172
173发布HAR可[参考](https://developer.harmonyos.com/cn/docs/documentation/doc-guides-V3/creating_har_api9-0000001518082393-V3#section1213451811512)174