Android程序制作自己Log日志收集系统

写在前面

在我们的代码中，通常会用try{}catch来捕获能够预料到的一些异常，但是，通常情况下，我们的代码都会出现无法预料到异常信息，我们怎样去捕获到这些异常，并上传到自己的服务器来分析修bug呢？

UncaughtExceptionHandler接口

Java为我们提供了一个机制，用来捕获并处理在一个线程对象中抛出的未检测异常，以避免程序终止。我们可以通过UncaughtExceptionHandler来实现。
那么怎样使用呢？
首相，我们需要定义一个类，并实现UncaughtExceptionHandler

public class CatchExceptionUtil implements UncaughtExceptionHandler {
    // ......
}

然后，写一个初始化方法

public class CatchExceptionUtil implements UncaughtExceptionHandler {
    /**
     * 初始化
     * @param context
     */
    public void init(Context context) {
        mContext = (MyApplication) context;
        // 获取系统默认的UncaughtException处理器
        mDefaultHandler = Thread.getDefaultUncaughtExceptionHandler();
        // 设置该CrashHandler为程序的默认处理器
        Thread.setDefaultUncaughtExceptionHandler(this);
    }
}

重写uncaughtException方法

public class CatchExceptionUtil implements UncaughtExceptionHandler {
    /**
     * 初始化
     * @param context
     */
    public void init(Context context) {
        mContext = (MyApplication) context;
        // 获取系统默认的UncaughtException处理器
        mDefaultHandler = Thread.getDefaultUncaughtExceptionHandler();
        // 设置该CrashHandler为程序的默认处理器
        Thread.setDefaultUncaughtExceptionHandler(this);
    }

    /**
     * 当UncaughtException发生时会转入该函数来处理
     */
    @Override
    public void uncaughtException(Thread thread, Throwable ex) {
        if (!handleException(ex) && mDefaultHandler != null) {
            // 如果用户没有处理则让系统默认的异常处理器来处理
            mDefaultHandler.uncaughtException(thread, ex);
        } else {
            // 程序出现了异常，通常我们在这里退出，并重新启动应用
            ToastUtil.showShortToast(mContext,"出现未知异常");
            forceExit();
        }
}

在上面的代码中，我们看到出现了一个很关键的方法，handleException，我们需要在这里去作出自己的处理如上传崩溃信息到服务器，或者存储Log日志到SD卡等
下面是handleException的方法

    /**
     * 自定义错误处理,收集错误信息 发送错误报告等操作均在此完成.
     * 
     * @param ex
     * @return true:如果处理了该异常信息;否则返回false.
     */
    private boolean handleException(Throwable ex) {
        if (ex == null) {
            return false;
        }
        // 使用Toast来显示异常信息
        new Thread() {
            @Override
            public void run() {
                Looper.prepare();
                Looper.loop();
            }
        }.start();
        // 收集设备参数信息
        collectDeviceInfo(mContext);
        // 保存日志文件
        saveCrashInfo2File(ex);
        //上传日志信息
        uploadingLog();
        return true;
    }

文末将会贴出这个类的所有方法，下面我们在Application中调用这个类

        CatchExceptionUtil crashHandler = CatchExceptionUtil.getInstance();//
        crashHandler.init(getApplicationContext());

以下是本类完整的代码


/**
 * @brief 异常崩溃处理类
 * @details 当程序发生未捕获异常时，由该类来接管程序并记录发送错误报告。
 */
public class CatchExceptionUtil implements UncaughtExceptionHandler {

    public static final String TAG = "CatchExceptionUtil";

    // 系统默认的UncaughtException处理类
    private UncaughtExceptionHandler mDefaultHandler;
    // CrashHandler实例
    private static CatchExceptionUtil INSTANCE = new CatchExceptionUtil();
    // 程序的Context对象
    private MyApplication mContext;
    // 用来存储设备信息和异常信息
    private Map<String, String> infos = new HashMap<String, String>();

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

    private StringBuffer context;

    private String mId;

    /** 保证只有一个CrashHandler实例 */
    private CatchExceptionUtil() {
    }

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

    /**
     * 初始化
     * 
     * @param context
     */
    public void init(Context context) {
        mContext = (MyApplication) context;
        // 获取系统默认的UncaughtException处理器
        mDefaultHandler = Thread.getDefaultUncaughtExceptionHandler();
        // 设置该CrashHandler为程序的默认处理器
        Thread.setDefaultUncaughtExceptionHandler(this);
    }

    /**
     * 当UncaughtException发生时会转入该函数来处理
     */
    @Override
    public void uncaughtException(Thread thread, Throwable ex) {
        if (!handleException(ex) && mDefaultHandler != null) {
            // 如果用户没有处理则让系统默认的异常处理器来处理
            mDefaultHandler.uncaughtException(thread, ex);
        } else {
            // 退出程序
            ToastUtil.showShortToast(mContext,"出现未知异常");
//          Intent intent = new Intent(mContext, MainActivity.class);
//          intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
//          mContext.startActivity(intent);
            forceExit();
            //android.os.Process.killProcess(android.os.Process.myPid());
//          Intent intent = new Intent(mContext.getApplicationContext(), MainActivity.class);
//          PendingIntent restartIntent = PendingIntent.getActivity(
//                  mContext.getApplicationContext(), 0, intent,
//                  PendingIntent.FLAG_ONE_SHOT);
//          //退出程序
//          AlarmManager mgr = (AlarmManager)mContext.getSystemService(Context.ALARM_SERVICE);
//          mgr.set(AlarmManager.ELAPSED_REALTIME_WAKEUP, 0,
//                  restartIntent); // 1秒钟后重启应用
            //application.finishActivity();

        }


    }

    private void forceExit() {
        MyApplication.getInstance().finishAllActivity();
        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();
                Looper.loop();
            }
        }.start();
        // 收集设备参数信息
        collectDeviceInfo(mContext);
        // 保存日志文件
        saveCrashInfo2File(ex);
        //上传日志信息
        uploadingLog();
        return true;
    }

    /**上传日志信息*/
    private void uploadingLog() {
        //需要将参数上传
        String uid=mContext.getUserEntity().getUserId();
        String platform="ANDROID";
        String con = context.toString();
        String device_mode= Build.MODEL ;
        String device_id= Build.ID;
        RequestParams params = new RequestParams(HttpUrlManager.clientcrash());
        params.addBodyParameter("uid", uid);
        params.addBodyParameter("platform", platform);
        params.addBodyParameter("content", con);
        params.addBodyParameter("device_mode", device_mode);
        params.addBodyParameter("device_id", device_id);
        params.addBodyParameter("version", SystemUtil.GetVersionName(mContext));
        x.http().post(params, new Callback.CommonCallback<String>() {
            @Override
            public void onCancelled(CancelledException arg0) {
            }

            @Override
            public void onError(Throwable arg0, boolean arg1) {
                forceExit();
            }

            @Override
            public void onFinished() {

            }

            @Override
            public void onSuccess(String arg0) {
                forceExit();
        }
        });
    }

    /**
     * 收集设备参数信息
     * 
     * @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());
            } catch (Exception e) {
                Log.e(TAG, "an error occured when collect crash info", e);
            }
        }
    }

    /**
     * 保存错误信息到文件中
     * 
     * @param ex
     * @return 返回文件名称,便于将文件传送到服务器
     */
    @SuppressLint("SdCardPath")
    private String saveCrashInfo2File(Throwable ex) {

        context = new StringBuffer();
        for (Map.Entry<String, String> entry : infos.entrySet()) {
            String key = entry.getKey();
            String value = entry.getValue();
            if ("ID".equals(key)) {
                mId = value;
            }
            context.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();
        context.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 = "/sdcard/crash/";
                File dir = new File(path);
                if (!dir.exists()) {
                    dir.mkdirs();
                }
                FileOutputStream fos = new FileOutputStream(path + fileName);
                fos.write(context.toString().getBytes());
                fos.close();
            }
            Log.e(TAG, context.toString());
            return fileName;
        } catch (Exception e) {
            Log.e(TAG, "an error occured while writing file...", e);
        }
        return null;
    }
}

Android程序制作自己Log日志收集系统

写在前面

UncaughtExceptionHandler接口

猜你喜欢