Android 全局捕获异常

Android 全局捕获异常

2018/1/24 11:47:52

---

前景

• 减少Bug
• 出现Bug 尽快解决
• 上线后 Bug 在用户手机上，无发知道Bug
• 需要工具类，捕获异常，不要崩溃，从新启动，让用户没有感觉

为什么要使用全局捕获异常

• 使用全局捕获异常，当程序遇到异常时，不会直接提示用户奔溃，而是采取相应的操作，例如，跳转到指定的页面，或者吐司提示”程序奔溃，即将退出”，或者重写打开App,或者直接退出。同时，将异常生产文件保存到SD卡，发送到服务器。以便于我们开发人员即使解决Bug.

UncaughtExceptionHandler

UncaughtExceptionHandler处理我们未捕获的异常，

• 使用步骤

---

1. 自定义自己的异常处理类实现UncaughtExceptionHandler接口，实现里面的uncaughtException方法
2. 设置该类为系统默认的异常处理类。Thread.setDefaultUncaughtExceptionHandler(crashHandler);
3. 在Application中初始化
4. 在AndrpoidManifest.xml中注册

---

代码

    import android.content.Context;
    import android.content.Intent;
    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;

    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.HashMap;
    import java.util.Map;

    /**
     * Created with Android Studio
     *
     * @author maohuawei
     * @user maohuawei
     * @date 2018/1/24
     * @time 11:04
     * @qq:898658615
     * @email mhw828@sina.com
     * <p>
     * Description:
     * <p>
     * 全局捕获异常
     * <p>
     * UncaughtException处理类,当程序发生Uncaught异常的时候,由该类来接管程序,并记录发送错误报告。
     * <p>
     * 1.创建Application,注册我们的异常管理类。
     * 2.触发异常,选择哪种处理异常的方式。
     * 3.创建出现异常跳转的Activity,ReportActivity.
     */
    public class CrashHandler implements UncaughtExceptionHandler {

        /**
         * TAG
         */
        private static final String TAG = CrashHandler.class.getSimpleName();


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

        /**
         * CrashHandler实例
         */
        private static CrashHandler INSTANCE = new CrashHandler();

        /**
         * 程序的Context对象
         */
        private Context mContext;
        /**
         * 用来存储设备信息和异常信息
         */

        private Map<String, String> infos = new HashMap<String, String>();


        /**
         * 用于格式化日期,作为日志文件名的一部分
         */
        private DateFormat formatter = new SimpleDateFormat("yyyy-MM-dd-HH-mm-ss-SSS");

        /**
         * 私有化构造方法，保证只有一个CrashHandler实例
         */
        private CrashHandler() {
        }

        /**
         * 获取CrashHandler实例 ,单例模式
         */
        public static CrashHandler getInstance() {
            return INSTANCE;
        }

        /**
         * A.初始化
         *
         * @param context
         */
        public void init(Context context) {

            mContext = context;
            //获取系统默认的UncaughtException处理器

            mDefaultHandler = Thread.getDefaultUncaughtExceptionHandler();

            //设置该CrashHandler为程序的默认处理器
            Thread.setDefaultUncaughtExceptionHandler(this);
        }

        /**
         * B.当UncaughtException发生时会转入该函数来处理
         */
        @Override
        public void uncaughtException(Thread thread, Throwable ex) {
            System.out.println("thread =" + ex.getMessage());

            System.out.println("ex =" + ex);

            if (!handleException(ex) && mDefaultHandler != null) {
                //如果用户没有处理则让系统默认的异常处理器来处理
                mDefaultHandler.uncaughtException(thread, ex);
            } else {


                /**********************************************************************
                 * 第一种处理方法：
                 *
                 *  如果出现异常,捕获异常并跳转到指定页面.
                 *
                 ***********************************************************************/


                /**

                 Intent intent = new Intent(mContext, ReportActivity.class);
                 //设置Activity的启动模式,开启一个新的任务栈
                 intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
                 mContext.startActivity(intent);
                 //注意:如果这里爆红,是因为java包和Android包的问题,杀死当前进程,关闭当前的进程
                 Process.killProcess(Process.myPid());

                 */


                /**********************************************************************
                 * 第二种处理方法：
                 *
                 *  如果出现异常,应用自动重启进入home或启动页面
                 *
                 ***********************************************************************/


                Intent intent = new Intent(mContext, MainActivity.class);
                intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
                mContext.startActivity(intent);
                android.os.Process.killProcess(android.os.Process.myPid());


                /**********************************************************************
                 * 第三种处理方法：
                 *
                 * 吐司显示
                 *
                 ***********************************************************************/

                /**
                 handleException(ex);
                 */
            }
        }

        /**
         * 自定义错误处理,收集错误信息 发送错误报告等操作均在此完成.
         *
         * @return true:如果处理了该异常信息,返回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");
            }
            sb.append(ex.getMessage());
            //Log输出错误的日志
            System.out.println("sb = " + sb.toString());

            //把错误日志存到SD卡中, 开发中常用, 出现问题把存的文件上传到服务器
            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(System.currentTimeMillis());
                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;
        }


        /**
         * 上传日志到服务器
         */
        public void uploadLogToServer() {

            //遍历sd卡中crash文件夹,得到每一个文件

            String filepath = "/sdcard/crash/";

            File file = new File(filepath);

            File[] files = file.listFiles();

            for (File f : files) {

                //使用okhttp的post方式上传file文件


                //把上传的文件crash文件夹中删除
            }


        }
    }

使用

    public class App extends Application {

        @Override
        public void onCreate() {
            super.onCreate();

            CrashHandler.getInstance().init(this);

        }
    }

注册

在AndroidManifest.xml中注册