• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 错误管理开发指导
2
3## 场景介绍
4
5当应用的代码存在规范问题或错误时，会在运行中产生异常和错误，如应用未捕获异常、应用生命周期超时等。在错误产生后，应用会异常退出。错误日志通常会保存在用户本地存储上，不方便开发者定位问题。所以，应用开发者可以使用错误管理的接口，在应用退出前，及时将相关错误及日志上报到开发者的服务平台来定位问题。
6
7## 接口说明
8
9应用错误管理接口由errorManager模块提供，开发者可以通过import引入，详见[开发示例](#开发示例)。
10
11**错误管理接口功能介绍：**
12
13| 接口名称                                                       | 说明                                                 |
14| ------------------------------------------------------------ | ---------------------------------------------------- |
15| on(type: "error", observer: ErrorObserver): number       | 注册错误监听接口，当系统监测到应用异常时会回调该监听。该接口为同步接口，返回值为注册的监听对象对应的序号。 |
16| off(type: "error", observerId: number,  callback: AsyncCallback\<void\>): void | 以callback的形式解除注册监听，传入的number为之前注册监听时返回的序号。  |
17| off(type: "error", observerId: number): Promise\<void\> | 以Promise的形式解除注册监听，传入的number为之前注册监听时返回的序号。  |
18
19当采用callback作为异步回调时，可以在callback中进行下一步处理。当采用Promise对象返回时，可以在Promise对象中类似地处理接口返回值。具体结果码说明见[解除注册结果码](#解除注册结果码)。
20
21
22**错误监听(ErrorObserver)接口功能介绍：**
23
24| 接口名称                         | 说明                                                         |
25| ------------------------------ | ------------------------------------------------------------ |
26| onUnhandledException(errMsg: string): void | 系统回调接口，应用注册后，当应用产生未捕获的异常时的回调。 |
27
28
29### 解除注册结果码
30
31| 结果码 | 原因                        |
32| ------ | ---------------------------  |
33| 0      |  正常返回                          |
34| -1     | 传入的number不存在              |
35| -2     | 参数错误       |
36
37## 开发示例
38```ts
39import UIAbility from '@ohos.app.ability.UIAbility';
40import errorManager from '@ohos.app.ability.errorManager';
41
42let registerId = -1;
43let callback = {
44    onUnhandledException: function (errMsg) {
45        console.log(errMsg);
46    }
47}
48
49export default class EntryAbility extends UIAbility {
50    onCreate(want, launchParam) {
51        console.log("[Demo] EntryAbility onCreate")
52        registerId = errorManager.on("error", callback);
53        globalThis.abilityWant = want;
54    }
55
56    onDestroy() {
57        console.log("[Demo] EntryAbility onDestroy")
58        errorManager.off("error", registerId, (result) => {
59            console.log("[Demo] result " + result.code + ";" + result.message)
60        });
61    }
62
63    onWindowStageCreate(windowStage) {
64        // Main window is created, set main page for this ability
65        console.log("[Demo] EntryAbility onWindowStageCreate")
66
67        windowStage.loadContent("pages/index", (err, data) => {
68            if (err.code) {
69                console.error('Failed to load the content. Cause:' + JSON.stringify(err));
70                return;
71            }
72            console.info('Succeeded in loading the content. Data: ' + JSON.stringify(data))
73        });
74    }
75
76    onWindowStageDestroy() {
77        // Main window is destroyed, release UI related resources
78        console.log("[Demo] EntryAbility onWindowStageDestroy")
79    }
80
81    onForeground() {
82        // Ability has brought to foreground
83        console.log("[Demo] EntryAbility onForeground")
84    }
85
86    onBackground() {
87        // Ability has back to background
88        console.log("[Demo] EntryAbility onBackground")
89    }
90};
91```