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行就是我們認為丟擲的異常。從現在開始,為你的應用加上預設異常事件處理器吧。