Android App Logging 组件客制化 - 个人记录学习

目录

一.日志的作用与注意事项

二.常规崩溃日志的处理

三.日志开源框架：Logger的介绍

四.利用java自带的logger封装和处理

日志的作用

在日常开发过程中，日志是代码的必要组成部分，一个好的代码也必然有一个好的日志输出，优秀的日志不仅可以快速帮助我们分析定位问题还可以在对日志的数据挖掘中产生很大的威力。

Java自带日志的局限性                   

java在发生异常时可以打印它的堆栈信息以帮助调试，但是java的异常也有下列问题：

1）java出现异常时只能展示静态的调用堆栈信息，对应异常之前的调用参数则无法进行展示，也就是只知道哪里发生了异常，而不知道是哪些数据导致了异常； 
2）java的异常堆栈通常是直接定位到某个文件的某一行，在发生异常时，如果不看代码都不知道异常详细情况，可读性比较差；

日志输出注意事项：

1）在任务执行之前和执行之后打印log，任务执行之前的log上带上当前任务的所有参数，任务执行结束的log尽量带上当前的 处理结果； 
2）在关键函数入口处（即进入该函数的开始位置）和出口前打印log，入口处的log带上当前的参数，出口处的log尽量带上当 前的处理结果； 
3）在错误和异常日志中带上错误和异常执行前的关键参数；在实际开发中经常会遇到各种条件判断，如果条件不满足，则返 回错误，此时再返回之前尽量要输出一条log，并在该log上带上引起错误的参数，对于异常也是如此；

4）在关键代码前加上log，log要带上当前的重点参数；例如，有一段代码是向另外一个模块发送消息，则在发送消息之前最好加上log，log中要带上向哪里发送什么； 
5）在有关键信息出现的地方加log，并在log中输出这些关键的信息； 
6）日志描述要简洁清晰；

常规崩溃日志的处理：

1.自定义CrashHandler

先介绍一下常用的异常处理CrashHandler类：

public class CrashHandler implements UncaughtExceptionHandler {
    
    public static final String TAG = "CrashHandler";
      
    //系统默认的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", Locale.getDefault());
  
    /** 保证只有一个CrashHandler实例 */  
    private CrashHandler() {  
    }  
  
    /** 获取CrashHandler实例 ,单例模式 */  
    public static CrashHandler getInstance() {  
        return INSTANCE;  
    }  
  
    /** 
     * 初始化 
     *  
     * @param context 
     */  
    public void init(Context context) {
        mContext = context;  
        //获取系统默认的UncaughtException处理器  
        mDefaultHandler = Thread.getDefaultUncaughtExceptionHandler();
        //设置该CrashHandler为程序的默认处理器  
        Thread.setDefaultUncaughtExceptionHandler(this);
    }  
  
    /** 
     * 当UncaughtException发生时会转入该函数来处理 
     */  
    @Override
    public void uncaughtException(Thread thread, Throwable ex) {
    ex.printStackTrace();
        if (!handleException(ex) && mDefaultHandler != null) {  
            //如果用户没有处理则让系统默认的异常处理器来处理  
            mDefaultHandler.uncaughtException(thread, ex);  
        } else {  
            try {  
                Thread.sleep(1000);
            } 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, "出现异常 即将退出app...", Toast.LENGTH_SHORT).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 + ".txt";
             
            if (Environment.getExternalStorageState().equals(Environment.MEDIA_MOUNTED)) {
                String path = Environment.getExternalStorageDirectory().getPath() + File.separatorChar + "Android" + File.separatorChar + "data" + File.separatorChar + mContext.getPackageName() + File.separatorChar;
                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;  
    }  
}  

还有以邮件发送的形式：

/** 
 * UncaughtException处理类,当程序发生Uncaught异常的时候,由该类来接管程序,并记录发送错误报告. 
 *  
 * @author way 
 *  
 */  
public class CrashHandler implements UncaughtExceptionHandler {  
    private Thread.UncaughtExceptionHandler mDefaultHandler;// 系统默认的UncaughtException处理类  
    private static CrashHandler INSTANCE;// CrashHandler实例  
    private Context mContext;// 程序的Context对象  
  
    /** 保证只有一个CrashHandler实例 */  
    private CrashHandler() {  
  
    }  
  
    /** 获取CrashHandler实例 ,单例模式 */  
    public static CrashHandler getInstance() {  
        if (INSTANCE == null)  
            INSTANCE = new CrashHandler();  
        return INSTANCE;  
    }  
  
    /** 
     * 初始化 
     *  
     * @param context 
     */  
    public void init(Context context) {  
        mContext = context;  
  
        mDefaultHandler = Thread.getDefaultUncaughtExceptionHandler();// 获取系统默认的UncaughtException处理器  
        Thread.setDefaultUncaughtExceptionHandler(this);// 设置该CrashHandler为程序的默认处理器  
    }  
  
    /** 
     * 当UncaughtException发生时会转入该重写的方法来处理