使用CrashHandler獲取crash信息

1、背景和問題

在項目開發時，程序crash是再常見不過的情況。crash發生時系統會殺掉正在執行的程序，顯示爲閃退或者是提示用戶程序已經停止運行。而且，用戶使用過程中發生的crash，我們開發者 是無法得知原因的，無法知道crash的原因，也就無法解決這個問題。

2、解決方法

在Android中提供了處理之類的方法，在Thread類中的一個方法setDefaultUncaughtExceptionHandler。
這個方法可以設置系統默認異常處理器。當系統發生crash時，系統會回調setDefaultUncaughtExceptionHandler的uncaughtException方法，在uncaughtException方法中就可以獲取到異常信息了，然後就可以選擇把信息存到sd卡，之後或者可以將信息上傳到服務器。這樣開發者就可以獲取到crash原因，並在下一個版本中修復。

3、代碼實現

package com.sy.crashhandlerdemo;

import android.content.Context;
import android.content.pm.PackageInfo;
import android.content.pm.PackageManager;
import android.os.Build;
import android.os.Process;
import android.os.Environment;
import android.util.Log;

import java.io.BufferedWriter;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.PrintWriter;
import java.text.SimpleDateFormat;
import java.util.Date;


/**
 * Created by SY on 2017/2/8.
 */

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 sInstance = new CrashHandler();
    private Thread.UncaughtExceptionHandler mDefaultCrashHandler;
    private Context mContext;

    private CrashHandler() {
    }

    public static CrashHandler getInstance() {
        return sInstance;
    }

    public void init(Context context) {
        mDefaultCrashHandler = Thread.getDefaultUncaughtExceptionHandler();
        Thread.setDefaultUncaughtExceptionHandler(this);
        mContext = context.getApplicationContext();
    }

    /**
     * 這個是最關鍵的函數，當程序中有未被捕獲的異常，系統將會自動調用#uncaughtException方法
     * thread爲出現未捕獲異常的線程，ex爲未捕獲的異常，有了這個ex，我們就可以得到異常信息。
     */
    @Override
    public void uncaughtException(Thread thread, Throwable ex) {
        try {
            //導出異常信息到SD卡中
            dumpExceptionToSDCard(ex);
            uploadExceptionToServer();
            //這裏可以通過網絡上傳異常信息到服務器，便於開發人員分析日誌從而解決bug
        } catch (IOException e) {
            e.printStackTrace();
        }

        ex.printStackTrace();

        //如果系統提供了默認的異常處理器，則交給系統去結束我們的程序，否則就由我們自己結束自己
        if (mDefaultCrashHandler != null) {
            mDefaultCrashHandler.uncaughtException(thread, ex);
        } else {
            Process.killProcess(Process.myPid());
        }

    }

    private void dumpExceptionToSDCard(Throwable ex) throws IOException {
        //如果SD卡不存在或無法使用，則無法把異常信息寫入SD卡
        if (!Environment.getExternalStorageState().equals(Environment.MEDIA_MOUNTED)) {
            if (DEBUG) {
                Log.w(TAG, "sdcard unmounted,skip dump exception");
                return;
            }
        }

        File dir = new File(PATH);
        if (!dir.exists()) {
            dir.mkdirs();
        }
        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);

        try {
            PrintWriter pw = new PrintWriter(new BufferedWriter(new FileWriter(file)));
            pw.println(time);
            dumpPhoneInfo(pw);
            pw.println();
            ex.printStackTrace(pw);
            pw.close();
        } catch (Exception e) {
            Log.e(TAG, "dump crash info failed"+e.getMessage());
        }
    }

    private void dumpPhoneInfo(PrintWriter pw) throws PackageManager.NameNotFoundException {
        PackageManager pm = mContext.getPackageManager();
        PackageInfo pi = pm.getPackageInfo(mContext.getPackageName(), PackageManager.GET_ACTIVITIES);
        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("CPU ABI: ");
        pw.println(Build.CPU_ABI);
    }

    private void uploadExceptionToServer() {
        //TODO Upload Exception Message To Your Web Server
    }
}

寫一個CrashHandler實現UncaughtExceptionHandler，然後在
uncaghtException這個方法裏獲取異常信息存儲到sd卡里或者上傳到服務器。
接着先寫一個init方法，調用系統的setDefaultUncaughtExceptionHandler方法設置默認異常處理器就可以了。

4、使用方法

想要在項目中使用，只要在application啓動時加入如下代碼：

CrashHandler crashHandler = CrashHandler.getInstance();
crashHandler.init(this);

5、測試Demo

這個demo很簡單了，就是幾個按鈕，每個按鈕一個異常，然後用自己實現的CrashHandler捕獲存儲異常信息。

findViewById(R.id.btn1).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                int i = 3 / 0;
            }
        });
        findViewById(R.id.btn2).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                int[] i = new int[2];
                i[3] = 1;
            }
        });
        findViewById(R.id.btn3).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                String str = null;
                String strRs = str.substring(0, 3);
            }
        });
        findViewById(R.id.btn4).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                String str = "sdcard";
                int i = Integer.parseInt(str);
            }
        });
        findViewById(R.id.btn5).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
            }
        });