• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Ability助手使用指导
2
3Ability assistant(Ability助手,简称为aa)是实现应用、原子化服务、及测试用例启动功能的工具,为开发者提供基本的应用调试和测试的能力。通过该工具,开发者可以在hdc shell中,发送命令以执行各种系统操作,比如启动Ability、强制停止进程、打印Ability相关信息等。
4
5## 开发指导
6
7工具已在设备环境预置,开发者可直接通过命令行调用。
8
9### 查询相关
10
11- **help**
12
13  用于显示aa相关的帮助信息。
14
15  **返回值:**
16
17  返回对应的帮助信息。
18
19  **使用方法:**
20
21  ```
22  aa help
23  ```
24
25### Ability相关
26
27- **start**
28
29  用于启动一个ability。
30
31  | 参数      | 参数说明                   |
32  | --------- | -------------------------- |
33  | -h/--help | 帮助信息。                 |
34  | -d        | 可选参数,`device id`。    |
35  | -a        | 必选参数,`ability name`。 |
36  | -b        | 必选参数,`bundle name`。  |
37  | -D        | 可选参数,调试模式。       |
38
39  **返回值:**
40
41  当成功启动Ability时,返回“start ability successfully.”;当启动失败时,返回“error: failed to start ability.”。
42
43  **使用方法:**
44
45  ```
46  aa start [-d <device-id>] -a <ability-name> -b <bundle-name> [-D]
47  ```
48
49- **stop-service**
50
51  用于停止Service Ability。
52
53  | 参数      | 参数说明                 |
54  | --------- | ------------------------ |
55  | -h/--help | 帮助信息。               |
56  | -d        | 可选参数,device id。    |
57  | -a        | 必选参数,ability name。 |
58  | -b        | 必选参数,bundle name。  |
59
60  **返回值:**
61
62  当成功停止Service Ability时,返回“stop service ability successfully.”;当停止失败时,返回“error: failed to stop service ability.”。
63
64  **使用方法:**
65
66  ```
67  aa stop-service [-d <device-id>] -a <ability-name> -b <bundle-name>
68  ```
69
70- **dump**
71
72  用于打印Ability的相关信息。
73
74  | 参数              | 二级参数             | 参数说明                                                     |
75  | ----------------- | -------------------- | ------------------------------------------------------------ |
76  | -h/--help         | -                    | 帮助信息。                                                   |
77  | -a/--all          | -                    | 打印所有mission内的Ability。                                 |
78  | -l/--mission-list | type(缺省打印全部) | 打印任务栈信息。<br />type:<br />NORMAL <br />DEFAULT_STANDARD<br />DEFAULT_SINGLE<br />LAUNCHER |
79  | -e/--extension    | elementName          | 打印扩展组件信息。                                           |
80  | -u/--userId       | UserId               | 打印指定UserId的栈信息,需要和其他参数组合使用,例如 `aa dump -a -u 100`、`aa dump -d -u 100` |
81  | -d/--data         |                      | 打印Data Ability。                                           |
82  | -i/--ability      | AbilityRecord ID     | 打印指定Ability详细信息                                      |
83  | -c/--client       |                      | 打印Ability详细信息,需要和其他参数组合使用,例如 `aa dump -a -c`、`aa dump -i 21 -c` |
84
85  **使用方法:**
86
87  ```
88  aa dump -a
89  ```
90  ![aa-dump-a](figures/aa-dump-a.PNG)
91  ```
92  aa dump -l
93  ```
94  ![aa-dump-l](figures/aa-dump-l.PNG)
95  ```
96  aa dump -i 12
97  ```
98  ![aa-dump-i](figures/aa-dump-i.PNG)
99- **force-stop**
100
101  通过bundle name强制停止一个进程。
102
103  **返回值:**
104
105  当成功强制停止该进程时,返回“force stop process successfully.”;当强制停止失败时,返回“error: failed to force stop process.”。
106
107  **使用方法:**
108
109  ```
110  aa force-stop <bundle-name>
111  ```