Android程序Crash時的異常上報

時間 2019-11-17

原文原文鏈接

轉載請註明來源：http://blog.csdn.net/singwhatiwanna/article/details/17289479

前言

你們都知道，android應用不可避免的會發生crash，不管你的程序寫的多完美，老是沒法徹底避免crash的發生，多是因爲android系統底層的bug，也多是因爲不充分的機型適配或者是糟糕的網絡情況。當crash發生時，系統會kill掉你的程序，表現就是閃退或者程序已中止運行，這對用戶來講是很不友好的，也是開發者所不肯意看到的，更糟糕的是，當用戶發生了crash，開發者卻沒法得知程序爲什麼crash，即使你想去解決這個crash，可是因爲你沒法知道用戶當時的crash信息，因此你也無能爲力。是否真的這樣呢，其實android中有處理這類問題的方法，請看下面Thread類中的一個方法#setDefaultUncaughtExceptionHandlerjava

/**
     * Sets the default uncaught exception handler. This handler is invoked in
     * case any Thread dies due to an unhandled exception.
     *
     * @param handler
     *            The handler to set or null.
     */
    public static void setDefaultUncaughtExceptionHandler(UncaughtExceptionHandler handler) {
        Thread.defaultUncaughtHandler = handler;
    }

從方法的字面意義來看，這個方法好像是能夠設置系統的默認異常處理器，其實，這個方法就能夠解決應用常見的crash問題。當crash發生的時候，咱們能夠捕獲到異常信息，把異常信息存儲到SD卡中，而後在合適的時機經過網絡將crash信息上傳到服務器上，這樣開發人員就能夠分析用戶crash的場景從而在後面的版本中修復此類crash。咱們還能夠在crash發生時，彈出一個通知告訴用戶程序crash了，而後再退出，這樣作比閃退要溫和一點。

步驟

1. 創建異常處理Handler

新建一個類，好比叫CrashHandler.java，代碼以下，代碼我就不作解釋了，註釋至關清晰了android

public class CrashHandler implements UncaughtExceptionHandler {
    private static final String TAG = "CrashHandler";
    private static final boolean DEBUG = true;

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

    //log文件的後綴名
    private static final String FILE_NAME_SUFFIX = ".trace";

    private static CrashHandler sInstance = new CrashHandler();

    //系統默認的異常處理（默認狀況下，系統會終止當前的異常程序）
    private UncaughtExceptionHandler mDefaultCrashHandler;

    private Context mContext;

    //構造方法私有，防止外部構造多個實例，即採用單例模式
    private CrashHandler() {
    }

    public static CrashHandler getInstance() {
        return sInstance;
    }

    //這裏主要完成初始化工做
    public void init(Context context) {
        //獲取系統默認的異常處理器
        mDefaultCrashHandler = Thread.getDefaultUncaughtExceptionHandler();
        //將當前實例設爲系統默認的異常處理器
        Thread.setDefaultUncaughtExceptionHandler(this);
        //獲取Context，方便內部使用
        mContext = context.getApplicationContext();
    }

    /**
     * 這個是最關鍵的函數，當程序中有未被捕獲的異常，系統將會自動調用#uncaughtException方法
     * thread爲出現未捕獲異常的線程，ex爲未捕獲的異常，有了這個ex，咱們就能夠獲得異常信息。
     */
    @Override
    public void uncaughtException(Thread thread, Throwable ex) {
        try {
            //導出異常信息到SD卡中
            dumpExceptionToSDCard(ex);
            //這裏能夠經過網絡上傳異常信息到服務器，便於開發人員分析日誌從而解決bug
            uploadExceptionToServer();
        } 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));
        //以當前時間建立log文件
        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");
        }
    }

    private void dumpPhoneInfo(PrintWriter pw) throws 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
    }

}

2.爲ui線程添加默認異常事件Handler

//Thread類中標識默認異常事件Handler的成員服務器

private static UncaughtExceptionHandler defaultUncaughtHandler;
網絡

這裏涉及到在哪裏添加的問題，從源碼中注意到，這個defaultUncaughtHandler是Thread類中一個靜態的成員，因此，按道理，咱們爲任意一個線程設置異常處理，全部的線程都應該能共用這個異常處理器，這個是個人猜想，沒有通過驗證，不過不要緊，有一個觀點是你們都承認的：就是爲主線程也就是ui線程添加異常程序器。爲了在ui線程中添加異常處理Handler，咱們推薦你們在Application中添加而不是在Activity中添加。Application標識着整個應用，在Android聲明週期中是第一個啓動的，早於任何的Activity、Service等。架構

public class TestApp extends Application {

    private static TestApp sInstance;

    @Override
    public void onCreate() {
        super.onCreate();
        sInstance = this;

        //在這裏爲應用設置異常處理程序，而後咱們的程序才能捕獲未處理的異常
        CrashHandler crashHandler = CrashHandler.getInstance();
        crashHandler.init(this);
    }

    public static TestApp getInstance() {
        return sInstance;
    }

}

效果

通過了上面兩個步驟，咱們的程序已經能夠處理任何異常了，不再怕程序crash了，而且咱們還能從服務器上查看用戶的crash信息，下面咱們就模擬下發生crash的情形，看咱們的程序是如何處理的。ide

public class CrashActivity extends Activity implements OnClickListener{

    private Button mButton;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_crash);
        initView();
    }

    private void initView() {
        mButton = (Button)findViewById(R.id.button1);
        mButton.setOnClickListener(this);
    }

    @Override
    public void onClick(View v) {
        if (v == mButton) {
            //在這裏默認異常拋出狀況，人爲拋出一個運行時異常
            throw new RuntimeException("自定義異常：這是本身拋出的異常");
        }
        
    }
}

咱們給按鈕加一個點擊事件，在onClick中人爲拋出一個運行時異常，這個時候程序就crash了，看看異常處理器爲咱們作了什麼。從下面的圖片能夠看出，異常處理器爲咱們建立了一個日誌文件，打開日誌文件，能夠看到手機的信息以及異常發生時的調用棧，有了這些，開發人員就很好定位問題了吧。從下面的日誌調用棧能夠看出，CrashActivity的28行發生了RuntimeException，再看下咱們的代碼，發現28行就是咱們認爲拋出的異常。從如今開始，爲你的應用加上默認異常事件處理器吧。