[開源中國]android客戶端-異常捕獲

時間 2019-11-19

原文原文鏈接

開源中國的異常捕獲的處理類在AppException.java中，產生的堆棧信息不是太詳細，尤爲是沒有究竟是在哪行出錯的。這樣對於查看修改bug仍是增長了工做量，這裏對異常的堆棧信息修改了一下，通過實際測試，可以正確的顯示是哪一個類，哪行出的問題。 java

關鍵的代碼是: android

public static StringBuffer getTraceInfo(Activity a, Throwable e) {
    StringBuffer sb = new StringBuffer();
    StackTraceElement[] stacks = e.getCause().getStackTrace();
    for (int i = 0; i < stacks.length; i++) {
      if (stacks[i].getClassName().contains(a.getLocalClassName())) {
        sb.append("class: ").append(stacks[i].getClassName()).append("; method: ")
            .append(stacks[i].getMethodName()).append("; line: ").append(stacks[i].getLineNumber())
            .append("; Exception: ").append(e.getCause().toString());
        break;
      }
    }
    return sb;
} apache

完整的類內容以下： json

package com.childapp.exception; app

import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.PrintWriter;
import java.lang.Thread.UncaughtExceptionHandler;
import java.lang.reflect.Field;
import java.net.ConnectException;
import java.net.SocketException;
import java.net.UnknownHostException;
import java.util.Date; socket

import org.apache.commons.httpclient.HttpException;
import org.json.JSONException;
import org.json.JSONObject; ide

import android.app.Activity;
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.text.format.DateFormat;
import android.util.Log;
import android.widget.Toast; oop

import com.childapp.R;
import com.childapp.common.AppApplication;
import com.childapp.common.AppManager;
import com.childapp.common.GlobalConstants;
import com.childapp.utils.UIHelper; 測試

/**
* 應用程序異常類：用於捕獲異常和提示錯誤信息
*
* @author liux (http://my.oschina.net/liux)
* @version 1.0
* @created 2012-3-21
*/
public class AppException extends Exception implements UncaughtExceptionHandler { 優化

/**
*
*/
private static final long serialVersionUID = 6243307165131877535L;

private final static boolean Debug = false;// 是否保存錯誤日誌

/** 定義異常類型 */
public final static byte TYPE_NETWORK = 0x01;
public final static byte TYPE_SOCKET = 0x02;
public final static byte TYPE_HTTP_CODE = 0x03;
public final static byte TYPE_HTTP_ERROR = 0x04;
public final static byte TYPE_XML = 0x05;
public final static byte TYPE_IO = 0x06;
public final static byte TYPE_RUN = 0x07;

private byte type;
private int code;

/** 系統默認的UncaughtException處理類 */
private Thread.UncaughtExceptionHandler mDefaultHandler;

private AppException() {
this.mDefaultHandler = Thread.getDefaultUncaughtExceptionHandler();
}

private AppException(byte type, int code, Exception excp) {
    super(excp);
    this.type = type;
    this.code = code;
    if (Debug) {
      this.saveErrorLog(excp);
    }
}

public int getCode() {
return this.code;
}

public int getType() {
return this.type;
}

/**
   * 提示友好的錯誤信息
   *
   * @param ctx
   */
public void makeToast(Context ctx) {
    switch (this.getType()) {
      case TYPE_HTTP_CODE:
        String err = ctx.getString(R.string.http_status_code_error, this.getCode());
        Toast.makeText(ctx, err, Toast.LENGTH_SHORT).show();
        break;
      case TYPE_HTTP_ERROR:
        Toast.makeText(ctx, R.string.http_exception_error, Toast.LENGTH_SHORT).show();
        break;
      case TYPE_SOCKET:
        Toast.makeText(ctx, R.string.socket_exception_error, Toast.LENGTH_SHORT).show();
        break;
      case TYPE_NETWORK:
        Toast.makeText(ctx, R.string.network_not_connected, Toast.LENGTH_SHORT).show();
        break;
      case TYPE_XML:
        Toast.makeText(ctx, R.string.xml_parser_failed, Toast.LENGTH_SHORT).show();
        break;
      case TYPE_IO:
        Toast.makeText(ctx, R.string.io_exception_error, Toast.LENGTH_SHORT).show();
        break;
      case TYPE_RUN:
        Toast.makeText(ctx, R.string.app_run_code_error, Toast.LENGTH_SHORT).show();
        break;
    }
}

/**
   * 保存異常日誌
   *
   * @param excp
   */
public void saveErrorLog(Exception excp) {
    saveErrorLog(excp.getLocalizedMessage());
}

/**
   * 保存異常日誌
   *
   * @param excp
   */
public void saveErrorLog(String excpMessage) {
    String errorlog = "errorlog.txt";
    String savePath = "";
    String logFilePath = "";
    FileWriter fw = null;
    PrintWriter pw = null;
    try {
      // 判斷是否掛載了SD卡
      String storageState = Environment.getExternalStorageState();
      if (storageState.equals(Environment.MEDIA_MOUNTED)) {
        savePath =
            Environment.getExternalStorageDirectory().getAbsolutePath() + File.separator
                + GlobalConstants.FOLDER_ROOT + File.separator + "Log/";
        File file = new File(savePath);
        if (!file.exists()) {
          file.mkdirs();
        }
        logFilePath = savePath + errorlog;
      }
      // 沒有掛載SD卡，沒法寫文件
      if (logFilePath == "") {
        return;
      }
      File logFile = new File(logFilePath);
      if (!logFile.exists()) {
        logFile.createNewFile();
      }
      fw = new FileWriter(logFile, true);
      pw = new PrintWriter(fw);
      pw.println("--------------------" + (DateFormat.format("yyyy-MM-dd hh:mm:ss", new Date()))
          + "---------------------");
      pw.println(excpMessage);
      pw.close();
      fw.close();
    } catch (Exception e) {
      Log.e("AppException", "[Exception]" + e.getLocalizedMessage());
    } finally {
      if (pw != null) {
        pw.close();
      }
      if (fw != null) {
        try {
          fw.close();
        } catch (IOException e) {}
      }
    }

}

public static AppException http(int code) {
return new AppException(TYPE_HTTP_CODE, code, null);
}

public static AppException http(Exception e) {
return new AppException(TYPE_HTTP_ERROR, 0, e);
}

public static AppException socket(Exception e) {
return new AppException(TYPE_SOCKET, 0, e);
}

public static AppException io(Exception e) {
    if (e instanceof UnknownHostException || e instanceof ConnectException) {
      return new AppException(TYPE_NETWORK, 0, e);
    } else if (e instanceof IOException) {
      return new AppException(TYPE_IO, 0, e);
    }
    return run(e);
}

public static AppException xml(Exception e) {
return new AppException(TYPE_XML, 0, e);
}

public static AppException network(Exception e) {
    if (e instanceof UnknownHostException || e instanceof ConnectException) {
      return new AppException(TYPE_NETWORK, 0, e);
    } else if (e instanceof HttpException) {
      return http(e);
    } else if (e instanceof SocketException) {
      return socket(e);
    }
    return http(e);
}

public static AppException run(Exception e) {
return new AppException(TYPE_RUN, 0, e);
}

/**
   * 獲取APP異常崩潰處理對象
   *
   * @param context
   * @return
   */
public static AppException getAppExceptionHandler() {
    return new AppException();
}

@Override
public void uncaughtException(Thread thread, Throwable ex) {

    if (!handleException(ex) && mDefaultHandler != null) {
      mDefaultHandler.uncaughtException(thread, ex);
    } else {
      try {
        Thread.sleep(15000);
      } catch (InterruptedException e) {
        Log.e("AppException", "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;
    }

final Context context = AppManager.getAppManager().currentActivity();

    if (context == null) {
      return false;
    }

    final String crashReport = getCrashReport(context, ex);
    // 顯示異常信息&發送報告
    new Thread() {
      public void run() {
        Looper.prepare();
        UIHelper.sendAppCrashReport(context, crashReport);
        Looper.loop();
      }

}.start();

saveErrorLog(crashReport);

return true;
}

/**
   * 獲取APP崩潰異常報告
   *
   * @param ex
   * @return
   */
private String getCrashReport(Context context, Throwable ex) {
    PackageInfo pinfo = ((AppApplication) context.getApplicationContext()).getPackageInfo();
    StringBuffer exceptionStr = new StringBuffer();
    exceptionStr.append("Version: " + pinfo.versionName + "(" + pinfo.versionCode + ")\n");
    exceptionStr.append("Android: " + android.os.Build.VERSION.RELEASE + "("
        + android.os.Build.MODEL + ")\n");
    exceptionStr.append("System package Info:" + collectDeviceInfo(context) + "\n");
    exceptionStr.append("System os Info:" + getMobileInfo() + "\n");
    exceptionStr.append("Exception: " + ex.getMessage() + "\n");
    exceptionStr.append("Exception stack：" + getTraceInfo((Activity) context, ex) + "\n");
    StackTraceElement[] elements = ex.getStackTrace();
    for (int i = 0; i < elements.length; i++) {
      exceptionStr.append(elements[i].toString() + "\n");
    }
    return exceptionStr.toString();
}

/**
   * 收集設備參數信息
   *
   * @param ctx
   */
public String collectDeviceInfo(Context ctx) {
    StringBuilder sb = new StringBuilder();
    JSONObject activePackageJson = new JSONObject();

    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 + "";

        activePackageJson.put("versionName", versionName);
        activePackageJson.put("versionCode", versionCode);
      }
    } catch (NameNotFoundException e) {
      Log.e("AppException", "an error occured when collect package info", e);
    } catch (JSONException e) {
      Log.e("AppException", "jsonException", e);
    }
    sb.append("[active Package]");
    sb.append(activePackageJson.toString());

return sb.toString();
}

/**
   * 獲取手機的硬件信息
   *
   * @return
   */
public String getMobileInfo() {
    JSONObject osJson = new JSONObject();
    // 經過反射獲取系統的硬件信息

    Field[] fields = Build.class.getDeclaredFields();
    for (Field field : fields) {
      try {
        field.setAccessible(true);
        osJson.put(field.getName(), field.get(null).toString());
        Log.d("AppException", field.getName() + " : " + field.get(null));
      } catch (Exception e) {
        Log.e("AppException", "an error occured when collect crash info", e);
      }
    }

return osJson.toString();
}

}

時隔多日，發現上面的仍是有些問題，進行了再次的優化，堆棧信息打的更加好了。代碼以下：

import org.apache.commons.httpclient.HttpException;
import org.json.JSONException;
import org.json.JSONObject;

import com.childapp.R;
import com.childapp.common.AppApplication;
import com.childapp.common.AppManager;
import com.childapp.common.GlobalConstants;
import com.childapp.utils.UIHelper;

/**
*
*/
private static final long serialVersionUID = 6243307165131877535L;

private final static boolean Debug = true;// 是否保存錯誤日誌

private byte type;
private int code;

/** 系統默認的UncaughtException處理類 */
private Thread.UncaughtExceptionHandler mDefaultHandler;

private AppException() {
this.mDefaultHandler = Thread.getDefaultUncaughtExceptionHandler();
}

private AppException(byte type, int code, Exception excp) {
    super(excp);
    this.type = type;
    this.code = code;
    if (Debug) {
      this.saveErrorLog(excp);
    }
}

public int getCode() {
return this.code;
}

public int getType() {
return this.type;
}

/**
   * 保存異常日誌
   *
   * @param excp
   */
public void saveErrorLog(Exception excp) {
    saveErrorLog(excp.getLocalizedMessage());
}

}

public static AppException http(int code) {
return new AppException(TYPE_HTTP_CODE, code, null);
}

public static AppException http(Exception e) {
return new AppException(TYPE_HTTP_ERROR, 0, e);
}

public static AppException socket(Exception e) {
return new AppException(TYPE_SOCKET, 0, e);
}

public static AppException xml(Exception e) {
return new AppException(TYPE_XML, 0, e);
}

public static AppException run(Exception e) {
return new AppException(TYPE_RUN, 0, e);
}

/**
   * 獲取APP異常崩潰處理對象
   *
   * @param context
   * @return
   */
public static AppException getAppExceptionHandler() {
    return new AppException();
}

@Override
public void uncaughtException(Thread thread, Throwable ex) {

}

final Context context = AppManager.getAppManager().currentActivity();

    if (context == null) {
      return false;
    }

}.start();

saveErrorLog(crashReport);

return true;
}

return exceptionStr.toString();
}

return sb.toString();
}

public static StringBuffer getTraceInfo(Activity a, Throwable e) {
StringBuffer sb = new StringBuffer();

    Throwable ex = e.getCause() == null ? e : e.getCause();
    StackTraceElement[] stacks = ex.getStackTrace();
    for (int i = 0; i < stacks.length; i++) {
      sb.append("class: ").append(stacks[i].getClassName()).append("; method: ")
          .append(stacks[i].getMethodName()).append("; line: ").append(stacks[i].getLineNumber())
          .append("; Exception: ").append(ex.toString() + "\n");
    }
    return sb;
}

/**
   * 獲取手機的硬件信息
   *
   * @return
   */
public String getMobileInfo() {
    JSONObject osJson = new JSONObject();
    // 經過反射獲取系統的硬件信息