最近遇到个问题，使用bugly还原后的堆栈，发现是一个空指针，但是那个地方无论如何也不可能为空。吃完饭回来，又继续看了下，发现被bugly误导了，不能只看还原出来的最后一行，由于没有行号，bugly是把所有可能都列出来了，要把上下文调用关系给串上才能知道是具体是哪一行crash了。借此我们熟悉下相关知识点吧。
mapping.txt说明
为了便于说明，假设有如下代码：
package com.wx.demo;
import android.content.Context;
import android.text.TextUtils;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* Created by wx on 11/11/2017.
*/
public class NetManager {
private Context mContext;
private NetManager gManager;
21 Map<String, String> getParams(String param){
22 Map<String, String> params;
23 if(TextUtils.isEmpty(param)){
24 params = null;
25 }else {
26 params = new HashMap<String, String>();
27 }
28 int size = params.size();
29 return params;
30 }
31
32 Map<String, String> getCommentsParams(String param){
33 Map<String, String> params;
34 if(TextUtils.isEmpty(param)){
35 params = null;
36 }else {
37 params = new HashMap<String, String>();
38 }
39 int size = params.size();
40 return params;
41 }
42
43 public List<Object> getFeeds(String param){
44 Map<String, String> params = getParams(param);
45 return new ArrayList<>();
46 }
47
48 public List<Object> getComments(String param){
49 Map<String, String> params = getCommentsParams(param);
50 return new ArrayList<>();
51 }
52}
混淆时关于源文件和行号有三种配置：
- 保留源文件名和行号
-keepattributes SourceFile,LineNumberTable
- 只保留行号，源文件名用一个固定的string(如SourceFile)代替
-keepattributes SourceFile,LineNumberTable
-renamesourcefileattribute SourceFile
- 源文件名和行号都不保留
1和2的配置下mapping.txt为：
com.wx.demo.NetManager -> com.wx.demo.con:
com.wx.demo.NetManager gManager -> b
android.content.Context mContext -> e
22:29:java.util.Map getParams(java.lang.String) -> a
33:40:java.util.Map getCommomParams(java.lang.String) -> a
44:45:java.util.List getFeeds(java.lang.String) -> b
49:50:java.util.List getComments(java.lang.String) -> b
这里的数字对应的是该函数所处的范围，如getParams函数的是22到29行。
3的配置下mapping.txt为：
com.wx.demo.NetManager -> com.wx.demo.con:
com.wx.demo.NetManager gManager -> b
android.content.Context mContext -> e
java.util.Map getParams(java.lang.String) -> a
java.util.Map getCommomParams(java.lang.String) -> a
java.util.List getFeeds(java.lang.String) -> b
java.util.List getComments(java.lang.String) -> b
可以看到，不同的函数名是可能被混淆成相同的名字的，这在程序中并没有什么问题，因为参数不同，即使函数名相同也没问题，但是对应到堆栈，如果行号没有保留的话，那么从出错堆栈中就无法一一对应的解析出。
解析crash堆栈
官方是提供了系统工具的，在sdk的<sdk-root>/tools/proguard/路径下，使用方式：
retrace.bat|retrace.sh [-verbose] mapping.txt [<stacktrace_file>]
例如：
retrace.bat -verbose mapping.txt obfuscated_trace.txt
在保留行号和源文件名的情况下，假如我们的堆栈是类似这样的：
java.lang.NullPointerException: Attempt to invoke interface method 'java.lang.Object java.util.Map.get(java.lang.Object)' on a null object reference
at com.wx.demo.NetManager.b(NetManager.java:28)
at com.wx.demo.NetManager.a(NetManager.java:44)
这里很明显可以看到是getFeeds在调用getParams函数的28行时发生了空指针。
在不保留行号的情况下，堆栈是这样的：
java.lang.NullPointerException: Attempt to invoke interface method 'java.lang.Object java.util.Map.get(java.lang.Object)' on a null object reference
at com.wx.demo.NetManager.b(Unknown Source)
at com.wx.demo.NetManager.a(Unknown Source)
这种情况下，由于只有函数名，而函数名b和a都对应了源码的两个函数，就没法知道是getFeeds调用getParams时发生了空指针，还是getComments调用getCommentsParams时发生了空指针了，只能根据更上层的调用堆栈看哪个才是正确的路径。这种情况下使用retrace.sh解析出来的堆栈会把每一步可能的堆栈都给列出来，类似这样：
java.lang.NullPointerException: Attempt to invoke interface method 'java.lang.Object java.util.Map.get(java.lang.Object)' on a null object reference
at java.util.Map getParams(Unknown Source)
java.util.Map getCommentsParams(java.lang.String)
at java.util.List getFeeds(java.lang.String)(Unknown Source)
java.util.List getComments(java.lang.String)
总结
本文由一个堆栈还原问题，把mapping.txt及其还原做了个介绍，希望对今后通过堆栈定位问题有帮助。
reference:
https://developer.android.com/studio/build/shrink-code.html#decoding
https://www.guardsquare.com/en/proguard/manual/retrace
