1# 分析JS Crash（进程崩溃）
2
3当未处理的JS异常导致应用意外退出时，应用会在抛出未处理的异常时崩溃并且会生成对应的JS Crash崩溃日志文件。开发者可通过错误日志查看引起崩溃的代码位置及分析应用崩溃的原因。
4
5本文将分别介绍JS Crash异常捕获场景，JS Crash故障分析思路，以及典型分析案例。
6
7## JS Crash异常检测能力
8
9### JS Crash日志规格
10
11以下是进程崩溃日志信息中对应字段解释。
12
13```
14Build info:XXX-XXXX X.X.X.XX(XXXXXXXX) <- 版本信息
15Module name:com.example.myapplication <- 模块名
16Version:1.0.0 <- 版本号
17Pid:579 <- 进程号
18Uid:0 <- 用户ID
19Reason:TypeError <- 原因
20Error message:Cannot read property c of undefined <- 异常信息
21Cannot get SourceMap info, dump raw stack: <- 应用安装包为release包安装时不包含sourcemap文件，JS栈通过sourcemap行列号解析会失败
22SourceCode:
23        var a = b.c;   <- 异常代码位置
24                ^
25Stacktrace:
26    at onPageShow (entry/src/main/ets/pages/Index.ets:7:13)  <-异常代码调用栈
27           ^                                      ^
28         函数名异常代码文件行列号位置
29```
30
31JS Crash多为应用问题，开发者可通过崩溃文件中的 Error message 和 StackTrace 来定位问题。
32
33### JS Crash异常捕获场景
34
35JS Crash异常根据不同的异常场景，在 Reason 字段进行了分类，分为Error、TypeError、SyntaxError、RangeError等错误类型。
36
37 - 自定义 Error 类：Error 是最基本的错误类型，其他的错误类型都继承自该类型。Error 对象主要有两个重要属性 message 和 name 分别表示错误信息和错误名称。程序运行过程中抛出的异常一般都有具体的类型，Error 类型一般都是开发人员自己抛出的异常。
38
39 - TypeError（类型错误）类：运行时最常见的异常，表示变量或参数不是预期类型。
40
41 - SyntaxError（语法错误）类：语法错误也称为解析错误。语法错误在任何编程语言中都是最常见的错误类型，表示不符合编程语言的语法规范。
42
43 - RangeError（边界错误）类：表示超出有效范围时发生的异常，主要的有以下几种情况：
44    - 数组长度为负数或超长
45    - 数字类型的方法参数超出预定义范围
46    - 函数堆栈调用超过最大值
47
48 - ReferenceError —— 引用错误：引用一个不存在的变量时发生的错误，每当我们创建一个变量时，变量名称都会写入一个变量存储中心中，这个变量存储中心就像键值存储一样，每当我们引用变量时，它都去存储中找到 key并提取并返回 value，如果我们要找的变量不在存储中，就会抛出 ReferenceError。
49
50 - URI Error —— URL错误：在调用 URI 相关的方法中 URL 无效时抛出的异常，主要包括 `encodeURI()`、`decodeURI()`、`encodeURIComponent()`、`decodeURIComponent()`、`escape()` 和 `unescape()` 几个函数 。
51
52## 问题定位思路
53
54### 获取日志
55
56进程崩溃日志是一种故障日志，与应用无响应日志、JS应用崩溃等都由FaultLogger模块管理，可通过以下方式获取：
57
58- 方式一：通过DevEco Studio获取日志
59
60    DevEco Studio会收集设备“/data/log/faultlog/faultlogger/”路径下的进程崩溃故障日志并归档在FaultLog下，获取日志的方法可参考<!--RP1-->[DevEco Studio使用指南-FaultLog](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides-V5/ide-fault-log-V5)<!--RP1End-->。
61
62- 方式二：通过hiAppEvent接口订阅
63
64    hiAppEvent 提供了故障订阅接口，可以订阅各类故障打点，详见[HiAppEvent介绍](hiappevent-intro.md)。
65
66<!--Del-->
67- 方式三：通过shell获取日志
68
69    进程崩溃后，JS Crash文件会生成在设备“/data/log/faultlog/faultlogger/”路径下，故障日志文件名格式为“jscrash-进程名-进程UID-秒级时间”，包含设备名、系统版本、进程崩溃调用栈等信息。
70
71    ![](figures/jscrash.png)
72<!--DelEnd-->
73
74### 根因分析
75
76JS Crash问题分析一般根据上述异常的场景，结合错误信息、调用栈定位到源码，可得出基本的分析结论。对于调用栈的分析有以下几种情况。
77
78#### 1. StackTrace 场景分类
79
80JS Crash故障日志中，StackTrace 字段存放的是 JS Crash 异常的调用栈信息，StackTrace 的显示分为以下几种场景。
81
821. JS调用栈可直接通过超链接跳转到对应错误代码行，栈顶即为问题第一现场，如下样例所示。
83    ```
84    Device info:xxx
85    Build info:xxx-xxx x.x.x.xxx(xxxx)
86    Fingerprint:ed1811f3f5ae13c7262b51aab73ddd01df95b2c64466a204e0d70e6461cf1697
87    Module name:com.xxx.xxx
88    Version:1.0.0
89    VersionCode:1000000
90    PreInstalled:No
91    Foreground:Yes
92    Pid:31255
93    Uid:20020145
94    Reason:Error
95    Error name:Error
96    Error message:JSERROR
97    Sourcecode:
98                    throw new ErrOr("JSERROR");
99                          ^
100    Stacktrace:
101        at anonymous (entry/src/main/ets/pages/Index.ets:13:19)
102    ```
103
1042. 异常代码调用栈 Stack Cannot get SourceMap info, dump raw stack，表示因SourceMap转换失败，仅展示eTS栈对应编译后产物中代码行号，可通过超链接跳转到对应错误代码行，如下样例所示。
105    ```
106    Device info:xxx
107    Build info:xxx-xxx x.x.x.xxx(xxxx)
108    Fingerprint:a370fceb59011d96e41e97bda139b1851c911012ab8c386d1a2d63986d6d226d
109    Module name:com.xxx.xxx
110    Version:1.0.0
111    Versioncode:1000000
112    PreInstalled:No
113    Foreground:Yes
114    Pid:39185
115    Uid:20020145
116    Reason:Error
117    Error name:Error
118    Error message:JSERROR
119    Stacktrace:
120    Cannot get SourceMap info, dump raw stack:
121        at anonymous (entry/src/main/ets/paqes/Index.ts:49:49)
122    ```
123
1243. 异常代码调用栈包含 SourceMap is not initialized yet ，表示因SourceMap转换非常耗时，改为通过异步线程去进行初始化，导致会出现SourceMap没初始化完成就有异常产生的情况。针对这种情况增加这行日志来提示开发者。eTS栈对应编译后产物中代码行号，可通过超链接跳转到对应错误代码行。如下样例所示。
125    ```
126    Device info:xxx
127    Build info:xxx-xxx x.x.x.xxx(xxxx)
128    Fingerprint:377ef8529301363f373ce837d0bf83aacfc46112502143237e2f4026e86a0510
129    Module name:com.xxx.xxx
130    Version:1.0.0
131    Versioncode:1000000
132    PreInstalled:No
133    Foreground:Yes
134    Pid:6042
135    Uid:20020145
136    Reason:Error
137    Error name:Error
138    Error message:JSERROR
139    Sourcecode:
140                throw new Error("JSERROR");
141                      ^
142    Stacktrace:
143    SourceMap is not initialized yet
144    at anonymous (entry/src/main/ets/pages/Index.ts:49:49)
145    ```
146
1474. 异常代码调用栈中打印native栈，栈顶一般为libark_jsruntime.so动态库，这是因为JS异常最后都会经过虚拟机抛出。从崩溃栈从上往下找，libace_napi.z.so的上一帧一般是抛出异常的现场。如下样例所示。
148    ```
149    Device info:xxx
150    Build info:xxx-xxx x.x.x.xxx(xxxx)
151    Fingerprint:89f2b64b24d642b0fc64e3a7cf68ca39fecaa580ff5736bb9d6706ea4cdf2c93
152    Module name:com.xxx.xxx
153    Version:1.0.0
154    VersionCode:1000000
155    PreInstalled:No
156    Foreground:No
157    Pid:14325
158    Uid:20020145
159    Reason:ReferenceError
160    Error name:ReferenceError
161    Error message:Cannot find module 'com.xxx.xxx/entry/EntryAbility' , which is application Entry Point
162    Stacktrace:
163    SourceMap is not initialized yet
164    #01 pc 000000000028ba3b /system/libó4/platformsdk/libark_jsruntime.so(bf6ea8e474ac3e417991f101e062fa90)
165    #02 pc 00000000001452ff /system/libó4/platformsdk/libark_jsruntime.so(bf6ea8e474ac3e417991f101e062fa90)
166    #03 pC 0000000000144c9f /system/libó4/platformsdk/libark_jsruntime.so(bf6ea8e474ac3e417991f101e062fa90)
167    #04 pc 00000000001c617b /system/libó4/platformsdk/libark_jsruntime.so(bf6ea8e474ac3e417991f101e062fa90)
168    #05 pc 00000000004c3cb7 /system/libó4/platformsdk/libark_jsruntime.so(bf6ea8e474ac3e417991f101e062fa90)
169    #06 pc 00000000004c045f /system/libó4/platformsdk/libark_jsruntime.so(bf6ea8e474ac3e417991f101e062fa90)
170    #07 pc 000000000038034f /system/libó4/platformsdk/libark_jsruntime.so(bf6ea8e474ac3e417991f101e062fa90)
171    #08 pc 00000000004b2d9b /system/libó4/platformsdk/libark_jsruntime.so(bf6ea8e474ac3e417991f101e062fa90)
172    #09 pc 0000000000037e7f /system/libó4/platformsdk/libace_napi.z.so(10ceafd39b5354314d2fe3059b8f9e4f)
173    #10 pc 00000000000484cf /system/lib64/platformsdk/libruntime.z.so(3f6305a3843fae1de148a06eec4bd014) <- 异常抛出位置
174    #11 pc 000000000004fce7 /system/libó4/platformsdk/libruntime.z.so(3f6305a3843fae1de148a06eec4bd014)
175    #12 pc 000000000004e9fb /system/libó4/platformsdk/libruntime.z.so(3f6305a3843fae1de148a06eec4bd014)
176    #13 pc 000000000004eb7b /system/libó4/platformsdk/libruntime.z.so(3f6305a3843fae1de148a06eec4bd014)
177    #14 pc 000000000004f5c7 /system/libó4/platformsdk/libruntime.z.so(3f6305a3843fae1de148a06eec4bd014)
178    #15 pc 00000000000303cf /system/lib64/platformsdk/libuiabilitykit_native.z.so(3203F4CCe84a43b519d0a731dfOdb1a3)
179    ```
180
181#### 2. 调用栈分析
182
183调用栈分析会有如下两种情况：
184
185- **情况一：可跳转至引起错误的代码行**
186
187  如果FaultLog的堆栈信息中的链接或偏移地址指向的是当前工程中的某行代码，该段信息将被转换为超链接形式，在DevEco Studio中点击后跳转至对应代码行。
188
189- **情况二：不可跳转至引起错误的代码行或者跳转代码位置不存在**
190
191  如出现`Cannot get Source Map info, dump raw stack`信息代表js栈转换ets行列号失败，在DevEco Studio中点击链接会跳转到不正确的代码位置或不存在的代码行位置。
192
193  应用代码运行出错时，会打印错误栈信息。如果ts栈转换ets行列号失败时错误栈的后缀仍显示为ets，开发者需要在build目录下编译中间产物以生成ts代码，在js代码中定位对应错误代码行。可参考：[应用堆栈解析](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides-V5/ide-release-app-stack-analysis-V5)。
194
195
196## 分析案例
197
198本章节将基于现在开发者所遇到的高频的两类JS Crash故障进行案例介绍，包含 TypeError 和 Error 类。
199
200### TypeError类案例分析
201
202TypeError类问题在实际应用开发调试运行过程中是最常见的JS Crash类型，其表示为变量不是预期类型，在代码层面则为对变量的使用未进行事先的校验，在错误日志中报错多表现为如下：
203
204```
205Error name:TypeError
206Error message:Cannot read property xxx of undefined
207```
208
209#### 案例一：更新跟手动效相关属性时偶现JS Crash
210
2111. 获取JS Crash日志如下：
212
213    ```
214    Generated by HiviewDFX@OpenHarmony
215    ================================================================
216    Device info:xxxx
217    Build info:xxxx
218    Fingerprint:9851196f9fed7fd818170303296ae7a5767c9ab11f38fd8b0072f0e32c42ea39
219    Module name:com.xxx.xxx
220    Version:1.0.0.29
221    VersionCode:10000029
222    PreInstalled:Yes
223    Foreground:No
224    Pid:2780
225    Uid:20020018
226    Reason:TypeError
227    Error name:TypeError
228    Error message:Cannot read property needRenderTranslate of undefined
229    Stacktrace:
230    Cannot get SourceMap info, dump raw stack:
231        at updateGestureValue (phone/src/main/ets/SceneBoard/recent/scenepanel/recentpanel/RecentGesture.ts:51:51)
232        at onRecentGestureActionBegin (phone/src/main/ets/SceneBoard/scenemanager/SCBScenePanel.ts:5609:5609)
233        at anonymous (phone/src/main/ets/SceneBoard/scenemanager/SCBScenePanel.ts:555:555)
234        at anonymous (phone/src/main/ets/SceneBoard/recent/RecentEventView.ts:183:183)
235    ```
236
2372. 提取日志关键信息
238
239    通过日志信息可以确定为Type Error类问题，由异常信息得知是在读取needRenderTranslate对象时报错，该对象为undefined。最后可以通过异常代码调用栈，获取错误产生位置。
240Cannot get SourceMap info, dump raw stack 信息表示该应用为release包安装，JS栈转换eTS行列号失败，可考虑使用[应用堆栈解析](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides-V5/ide-release-app-stack-analysis-V5)来解析行号。
241
2423. 定位到具体代码
243
244    通过以上 JS 堆栈和报错变量分析，能够定位到具体函数示例如下：
245
246    ```
247      // 更新与跟手动效相关的属性
248      public updateGestureValue(screenWidth: number, recentScale: number, sceneContainerSessionList: SCBSceneContainerSession[]) {
249        // 跟手移动的距离计算
250        this.translationUpY = (this.multiCardsNum >= 1) ? sceneContainerSessionList[this.multiCardsNum - 1].needRenderTranslate.translateY : 0;    ---> 报错行号
251        this.translationDownY = (this.multiCardsNum >= 2) ? sceneContainerSessionList[this.multiCardsNum - 2].needRenderTranslate.translateY : 0;
252        this.screenWidth = px2vp(screenWidth);
253        this.recentScale = recentScale;
254      }
255    ```
256
2574. 修改方案
258
259    上述分析已经明确为 sceneContainerSessionList 的成员变量 needRenderTranslate 在使用的过程中可能存在为 undefined 的情况。对于这类问题，需要增加保护性判断，可直接规避此类问题。具体修改方法可以如下，在访问对象前增加 '?' 操作符进行判断保护。
260
261    ```
262    // 更新与跟手动效相关的属性
263    public updateGestureValue(screenWidth: number, recentScale: number, sceneContainerSessionList: SCBSceneContainerSession[]) {
264      // 跟手移动的距离计算
265      this.translationUpY = (this.multiCardsNum >= 1) ?
266        sceneContainerSessionList[this.multiCardsNum - 1]?.needRenderTranslate.translateY : 0;
267      this.translationDownY = (this.multiCardsNum >= 2) ?
268        sceneContainerSessionList[this.multiCardsNum - 2]?.needRenderTranslate.translateY : 0;
269      this.screenWidth = px2vp(screenWidth);
270      this.recentScale = recentScale;
271    }
272    ```
273
2745. 思考与建议
275
276    对于这类问题，需要我们在编码阶段充分考虑对象访问的安全性，确保必要的判空处理。同时很多场景单纯的判空可能只能是规避问题，还需要结合业务看看是否是原始对象构造或赋值的逻辑存在问题。
277
278### Error 类案例分析
279
280Error 类问题一般是开发者或JS库主动抛出来的JS异常。
281
282这类问题目前有两种场景：
2831.	如果是当前应用程序遇到无法解决的只能终止当前业务的故障，需要考虑抛出JS异常来终止业务并生成故障日志。
2842.	依赖使用JS库或者其他的模块接口，对于可能抛出异常的接口，需要考虑使用 try-catch 机制进行捕获，否则也会终止当前业务。
285
286
287#### 案例一：如何主动抛出一个自定义的JS异常来终止程序
288
289开发者自主抛出JS异常，可通过如下代码实现：
290
291```
292throw new Error("TEST JS ERROR")
293```
294
295通过上述开发过程基于 DevEco Studio FaultLog工具收集到的故障日志，可以基于JS异常栈直接定位到抛异常的位置。
296
297![](figures/jscrash_error_trigger.png)
298
299遇到这类问题的解决思路，仍旧是通过故障日志定位到具体的代码行，检视上下文来分析问题即可。
300
301#### 案例二：因未处理三方接口抛出的JS异常导致的JS Crash问题
302
3031. 获取JS Crash 日志核心内容如下
304    ```
305    Error name:Error
306    Error message:BussinessError 2501000: Operation failed.
307    Error code:2501000
308    Stacktrace:
309    Cannot get SourceMap info, dump raw stack:
310      at onStart (product/phone/build/default/cache/default/default@CompileArkTS/esmodule/release/feature/systemstatus/linkspeedcomponent/src/main/ets/default/controller/NetSpeedController.ts:50:1)
311      at NetSpeedController (product/phone/build/default/cache/default/default@CompileArkTS/esmodule/release/feature/systemstatus/linkspeedcomponent/src/main/ets/default/controller/NetSpeedController.ts:43:43)
312      at getInstance (product/phone/build/default/cache/default/default@CompileArkTS/esmodule/release/staticcommon/basiccommon/src/main/ets/component/utils/SingletonHelper.ts:17:17)
313      at func_main_0 (product/phone/build/default/cache/default/default@CompileArkTS/esmodule/release/feature/systemstatus/linkspeedcomponent/src/main/ets/default/controller/NetSpeedController.ts:325:325)
314    ```
315
3162. 提取日志关键信息
317
318    通过日志信息可以确定为 Error 类问题，为代码主动抛出的异常。最后可以通过异常代码调用栈，获取错误产生位置。
319Cannot get SourceMap info, dump raw stack 信息表示该应用为release包安装，JS栈转换eTS行列号失败，可考虑使用[应用堆栈解析](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides-V5/ide-release-app-stack-analysis-V5)来解析行号。
320
3213. 定位到具体代码
322
323    通过以上 JS 堆栈，能够定位到 NetSpeedController.ts 文件中具体代码片段如下，异常抛出位置为 wifiManager.on 函数调用。
324
325    ```
326    onStart(): void {
327      super.onStart();
328      log.showInfo('onStart');
329      ...
330      wifiManager.on('wifiConnectionChange', (data) => {
331        this.isConnected = data === 1 ? true : false;
332        this.handleUpdateState();
333      });
334      wifiManager.on('wifiStateChange', (data) => {
335        this.isWifiActive = data === 1 ? true : false;
336        this.handleUpdateState();
337      });
338      ...
339    }
340    ```
341
3424. 修改方案
343
344    通过分析 wifiManager.on 源码，得知该函数内存在部分场景会抛出内容为 BussinessError 2501000: Operation failed. 的 JS 异常，对于此类问题，识别当前业务异常不会导致当前程序无法运行下去，考虑使用 try-catch 机制对异常进行捕获处理。具体的修改方法可参考如下:
345
346    ```
347    onStart(): void {
348      super.onStart();
349      log.showInfo('onStart');
350      ...
351      try {
352        wifiManager.on('wifiConnectionChange', (data) => {
353          this.isConnected = data === 1 ? true : false;
354          this.handleUpdateState();
355        });
356      } catch (error) {
357        log.showError('wifiConnectionChange error');
358      }
359      try {
360        wifiManager.on('wifiStateChange', (data) => {
361          this.isWifiActive = data === 1 ? true : false;
362          this.handleUpdateState();
363        });
364      } catch (error) {
365        log.showError('wifiStateChange error');
366      }
367      ...
368    }
369    ```
370
3715. 思考与建议
372
373    对于这类问题，我们可以考虑在编码阶段灵活的运用 JS 异常机制，来识别各类异常场景；同时对于使用可能会抛异常的接口，也需要考虑是否需要捕获该异常，避免影响应用主体业务。
374
375