大家都知道,現在安裝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;
-
-
-
-
-
-
-
-
public class CrashHandler implements UncaughtExceptionHandler {
-
-
public static final String TAG = "CrashHandler";
-
-
-
private Thread.UncaughtExceptionHandler mDefaultHandler;
-
-
private static CrashHandler INSTANCE = new CrashHandler();
-
-
private Context mContext;
-
-
private Map<String, String> infos = new HashMap<String, String>();
-
-
-
private DateFormat formatter = new SimpleDateFormat("yyyy-MM-dd-HH-mm-ss");
-
-
-
private CrashHandler() {
-
}
-
-
-
public static CrashHandler getInstance() {
-
return INSTANCE;
-
}
-
-
-
-
-
-
-
public void init(Context context) {
-
mContext = context;
-
-
mDefaultHandler = Thread.getDefaultUncaughtExceptionHandler();
-
-
Thread.setDefaultUncaughtExceptionHandler(this);
-
}
-
-
-
-
-
@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);
-
}
-
}
-
-
-
-
-
-
-
-
private boolean handleException(Throwable ex) {
-
if (ex == null) {
-
return false;
-
}
-
-
new Thread() {
-
@Override
-
public void run() {
-
Looper.prepare();
-
Toast.makeText(mContext, "很抱歉,程序出現異常,即將退出.", Toast.LENGTH_LONG).show();
-
Looper.loop();
-
}
-
}.start();
-
-
collectDeviceInfo(mContext);
-
-
saveCrashInfo2File(ex);
-
return true;
-
}
-
-
-
-
-
-
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);
-
}
-
}
-
}
-
-
-
-
-
-
-
-
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服務之前,需要確定網絡暢通,我們可以使用下面的方式判斷網絡是否可用:
-
-
-
-
-
-
-
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;
-
}