1# 订阅踩内存事件（ArkTS）
2
3## 接口说明
4
5API接口的具体使用说明（参数使用限制、具体取值范围等）请参考[应用事件打点API文档](../reference/apis-performance-analysis-kit/js-apis-hiviewdfx-hiappevent.md)。
6
7| 接口名                                              | 描述                                         |
8| --------------------------------------------------- | -------------------------------------------- |
9| addWatcher(watcher: Watcher): AppEventPackageHolder | 添加应用事件观察者，以添加对应用事件的订阅。 |
10| removeWatcher(watcher: Watcher): void               | 移除应用事件观察者，以移除对应用事件的订阅。 |
11
12## 开发步骤
13
14以实现对写数组越界场景生成的踩内存事件订阅为例，说明开发步骤。
15
161. 新建Native C++工程，目录结构如下：
17
18   ```yml
19   entry:
20     src:
21       main:
22         cpp:
23           - types:
24               libentry:
25                 - index.d.ts
26           - CMakeLists.txt
27           - napi_init.cpp
28         ets:
29           - entryability:
30               - EntryAbility.ets
31           - pages:
32               - Index.ets
33   ```
34
352. 编辑工程中的“entry > src > main > ets > entryability > EntryAbility.ets”文件，导入依赖模块：
36
37   ```ts
38   import { hiAppEvent, hilog } from '@kit.PerformanceAnalysisKit';
39   ```
40
413. 编辑工程中的“entry > src > main > ets > entryability > EntryAbility.ets”文件，在onCreate函数中添加系统事件的订阅，示例代码如下：
42
43   ```ts
44   hiAppEvent.addWatcher({
45     // 开发者可以自定义观察者名称，系统会使用名称来标识不同的观察者
46     name: "watcher",
47     // 开发者可以订阅感兴趣的系统事件，此处是订阅了踩内存事件
48     appEventFilters: [
49       {
50         domain: hiAppEvent.domain.OS,
51         names: [hiAppEvent.event.ADDRESS_SANITIZER]
52       }
53     ],
54     // 开发者可以自行实现订阅系统事件回调函数，以便对订阅获取到的事件数据进行自定义处理
55     onReceive: (domain: string, appEventGroups: Array<hiAppEvent.AppEventGroup>) => {
56       hilog.info(0x0000, 'testTag', `HiAppEvent onReceive: domain=${domain}`);
57       for (const eventGroup of appEventGroups) {
58         // 开发者可以根据事件集合中的事件名称区分不同的系统事件
59         hilog.info(0x0000, 'testTag', `HiAppEvent eventName=${eventGroup.name}`);
60         for (const eventInfo of eventGroup.appEventInfos) {
61           // 开发者可以对事件集合中的事件数据进行自定义处理，此处是将事件数据打印在日志中
62           hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.domain=${eventInfo.domain}`);
63           hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.name=${eventInfo.name}`);
64           hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.eventType=${eventInfo.eventType}`);
65           hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.time=${eventInfo.params['time']}`);
66           hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.bundle_version=${eventInfo.params['bundle_version']}`);
67           hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.bundle_name=${eventInfo.params['bundle_name']}`);
68           hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.pid=${eventInfo.params['pid']}`);
69           hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.uid=${eventInfo.params['uid']}`);
70           hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.type=${eventInfo.params['type']}`);
71           hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.external_log=${JSON.stringify(eventInfo.params['external_log'])}`);
72           hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.log_over_limit=${eventInfo.params['log_over_limit']}`);
73         }
74       }
75     }
76   });
77   ```
78
794. 编辑“entry > src > main > cpp > types > libentry > index.d.ts”文件，完整示例代码如下：
80
81   ```ts
82   export const test: () => void;
83   ```
84
855. 编辑“entry > src > main > cpp > napi_init.cpp”文件，该文件实现地址越界场景，并提供NAPI接口给应用层代码调用，完整示例代码如下：
86
87   ```c++
88   #include "napi/native_api.h"
89
90   static napi_value Test(napi_env env, napi_callback_info info)
91   {
92       int a[10];
93       // 构造数组越界写入
94       a[10] = 1;
95       return {};
96   }
97
98   EXTERN_C_START
99   static napi_value Init(napi_env env, napi_value exports)
100   {
101       napi_property_descriptor desc[] = {
102           { "test", nullptr, Test, nullptr, nullptr, nullptr, napi_default, nullptr }
103       };
104       napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc);
105       return exports;
106   }
107   EXTERN_C_END
108
109   static napi_module demoModule = {
110       .nm_version = 1,
111       .nm_flags = 0,
112       .nm_filename = nullptr,
113       .nm_register_func = Init,
114       .nm_modname = "entry",
115       .nm_priv = ((void*)0),
116       .reserved = { 0 },
117   };
118
119   extern "C" __attribute__((constructor)) void RegisterEntryModule(void)
120   {
121       napi_module_register(&demoModule);
122   }
123   ```
124
1256. 编辑工程中的“entry > src > main > ets  > pages > Index.ets”文件，新增按钮触发踩内存事件：
126
127   ```ts
128   import testNapi from 'libentry.so'
129
130   @Entry
131   @Component
132   struct Index {
133     build() {
134       Row() {
135         Column() {
136           Button("address-sanitizer").onClick(() => {
137             testNapi.test();
138           })
139         }
140         .width('100%')
141       }
142       .height('100%')
143     }
144   }
145   ```
146
1477. 点击DevEco Studio界面中的“entry”，点击“Edit Configurations”，点击“Diagnostics”，勾选“Address Sanitizer”，保存设置。点击DevEco Studio界面中的运行按钮，运行应用工程，然后在应用界面中点击按钮“address-sanitizer”，触发一次踩内存事件。应用崩溃后重新进入应用，可以在Log窗口看到对系统事件数据的处理日志：
148
149   ```text
150   HiAppEvent onReceive: domain=OS
151   HiAppEvent eventName=ADDRESS_SANITIZER
152   HiAppEvent eventInfo.domain=OS
153   HiAppEvent eventInfo.name=ADDRESS_SANITIZER
154   HiAppEvent eventInfo.eventType=1
155   HiAppEvent eventInfo.time=1713161197957
156   HiAppEvent eventInfo.bundle_version=1.0.0
157   HiAppEvent eventInfo.bundle_name=com.example.myapplication
158   HiAppEvent eventInfo.pid=12889
159   HiAppEvent eventInfo.uid=20020140
160   HiAppEvent eventInfo.type=stack-buffer-overflow
161   HiAppEvent eventInfo.external_log=["/data/storage/el2/log/hiappevent/ADDRESS_SANITIZER_1713161197960_12889.log"]
162   HiAppEvent eventInfo.log_over_limit=false
163   ```
164