Android捕捉并收集未被程序处理的异常Exception

2014年11月19日 Android 3条评论 阅读4695次
Android捕捉并收集未被程序处理的异常Exception

在Android应用中,异常(Exception)/错误(Error)都是很常见的,为了让自己的android应用程序更加稳健、不至于很容易异常死掉,所以我们在程序中就要注意try-catch-final的使用。但无论如何,程序员总是对程序的所有异常错误都无法完全预知,这样就出现了程序极不友好的提示,给用户带来很不好的体验效果。而一旦发生了异常/错误的情况,只给程序员提供一个出错了的信息,相信诸程序员也只能无奈地摇头叹气。
基于上述问题,我们想要把未捕捉到的异常/错误信息及时保存到日志文件中,根据需要让用户提供日志文件或选择网络上传发送等。
其实,在java中jdk已经给我们提供了这样一个解决异常处理类。这就是java.lang.Thread.UncaughtExceptionHandler类。
自己只需写一个类来实现Thread.UncaughtExceptionHandler,具体未捕捉的异常处理就在uncaughtException里写就可以了。最后这个类只要在android应用的MainActivity或Application类中的onCreate中注册一次即可。
下面是一个写好的UncaughtExceptionHandler类,实现的功能就是程序遇到未知的异常时,通过Toast的形式向用户提示“很抱歉,程序出现异常,即将退出...”;同时向手机存储中制定文件夹的指定文件中保存出现异常时的设备信息(手机型号、手机生产厂商、OS版本、内核版本等)、时间、具体的StackTrace等信息;最后程序的结局肯定还是终止掉,或你可以根据自己的需求重新启动应用等。
得到出现异常的日志后,则可选择上传到网络服务器等操作了。
具体参照下面的代码。

package yourpackage;

import ......

public class CatchOtherExceptions implements Thread.UncaughtExceptionHandler {

    private static final String TAG = "CatchOtherExceptions";
    private static final String FOLDER = "Log";
    private static CatchOtherExceptions instance = null;
    private static Context mContext = null;

    // 系统默认的 UncaughtException 处理类
    private static Thread.UncaughtExceptionHandler mDefaultHandler;

    // 用来存储设备信息和异常信息
    private Map<String, String> infos = new HashMap<String, String>();

    // 用于格式化日期,作为日志文件名的一部分
    private DateFormat formatter = new SimpleDateFormat("yyyyMMddHHmmss");

    private CatchOtherExceptions() {
    }

    public static CatchOtherExceptions getInstance(Context c) {
        mContext = c;
        if (instance == null) {
            instance = new CatchOtherExceptions();
        }

        // 获取系统默认的 UncaughtException 处理器
        mDefaultHandler = Thread.getDefaultUncaughtExceptionHandler();

        return instance;
    }

    @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);

        }
    }

    /**
     * 自定义错误处理,收集错误信息,发送错误报告等操作均在此完成
     * 
     * @param ex
     * @return true:如果处理了该异常信息;否则返回 false
     */
    private boolean handleException(Throwable ex) {
        if (ex == null) {
            return false;
        }

        // 使用 Toast 来显示异常信息
        new Thread() {
            @Override
            public void run() {
                Looper.prepare();
                Toast.makeText(mContext, "很抱歉,程序出现异常,即将退出...",
                        Toast.LENGTH_LONG).show();
                Looper.loop();
            }
        }.start();

        // 收集设备参数信息
        collectDeviceInfo(mContext);
        // 保存日志文件
        saveCrashInfo2File(ex);
        return true;
    }

    /**
     * 收集设备参数信息
     * 
     * @param ctx
     */
    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);
            }
        }
    }

    /**
     * 保存错误信息到文件中
     * 
     * @param ex
     * @return 返回文件名称,便于将文件传送到服务器
     */
    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 = Environment.getExternalStorageDirectory()
                        .getPath() + File.separator + FOLDER;
                File dir = new File(path);
                if (!dir.exists()) {
                    dir.mkdirs();
                }
                FileOutputStream fos = new FileOutputStream(path
                        + File.separator + 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;
    }
}
在MainActivity或应用程序的Application类的onCreate方法中加入下面的代码

Thread.setDefaultUncaughtExceptionHandler(CatchOtherExceptions.getInstance((this)));


各位在使用的时候,可能需要修改的就是要保存的路径,上面的例子是直接存到了存储的Log文件夹中。

文末,有问题欢迎提出。

分享本文至:

WRITTEN BY

avatar
本文标签:exception
看了本文是不是觉得很赞,那就赶紧点击下面按钮分享给身边的朋友吧!

3 条评论

  1. avatar 鞍山妇科医院

    感谢楼主分享,收藏了慢慢看,慢慢学

  2. avatar LED display

    博主是专门开发android的吗,好厉害哇。

  3. avatar 琉璃瓦

    博主高手啊。来看看博主。加油

欢迎留言




用户登录

sitemap