崩潰異常的捕獲處理

大家都知道，現在安裝Android系統的手機版本和裝置千差萬别，在模拟器上運作良好的程式安裝到某款手機上說不定就出現崩潰的現象，開發者個人不可能購買所有裝置逐個調試，是以在程式釋出出去之後，如果出現了崩潰現象，開發者應該及時擷取在該裝置上導緻崩潰的資訊，這對于下一個版本的bug修複幫助極大，是以今天就來介紹一下如何在程式崩潰的情況下收集相關的裝置參數資訊和具體的異常資訊，并發送這些資訊到伺服器供開發者分析和調試程式。

我們先建立一個crash項目，項目結構如圖：

崩潰異常的捕獲處理

在MainActivity.java代碼中，代碼是這樣寫的：

package com.scott.crash;  

import android.app.Activity;  
import android.os.Bundle;  

public class MainActivity extends Activity {  

    private String s;  

    @Override  
    public void onCreate(Bundle savedInstanceState) {  
        super.onCreate(savedInstanceState);  
        System.out.println(s.equals("any string"));  
    }  
}

我們在這裡故意制造了一個潛在的運作期異常，當我們運作程式時就會出現以下界面：

崩潰異常的捕獲處理

遇到軟體沒有捕獲的異常之後，系統會彈出這個預設的強制關閉對話框。

我們當然不希望使用者看到這種現象，簡直是對使用者心靈上的打擊，而且對我們的bug的修複也是毫無幫助的。我們需要的是軟體有一個全局的異常捕獲器，當出現一個我們沒有發現的異常時，捕獲這個異常，并且将異常資訊記錄下來，上傳到伺服器公開發這分析出現異常的具體原因。

接下來我們就來實作這一機制，不過首先我們還是來了解以下兩個類：android.app.Application和java.lang.Thread.UncaughtExceptionHandler。

Application：用來管理應用程式的全局狀态。在應用程式啟動時Application會首先建立，然後才會根據情況(Intent)來啟動相應的Activity和Service。本示例中将在自定義加強版的Application中注冊未捕獲異常處理器。

Thread.UncaughtExceptionHandler：線程未捕獲異常處理器，用來處理未捕獲異常。如果程式出現了未捕獲異常，預設會彈出系統中強制關閉對話框。我們需要實作此接口，并注冊為程式中預設未捕獲異常處理。這樣當未捕獲異常發生時，就可以做一些個性化的異常處理操作。

大家剛才在項目的結構圖中看到的CrashHandler.java實作了Thread.UncaughtExceptionHandler，使我們用來處理未捕獲異常的主要成員，代碼如下：

package com.scott.crash;  

import java.io.File;  
import java.io.FileOutputStream;  
import java.io.PrintWriter;  
import java.io.StringWriter;  
import java.io.Writer;  
import java.lang.Thread.UncaughtExceptionHandler;  
import java.lang.reflect.Field;  
import java.text.DateFormat;  
import java.text.SimpleDateFormat;  
import java.util.Date;  
import java.util.HashMap;  
import java.util.Map;  

import android.content.Context;  
import android.content.pm.PackageInfo;  
import android.content.pm.PackageManager;  
import android.content.pm.PackageManager.NameNotFoundException;  
import android.os.Build;  
import android.os.Environment;  
import android.os.Looper;  
import android.util.Log;  
import android.widget.Toast;  

/** 
 * UncaughtException處理類,當程式發生Uncaught異常的時候,有該類來接管程式,并記錄發送錯誤報告. 
 *  
 * @author user 
 *  
 */  
public class CrashHandler implements UncaughtExceptionHandler {  

    public static final String TAG = "CrashHandler";  

    //系統預設的UncaughtException處理類   
    private Thread.UncaughtExceptionHandler mDefaultHandler;  
    //CrashHandler執行個體  
    private static CrashHandler INSTANCE = new CrashHandler();  
    //程式的Context對象  
    private Context mContext;  
    //用來儲存設備資訊和異常資訊  
    private Map<String, String> infos = new HashMap<String, String>();  

    //用于格式化日期,作為日志檔案名的一部分  
    private DateFormat formatter = new SimpleDateFormat("yyyy-MM-dd-HH-mm-ss");  

    /** 保證隻有一個CrashHandler執行個體 */  
    private CrashHandler() {  
    }  

    /** 擷取CrashHandler執行個體 ,單例模式 */  
    public static CrashHandler getInstance() {  
        return INSTANCE;  
    }  

    /** 
     * 初始化 
     *  
     * @param context 
     */  
    public void init(Context context) {  
        mContext = context;  
        //擷取系統預設的UncaughtException處理器  
        mDefaultHandler = Thread.getDefaultUncaughtExceptionHandler();  
        //設定該CrashHandler為程式的預設處理器  
        Thread.setDefaultUncaughtExceptionHandler(this);  
    }  

    /** 
     * 當UncaughtException發生時會轉入該函數來處理 
     */  
    @Override  
    public void uncaughtException(Thread thread, Throwable ex) {  
        if (!handleException(ex) && mDefaultHandler != null) {  
            //如果使用者沒有處理則讓系統預設的異常處理器來處理  
            mDefaultHandler.uncaughtException(thread, ex);  
        } else {  
            try {  
                Thread.sleep(3000);  
            } catch (InterruptedException e) {  
                Log.e(TAG, "error : ", e);  
            }  
            //退出程式  
            android.os.Process.killProcess(android.os.Process.myPid());  
            System.exit(1);  
        }  
    }  

    /** 
     * 自定義錯誤處理,收集錯誤資訊 發送錯誤報告等操作均在此完成. 
     *  
     * @param ex 
     * @return true:如果處理了該異常資訊;否則傳回false. 
     */  
    private boolean handleException(Throwable ex) {  
        if (ex == null) {  
            return false;  
        }  
        //使用Toast來顯示異常資訊  
        new Thread() {  
            @Override  
            public void run() {  
                Looper.prepare();  
                Toast.makeText(mContext, "很抱歉,程式出現異常,即将退出.", Toast.LENGTH_LONG).show();  
                Looper.loop();  
            }  
        }.start();  
        //收集裝置參數資訊   
        collectDeviceInfo(mContext);  
        //儲存日志檔案   
        saveCrashInfo2File(ex);  
        return true;  
    }  

    /** 
     * 收集裝置參數資訊 
     * @param ctx 
     */  
    public void collectDeviceInfo(Context ctx) {  
        try {  
            PackageManager pm = ctx.getPackageManager();  
            PackageInfo pi = pm.getPackageInfo(ctx.getPackageName(), PackageManager.GET_ACTIVITIES);  
            if (pi != null) {  
                String versionName = pi.versionName == null ? "null" : pi.versionName;  
                String versionCode = pi.versionCode + "";  
                infos.put("versionName", versionName);  
                infos.put("versionCode", versionCode);  
            }  
        } catch (NameNotFoundException e) {  
            Log.e(TAG, "an error occured when collect package info", e);  
        }  
        Field[] fields = Build.class.getDeclaredFields();  
        for (Field field : fields) {  
            try {  
                field.setAccessible(true);  
                infos.put(field.getName(), field.get(null).toString());  
                Log.d(TAG, field.getName() + " : " + field.get(null));  
            } catch (Exception e) {  
                Log.e(TAG, "an error occured when collect crash info", e);  
            }  
        }  
    }  

    /** 
     * 儲存錯誤資訊到檔案中 
     *  
     * @param ex 
     * @return  傳回檔案名稱,便于将檔案傳送到伺服器 
     */  
    private String saveCrashInfo2File(Throwable ex) {  

        StringBuffer sb = new StringBuffer();  
        for (Map.Entry<String, String> entry : infos.entrySet()) {  
            String key = entry.getKey();  
            String value = entry.getValue();  
            sb.append(key + "=" + value + "n");  
        }  

        Writer writer = new StringWriter();  
        PrintWriter printWriter = new PrintWriter(writer);  
        ex.printStackTrace(printWriter);  
        Throwable cause = ex.getCause();  
        while (cause != null) {  
            cause.printStackTrace(printWriter);  
            cause = cause.getCause();  
        }  
        printWriter.close();  
        String result = writer.toString();  
        sb.append(result);  
        try {  
            long timestamp = System.currentTimeMillis();  
            String time = formatter.format(new Date());  
            String fileName = "crash-" + time + "-" + timestamp + ".log";  
            if (Environment.getExternalStorageState().equals(Environment.MEDIA_MOUNTED)) {  
                String path = "/sdcard/crash/";  
                File dir = new File(path);  
                if (!dir.exists()) {  
                    dir.mkdirs();  
                }  
                FileOutputStream fos = new FileOutputStream(path + fileName);  
                fos.write(sb.toString().getBytes());  
                fos.close();  
            }  
            return fileName;  
        } catch (Exception e) {  
            Log.e(TAG, "an error occured while writing file...", e);  
        }  
        return null;  
    }  
}

在收集異常資訊時，朋友們也可以使用Properties，因為Properties有一個很便捷的方法properties.store(OutputStream out, String comments)，用來将Properties執行個體中的鍵值對外輸到輸出流中，但是在使用的過程中發現生成的檔案中異常資訊列印在同一行，看起來極為費勁，是以換成Map來存放這些資訊，然後生成檔案時稍加了些操作。

完成這個CrashHandler後，我們需要在一個Application環境中讓其運作，為此，我們繼承android.app.Application，添加自己的代碼，CrashApplication.java代碼如下：

package com.scott.crash;  

import android.app.Application;  

public class CrashApplication extends Application {  
    @Override  
    public void onCreate() {  
        super.onCreate();  
        CrashHandler crashHandler = CrashHandler.getInstance();  
        crashHandler.init(getApplicationContext());  
    }  
}

最後，為了讓我們的CrashApplication取代android.app.Application的地位，在我們的代碼中生效，我們需要修改AndroidManifest.xml：

<application android:name=".CrashApplication" ...>  
</application>

因為我們上面的CrashHandler中，遇到異常後要儲存裝置參數和具體異常資訊到SDCARD，是以我們需要在AndroidManifest.xml中加入讀寫SDCARD權限：

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>

搞定了上邊的步驟之後，我們來運作一下這個項目：

崩潰異常的捕獲處理

看以看到，并不會有強制關閉的對話框出現了，取而代之的是我們比較有好的提示資訊。

然後看一下SDCARD生成的檔案：

崩潰異常的捕獲處理

用文本編輯器打開日志檔案，看一段日志資訊：

CPU_ABI=armeabi  
CPU_ABI2=unknown  
ID=FRF91  
MANUFACTURER=unknown  
BRAND=generic  
TYPE=eng  
......  
Caused by: java.lang.NullPointerException  
    at com.scott.crash.MainActivity.onCreate(MainActivity.java:13)  
    at android.app.Instrumentation.callActivityOnCreate(Instrumentation.java:1047)  
    at android.app.ActivityThread.performLaunchActivity(ActivityThread.java:2627)  
    ... 11 more

這些資訊對于開發者來說幫助極大，是以我們需要将此日志檔案上傳到伺服器，有關檔案上傳的技術，請參照Android中使用HTTP服務相關介紹。

不過在使用HTTP服務之前，需要确定網絡暢通，我們可以使用下面的方式判斷網絡是否可用：

/** 
     * 網絡是否可用 
     *  
     * @param context 
     * @return 
     */  
    public static boolean isNetworkAvailable(Context context) {  
        ConnectivityManager mgr = (ConnectivityManager) context.getSystemService(Context.CONNECTIVITY_SERVICE);  
        NetworkInfo[] info = mgr.getAllNetworkInfo();  
        if (info != null) {  
            for (int i = 0; i < info.length; i++) {  
                if (info[i].getState() == NetworkInfo.State.CONNECTED) {  
                    return true;  
                }  
            }  
        }  
        return false;  
    }

崩潰異常的捕獲處理

繼續閱讀

專訪鄧凡平：深入了解Android

與專家面對面：Android開發入門問與答

Android MVP架構MVCMVP

mvp初探

Android常用工具類簡介目錄

android常用工具類轉載自：http://www.trinea.cn/android/android-common-utils/Android常用工具類

Android常用工具類ToastUtilsSizeUtilsLogUtilsRetrofitManagerAnimUtil

Android Studio 0.8.0解決 Failure [INSTALL_FAILED_OLDER_SDK] 問題

Android – ListView 中添加按鈕，動态删除添加ItemView的操作

Kotlin的ListView與RecyclerView的簡單應用

關于公司的那些坑：Android Studio篇

android SQLite事務和kotlin協程

無法正常編譯錯誤Compilation failed to complete

關于Gradle配置的小結

AOP程式設計_Android優雅權限架構(1)概念基礎，2021金三銀四前言正文大綱正文

Android APK檔案反編譯Android APK檔案反編譯