Android程序Crash時的異常上報

 

前言

大傢都知道,android應用不可避免的會發生crash,無論你的程序寫的多完美,總是無法完全避免crash的發生,可能是由於android系統底層的bug,也可能是由於不充分的機型適配或者是糟糕的網絡狀況。當crash發生時,系統會kill掉你的程序,表現就是閃退或者程序已停止運行,這對用戶來說是很不友好的,也是開發者所不願意看到的,更糟糕的是,當用戶發生瞭crash,開發者卻無法得知程序為何crash,即便你想去解決這個crash,但是由於你無法知道用戶當時的crash信息,所以你也無能為力。是否真的這樣呢,其實android中有處理這類問題的方法,請看下面Thread類中的一個方法#setDefaultUncaughtExceptionHandler

 

    /**
     * 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,代碼如下,代碼我就不做解釋瞭,註釋相當清晰瞭

 

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的情形,看我們的程序是如何處理的。

 

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行就是我們認為拋出的異常。從現在開始,為你的應用加上默認異常事件處理器吧。
data-cke-saved-src=https://www.aiwalls.com/uploadfile/Collfiles/20131213/2013121309150276.jpgdata-cke-saved-src=https://www.aiwalls.com/uploadfile/Collfiles/20131213/2013121309150377.jpg

 

demo下載:https://download.csdn.net/download/singwhatiwanna/6706023

發佈留言