• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 在build-profile.json5中配置arkOptions
2
3## 概述
4
5arkOptions主要提供ArkTS编译相关配置，当前文档介绍arkOptions中types配置类型、maxFlowDepth配置控制流分析最大栈深度等，arkOptions中的其他配置项请参考[build-profile.json5](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/ide-hvigor-configuration-file-overview)。
6
7## types
8
9### types配置文件标签说明
10
11  arkOptions的types字段配置文件标签说明：
12
13| 属性名称 | 含义 | 配置范围 | 数据类型 | 是否可缺省 |
14| -------- | -------- | -------- | -------- | -------- |
15| types | 通过types字段将指定的类型声明文件作为全局引入，从而避免在每个源码文件中单独引入。 | 模块级 | 数组 | 该标签可缺省，缺省值为空。 |
16
17### arkOptions中的types字段配置说明
18
19arkOptions中types字段示例：
20
21在模块build-profile.json5配置文件buildOption标签的arkOptions属性中添加types字段。
22```json
23// 在/entry/build-profile.json5
24{
25  "arkOptions": {
26    "types": ["chai", "./oh_modules/@types/mocha", "./src/main/ets/pages/global"]
27  }
28}
29```
30
31types字段支持填写包名、包所在位置的相对路径以及声明文件所在相对路径，仅支持当前模块内的查找，若目录下存在同名文件（后缀不同），默认加载顺序.d.ets > .d.ts。<br />
32（1）填写包名方式：通过包名到oh_modules/@types/目录查找包名中定义的声明文件，如"chai"。<br />
33（2）填写包所在相对路径方式：支持在基于build-profile.json5的相对路径中查找定义的声明文件，如"./oh_modules/@types/mocha"。<br />
34（3）填写声明文件所在相对路径方式：支持查找相对路径下的声明文件，如"./src/main/ets/pages/global"。
35
36### 注意事项
37
38如果在types字段中填写包名或者包所在位置的相对路径，需要在工程文件/entry/oh-package.json5中dependencies作如下配置：
39```json
40"dependencies": {
41  "@types/chai": "latest",
42  "@types/mocha": "latest"
43}
44```
45
46如果在types字段中填写声明文件所在相对路径，前提是在模块下存在相应的声明文件，比如模块下存在src/main/ets/pages/global.d.ts声明文件，声明文件内容如下所示：
47```typescript
48declare namespace Global {
49  type ObjectType = string | number;
50}
51```
52
53通过types全局引入后，对全局类型的使用示例如下：
54```typescript
55// 在entry/src/main/ets/pages/Index.ets
56let a: Chai.Message;
57let b: Mocha.HookFunction;
58let c: Global.ObjectType;
59```
60
61## maxFlowDepth
62
63### maxFlowDepth配置文件标签说明
64
65  arkOptions下tscConfig中maxFlowDepth字段配置文件标签说明：
66
67| 属性名称 | 含义 | 配置范围 | 数据类型 | 是否可缺省 |
68| -------- | -------- | -------- | -------- | -------- |
69| maxFlowDepth | 开发者通过maxFlowDepth字段自定义配置tsc编译过程中的tsc控制流分析最大栈，避免固定最大栈导致编译报栈问题。该配置项可配置的最小值为2000，可配置最大值为65535。 | 工程级 | 数字型 | 该标签可缺省，缺省值时使用tsc控制流分析最大栈默认值2000。 |
70
71### arkOptions下的tscConfig中maxFlowDepth字段配置说明
72
73arkOptions/tscConfig中maxFlowDepth字段展示。
74在工程级目录下的build-profile.json5配置文件buildOption标签的arkOptions/tscConfig属性中添加maxFlowDepth字段。
75
76```typescript
77// 在工程名/build-profile.json5文件中
78"arkOptions": {
79  "tscConfig": {
80    "maxFlowDepth": 2222
81  }
82}
83```
84
85### 注意事项
86
87- 仅可在工程级目录下build-profile.json5文件中配置maxFlowDepth字段。
88- 若开发者未对maxFlowDepth字段进行配置时，则该字段默认为2000；若开发者对maxFlowDepth字段配置的值超过可配置范围，则会出现编译构建相关报错。
89
90  ```txt
91   hvigor ERROR: Schema validate failed.
92    Detail: Please check the following fields.
93      {
94         instancePath: 'app.products[0].buildOption.arkOptions.tscConfig.maxFlowDepth',
95         keyword: 'maximum',
96         params: { comparision: '<=', limit: 65535 },
97         message: 'must be <= 65535',
98         location: 'D:/工程名/build-profile.json5:行号:列号'
99      }
100  ```
101
102- 如果代码中函数或者模块过长导致控制流分析深度大于或者等于该字段所配置/默认的值，则会终止控制流分析并且报错：The containing function or module body is too large for control flow analysis.
103
104## transformLib
105
106### transformLib配置文件标签说明
107
108arkOptions的transformLib字段配置文件标签说明：
109
110| 属性名称 | 含义 | 配置范围 | 数据类型 | 是否可缺省 |
111| -------- | -------- | -------- | -------- | -------- |
112| transformLib | 字节码插桩插件配置，允许开发者在编译时对字节码进行插桩修改。仅支持Stage模型，格式为相对路径，指向实现插桩功能的动态库。不同系统要求的动态库文件类型如下，动态库文件内容需要在对应平台生成，不能拷贝修改后缀名混用。| 模块级 | 字符串型 | 该标签可缺省，缺省值时代表不使用该功能。 |
113
114### arkOptions中的transformLib字段配置说明
115
116arkOptions中transformLib字段示例：
117
118在模块build-profile.json5配置文件buildOption标签的arkOptions属性中添加transformLib字段。
119```json
120// 在/entry/build-profile.json5
121{
122  "buildOption": {
123    "arkOptions": {
124      "transformLib": "./dll/example.dll"
125    }
126  }
127}
128
129```
130修改方舟字节码能力可参考[编译期自定义修改方舟字节码](customize-bytecode-during-compilation.md)。
131
132### 注意事项
133
134- 若开发者未对字段进行配置时，则默认不使用该功能。
135- HAP、HSP模块配置即生效，HAR模块仅字节码HAR配置生效，非字节码HAR配置不生效。
136- 文件格式要求：Windows：.dll文件，Linux/Mac：.so文件。