09. Android未捕获Crash信息收集

前言

本篇属于《Android开发艺术探索》第13章使用CrashHandler获取crash信息的学习笔记，如有错误，请指教，不甚感激。

没有一个App是完美的，都是在不断的完善修改bug中变的更好。特别是一些上线的app出现一些crash情况后，我们并不能及时的看到，所以为了了解用户在使用过程中出现了哪些crash信息，我们需要掌握crash信息收集技能。

基本思想
Google考虑到此情况，在Thread类中提供了一个接口，UncaughtExecptionHandler来提供我们使用，当应用发生了未捕获的异常时，系统会自动调用这个接口的uncaughtException方法。我们在这个方法中可以保存异常信息到SD卡，然后在特定的时间将保存的文件上传到web服务器，开发人员可以从服务器拉取文件，分析并修改相关的crash。

Demo代码
自定义CrashHandler类并实现Thread.UncaughtExceptionHandler接口

public class CrashHandler implements Thread.UncaughtExceptionHandler {

    private static final String TAG = "CrashHandler";
    private static final boolean DEBUG = true;

    private static final String PATH = Environment.getExternalStorageDirectory().getPath() + "/CrashTest/log/";
    private static final String FILE_NAME = "crash";
    private static final String FILE_NAME_SUFFIX = ".trace";

    private static CrashHandler sCrashHandler = new CrashHandler();
    private Thread.UncaughtExceptionHandler mDefaultCrashHandler;
    private Context mContext;


    private CrashHandler(){}

    // 单例模式
    public static CrashHandler getInstance(){
        return sCrashHandler;
    }

    public void init(Context context){
        mDefaultCrashHandler = Thread.getDefaultUncaughtExceptionHandler();
        Thread.setDefaultUncaughtExceptionHandler(this);   //这两句代码不是很明白，有清楚的希望指教下
        mContext = context.getApplicationContext();
    }

    /**
     * 这是最关键的函数，当程序中有未捕获的异常，系统将会自动调用此方法
     * @param thread  为出现未捕获异常的线程
     * @param exception 未捕获的异常，有了此异常，我们就能得到异常信息
     */
    @Override
    public void uncaughtException(Thread thread, Throwable exception) {
        try {
            //保存异常信息到sd卡
            saveExceptionToSDCard(exception);
            //上传异常信息到服务器
            uploadExceptionToServer(exception);
        } catch (IOException e) {
            e.printStackTrace();
        }

        // 如果系统提供了默认的异常处理器，就交给系统自己处理，否则就自己结束掉自己
        if (mDefaultCrashHandler!=null){
            mDefaultCrashHandler.uncaughtException(thread,exception);
        }else {
            Process.killProcess(Process.myPid());
        }
    }


    // 将异常信息保存到SDCard
    private void saveExceptionToSDCard(Throwable ex) throws IOException {
        // 如果SD卡不存在或无法使用，则无法写入异常信息，给与提示
        if(!Environment.getExternalStorageState().equals(Environment.MEDIA_MOUNTED)){
            if (DEBUG){
                Log.w(TAG,"sdcard unmounted , skip save exception"); //sd卡未安装好，跳出存储异常
            }
            return;
        }
        // 文件存储路径
        File dir = new File(PATH);
        if (!dir.exists()){
            dir.mkdirs();   // 这里开始自己犯了一个低级错误，写成了dir.mkdir()，需要注意；
        }
        // 获取当前时间
        long current = System.currentTimeMillis();
        String time = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date(current));
        // 创建存储异常信息的文件
        File file = new File(PATH+FILE_NAME+time+FILE_NAME_SUFFIX);
        if (!file.exists()){
            file.createNewFile();
        }

        try {
            PrintWriter pw = new PrintWriter(new BufferedWriter(new FileWriter(file)));
            pw.println(time);
            savePhoneInfo(pw);
            pw.println();
            ex.printStackTrace(pw);   //输出异常信息
            pw.close();
        }catch (PackageManager.NameNotFoundException e){
            Log.e(TAG,"save crash info failed");
        }

    }

    // 保存手机的信息
    private void savePhoneInfo(PrintWriter pw) throws PackageManager.NameNotFoundException {
        PackageManager pm = mContext.getPackageManager();
        PackageInfo pi = pm.getPackageInfo(mContext.getPackageName(),PackageManager.GET_ACTIVITIES);

        // APP的版本信息
        pw.print("APP Version:");
        pw.print(pi.versionName);
        pw.print('_');
        pw.println(pi.versionCode);

        // Android 手机版本号
        pw.print("OS Version:");
        pw.print(Build.VERSION.RELEASE);
        pw.print('_');
        pw.println(Build.VERSION.SDK_INT);

        // 手机制造商
        pw.print("Vendor:");
        pw.println(Build.MANUFACTURER);

        // 手机型号
        pw.print("Model:");
        pw.println(Build.MODEL);

        // CPU架构
        pw.print("CUP ABI:");
        pw.println(Build.CPU_ABI);
    }

    // 将异常信息上传到服务器
    private void uploadExceptionToServer(Throwable ex){
        //Error error = new Error(ex.getMessage());
        // 上传服务器的操作还不清楚，希望有会的指教下      
    }
}

项目中怎样使用自己的CrashHandler类呢?只需要在应用application初始化的时候为线程设置CrashHandler即可：

public class MyApplication extends Application {
    private static MyApplication sMyApplication;
    @Override
    public void onCreate() {
        super.onCreate();
        // 在这里为应用设置异常处理，然后程序才能获取未处理的异常
        CrashHandler crashHandler = CrashHandler.getInstance();
        crashHandler.init(this);
    }
    public static MyApplication getInstance(){
        return sMyApplication;
    }
}

最后我们模拟一个异常，看下结果：

public class MainActivity extends AppCompatActivity {
    private Button mButton;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        mButton = (Button)findViewById(R.id.button);
        mButton.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                throw new RuntimeException("自己抛出一个异常……");
            }
        });
    }
}

程序运行后，我们点击button后，程序就因为异常退出。这是我们可以在手机上下载一个ES文件浏览器，搜索我们的文件夹名CrashTest——>log:

Paste_Image.png Paste_Image.png

结束……