• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# aa工具
2
3
4Ability assistant(Ability助手,简称为aa),是实现应用及测试用例启动功能的工具,为开发者提供基本的应用调试和测试能力,例如启动应用组件、强制停止进程、打印应用组件相关信息等。
5
6> **说明:**
7>
8> 在使用本工具前,开发者需要先获取[hdc工具](../../device-dev/subsystems/subsys-toolchain-hdc-guide.md),执行hdc shell。
9
10
11- help
12  用于显示aa相关的帮助信息。
13
14  **返回值**:
15
16  返回对应的帮助信息。
17
18  **使用方法**:
19
20
21  ```bash
22  aa help
23  ```
24
25
26- start
27  用于启动一个应用组件,目标组件可以是FA模型的PageAbility和ServiceAbility组件,也可以是Stage模型的UIAbility和ServiceExtensionAbility组件,且目标组件相应配置文件中的visible标签不能配置为false。
28
29  | 参数 | 参数说明 |
30  | -------- | -------- |
31  | -h/--help | 帮助信息。 |
32  | -d | 可选参数,deviceId。 |
33  | -a | 必选参数,abilityName。 |
34  | -b | 必选参数,bundleName。 |
35  | -D | 可选参数,调试模式。 |
36
37  **返回值**:
38
39  当启动成功时,返回"start ability successfully.";当启动失败时,返回"error: failed to start ability.",同时会包含相应的失败信息。
40
41  **使用方法**:
42
43
44  ```bash
45  aa start [-d <deviceId>] -a <abilityName> -b <bundleName> [-D]
46  ```
47
48- stop-service
49  用于停止ServiceAbility。
50
51  | 参数 | 参数说明 |
52  | -------- | -------- |
53  | -h/--help | 帮助信息。 |
54  | -d | 可选参数,deviceId。 |
55  | -a | 必选参数,abilityName。 |
56  | -b | 必选参数,bundleName。 |
57
58  **返回值**:
59
60  当成功停止ServiceAbility时,返回"stop service ability successfully.";当停止失败时,返回"error: failed to stop service ability."。
61
62  **使用方法**:
63
64
65  ```bash
66  aa stop-service [-d <deviceId>] -a <abilityName> -b <bundleName>
67  ```
68
69- dump
70    用于打印应用组件的相关信息。
71    | 参数 | 二级参数 | 参数说明 |
72  | -------- | -------- | -------- |
73  | -h/--help | - | 帮助信息。 |
74  | -a/--all | - | 打印所有mission内的应用组件信息。 |
75  | -l/--mission-list | type(缺省打印全部) | 服务侧为了方便管理任务链,内部维护了4种类型的任务链。<br/>可取值:<br/>-&nbsp;NORMAL: 正常启动的任务链(比如A拉起B拉起C, 则对应的任务链是A->B->C)<br/>-&nbsp;DEFAULT_STANDARD: 已经被破坏的任务链中的任务, 启动模式为standard的任务被放到该任务链中, 这里面的任务之间没有关联关系<br/>-&nbsp;DEFAULT_SINGLE: 已经被破坏的任务链中的任务, 启动模式为singleton的任务被放到该任务链中, 这里面的任务之间没有关联关系<br/>-&nbsp;LAUNCHER: launcher的任务链 |
76  | -e/--extension | elementName | 打印扩展组件信息。 |
77  | -u/--userId | UserId | 打印指定UserId的栈信息,需要和其他参数组合使用,例如aa&nbsp;dump&nbsp;-a&nbsp;-u&nbsp;100、aa&nbsp;dump&nbsp;-d&nbsp;-u&nbsp;100。 |
78  | -d/--data | - | 打印DataAbility相关信息。 |
79  | -i/--ability | AbilityRecord&nbsp;ID | 打印指定应用组件详细信息。 |
80  | -c/--client | - | 打印应用组件详细信息,需要和其他参数组合使用,例如aa&nbsp;dump&nbsp;-a&nbsp;-c、aa&nbsp;dump&nbsp;-i&nbsp;21&nbsp;-c。 |
81
82  **使用方法**:
83
84
85  ```bash
86  aa dump -a
87  ```
88
89  ![aa-dump-a](figures/aa-dump-a.png)
90
91
92  ```bash
93  aa dump -l
94  ```
95
96  ![aa-dump-l](figures/aa-dump-l.png)
97
98
99  ```bash
100  aa dump -i 12
101  ```
102
103  ![aa-dump-i](figures/aa-dump-i.png)
104
105- force-stop
106  通过bundleName强制停止一个进程。
107
108  **返回值**:
109
110  当成功强制停止该进程时,返回"force stop process successfully.";当强制停止失败时,返回"error: failed to force stop process."。
111
112  **使用方法**:
113
114
115  ```bash
116  aa force-stop <bundleName>
117  ```
118