Android捕獲錯誤信息發(fā)送至服務器
程序員最頭疼的事情就是bug和debug。因為Android兼容性,不同手機會有不同的bug出來, 而且很難復現(xiàn),所以就找了下類似保存錯誤log到文件再上傳到服務器,現(xiàn)把源碼也共享出來。上傳至服務器的代碼沒加,相信大家都有現(xiàn)成的代碼了。
先講下原理,跟JavaEE的自定義異常捕獲一樣,將錯誤一直向上拋,然后在最上層統(tǒng)一處理。這里就可以獲得Exception Message,進行保存操作。
異常捕獲類如下:
- /**
- * @author Stay
- * 在Application中統(tǒng)一捕獲異常,保存到文件中下次再打開時上傳
- */
- public class CrashHandler implements UncaughtExceptionHandler {
- /** 是否開啟日志輸出,在Debug狀態(tài)下開啟,
- * 在Release狀態(tài)下關(guān)閉以提示程序性能
- * */
- public static final boolean DEBUG = true;
- /** 系統(tǒng)默認的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對象,
- * 獲取系統(tǒng)默認的UncaughtException處理器,
- * 設置該CrashHandler為程序的默認處理器
- *
- * @param ctx
- */
- public void init(Context ctx) {
- // mContext = ctx;
- mDefaultHandler = Thread.getDefaultUncaughtExceptionHandler();
- Thread.setDefaultUncaughtExceptionHandler(this);
- }
- /**
- * 當UncaughtException發(fā)生時會轉(zhuǎn)入該函數(shù)來處理
- */
- @Override
- public void uncaughtException(Thread thread, Throwable ex) {
- if (!handleException(ex) && mDefaultHandler != null) {
- //如果用戶沒有處理則讓系統(tǒng)默認的異常處理器來處理
- mDefaultHandler.uncaughtException(thread, ex);
- } else { //如果自己處理了異常,則不會彈出錯誤對話框,則需要手動退出app
- try {
- Thread.sleep(3000);
- } catch (InterruptedException e) {
- }
- android.os.Process.killProcess(android.os.Process.myPid());
- System.exit(10);
- }
- }
- /**
- * 自定義錯誤處理,收集錯誤信息
- * 發(fā)送錯誤報告等操作均在此完成.
- * 開發(fā)者可以根據(jù)自己的情況來自定義異常處理邏輯
- * @return
- * true代表處理該異常,不再向上拋異常,
- * false代表不處理該異常(可以將該log信息存儲起來)然后交給上層(這里就到了系統(tǒng)的異常處理)去處理,
- * 簡單來說就是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();
- // 可以只創(chuàng)建一個文件,以后全部往里面append然后發(fā)送,這樣就會有重復的信息,個人不推薦
- 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 發(fā)送錯誤報告到服務器 這里不再贅述
- // private void postReport(File file) {
- // 在上傳的時候還可以將該app的version,該手機的機型等信息一并發(fā)送的服務器,
- // Android的兼容性眾所周知,所以可能錯誤不是每個手機都會報錯,還是有針對性的去debug比較好
- // }
- }
在Application onCreate時就注冊ExceptionHandler,此后只要程序在拋異常后就能捕獲到。
- public class Appextends Application{
- @Override
- public void onCreate() {
- super.onCreate();
- CrashHandler crashHandler = CrashHandler.getInstance();
- //注冊crashHandler
- crashHandler.init(getApplicationContext());
- }
- }
- public class LogActivityextends 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來捕獲,統(tǒng)一將文件保存起來上傳
- 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);
- }
- }