基於Android 錯誤資訊捕獲發送至伺服器的詳解

程式員最頭疼的事情就是bug和debug。這次debug長達20天，搞的我心力交瘁。累，因為Android相容性，不同手機會有不同的bug出來，而且很難複現，所以就上網找了下類似儲存錯誤log到檔案再上傳到伺服器，現把源碼也共用出來。上傳至伺服器的代碼我沒加。相信大家都有現成的代碼了。

先講下原理，跟JavaEE的自訂異常捕獲一樣，將錯誤一直向上拋，然後在最上層統一處理。這裡就可以獲得Exception Message，進行儲存操作
異常捕獲類如下：
複製代碼 代碼如下:/**
* @author Stay
* 在Application中統一捕獲異常，儲存到檔案中下次再開啟時上傳
*/
public class CrashHandler implements UncaughtExceptionHandler {
/** 是否開啟日誌輸出,在Debug狀態下開啟,
* 在Release狀態下關閉以提示程式效能
* */
public static final boolean DEBUG = true;
/** 系統預設的UncaughtException處理類 */
private Thread.UncaughtExceptionHandler mDefaultHandler;
/** CrashHandler執行個體 */
private static CrashHandler INSTANCE;
/** 程式的Context對象 */
// private Context mContext;
/** 保證只有一個CrashHandler執行個體 */
private CrashHandler() {}
/** 擷取CrashHandler執行個體 ,單例模式*/
public static CrashHandler getInstance() {
if (INSTANCE == null) {
INSTANCE = new CrashHandler();
}
return INSTANCE;
}

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

/**
* 當UncaughtException發生時會轉入該函數來處理
*/
@Override
public void uncaughtException(Thread thread, Throwable ex) {
if (!handleException(ex) && mDefaultHandler != null) {
//如果使用者沒有處理則讓系統預設的異常處理器來處理
mDefaultHandler.uncaughtException(thread, ex);
} else { //如果自己處理了異常，則不會彈出錯誤對話方塊，則需要手動退出app
try {
Thread.sleep(3000);
} catch (InterruptedException e) {
}
android.os.Process.killProcess(android.os.Process.myPid());
System.exit(10);
}
}

/**
* 自訂錯誤處理,收集錯誤資訊
* 發送錯誤報表等操作均在此完成.
* 開發人員可以根據自己的情況來自訂異常處理邏輯
* @return
* true代表處理該異常，不再向上拋異常，
* false代表不處理該異常(可以將該log資訊儲存起來)然後交給上層(這裡就到了系統的異常處理)去處理，
* 簡單來說就是true不會彈出那個錯誤提示框，false就會彈出
*/
private boolean handleException(final Throwable ex) {
if (ex == null) {
return false;
}
// final String msg = ex.getLocalizedMessage();
final StackTraceElement[] stack = ex.getStackTrace();
final String message = ex.getMessage();
//使用Toast來顯示異常資訊
new Thread() {
@Override
public void run() {
Looper.prepare();
// Toast.makeText(mContext, "程式出錯啦:" + message, Toast.LENGTH_LONG).show();
// 可以只建立一個檔案，以後全部往裡面append然後發送，這樣就會有重複的資訊，個人不推薦
String fileName = "crash-" + System.currentTimeMillis() + ".log";
File file = new File(Environment.getExternalStorageDirectory(), fileName);
try {
FileOutputStream fos = new FileOutputStream(file,true);
fos.write(message.getBytes());
for (int i = 0; i < stack.length; i++) {
fos.write(stack[i].toString().getBytes());
}
fos.flush();
fos.close();
} catch (Exception e) {
}
Looper.loop();
}

}.start();
return false;
}

// TODO 使用HTTP Post 發送錯誤報表到伺服器 這裡不再贅述
// private void postReport(File file) {
// 在上傳的時候還可以將該app的version，該手機的機型等資訊一併發送的伺服器，
// Android的相容性眾所周知，所以可能錯誤不是每個手機都會報錯，還是有針對性的去debug比較好
// }
}

在Application onCreate時就註冊ExceptionHandler，此後只要程式在拋異常後就能捕獲到。複製代碼 代碼如下:public class App extends Application{
@Override
public void onCreate() {
super.onCreate();
CrashHandler crashHandler = CrashHandler.getInstance();
//註冊crashHandler
crashHandler.init(getApplicationContext());
}
}
?public class LogActivity extends Activity {
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.main);
try {//製造bug
File file = new File(Environment.getExternalStorageState() ,"crash.bin");
FileInputStream fis = new FileInputStream(file);
byte[] buffer = new byte[1024];
fis.read(buffer);
} catch (Exception e) {
//這裡不能再向上拋異常，如果想要將log資訊儲存起來，則拋出runtime異常，
// 讓自訂的handler來捕獲，統一將檔案儲存起來上傳
throw new RuntimeException(e);
}
}
}

注意，如果catch後不throw就預設是自己處理了，ExceptionHandler不會捕獲異常了。
再分享一個Log的封裝類，只要在這裡設定DEBUG的值就能讓控制台是否列印出log
複製代碼 代碼如下:public class DebugUtil {
public static final String TAG = "ICON";
public static final boolean DEBUG = true;

public static void toast(Context context,String content){
Toast.makeText(context, content, Toast.LENGTH_SHORT).show();
}

public static void debug(String tag,String msg){
if (DEBUG) {
Log.d(tag, msg);
}
}

public static void debug(String msg){
if (DEBUG) {
Log.d(TAG, msg);
}
}

public static void error(String tag,String error){
Log.e(tag, error);
}

public static void error(String error){
Log.e(TAG, error);
}
}