美文网首页
2019-04-18 Android打印超长日志(格式化日志,提

2019-04-18 Android打印超长日志(格式化日志,提

作者: HaloMartin | 来源:发表于2019-04-18 22:00 被阅读0次

背景

在使用mp4v2库封装mp4文件的时候,怀疑输入的帧数据有问题导致写入文件失败,因为一些原因,被迫必须以十六进制打印写入的帧数据内容。
众所周知,系统的Log方法能打印日志到Logcat中,但是日志长度是受限的,只不过我们一般用不到那么长,最长不会超过 4 * 1024 个字节,超出会被截断,至于究竟限制多少,不在文章讨论范围内,可以参考这个 "终于知道Log显示不全的原因了",我们这里主要是讨论怎么打印的更多。

方法

方法很简单粗暴,既然一个日志写不下,那就再加几个,采用分段打印的方式,简单点来说,就是在自定义的打印日志方法中加一个方法,或者干脆专门创建一个单独的日志类来实现,最终还是使用系统的Log类,不建议使用println等方式绕过系统,虽然显得你能力强,但是有违代码复用的思想。
直接上代码:

package com.vihivision.camerafamilyKey.util;

import android.text.TextUtils;
import android.util.Log;

/**
 * Apr 18, 2019 Create by Martin
 * 日志类,支持普通及超长日志的打印
 * */
public class HHLog {
    private final static int SEGMENT_MAX_SIZE = 3 * 1024;
    private final static int STACK_TRACE_ELEMENT_INDEX = 4;
    private final static int V = 1;
    private final static int D = 2;
    private final static int I = 3;
    private final static int W = 4;
    private final static int E = 5;
    /**
     * 对应Log.e(String tag, String msg)进行打印,日志等级:错误
     * @param tag 标签,可以在logcat工具中被识别
     * @param object 日志内容,需要被打印输出的内容
     * */
    public static void e(String tag, Object object) {
        boolean illegalTag = false;
        boolean illegalObject = false;
        if (TextUtils.isEmpty(tag)) {
            illegalTag = true;
        }
        if (object == null || object.toString().length() == 0) {
            illegalObject = true;
        }
        if (illegalTag || illegalObject) {
            return;
        }
        String message = object.toString();
        int length = message.length();
        if (length <= SEGMENT_MAX_SIZE) {
            formatLog(E, tag, message);
        }else {
            while (message.length() > SEGMENT_MAX_SIZE) {
                String logContent = message.substring(0, SEGMENT_MAX_SIZE);
                message = message.substring(SEGMENT_MAX_SIZE);
                formatLog(E, tag, logContent);
            }
            formatLog(E, tag, message);
        }
    }
    
    /**
     * 对应Log.e(String tag, String msg, Throwable tr)进行打印,日志等级:错误
     * @param tag 标签,可以在logcat工具中被识别
     * @param object 日志内容,需要被打印输出的内容
     * @param thr 异常信息,应一并输出到日志
     * */
    public static void e(String tag, Object object, Throwable thr) {
        //Implementation
    }
    /**
     * 格式化并执行打印
     * @param type 日志等级,包含 5 种:V、D、I、W、E,且只能是这4个
     * @param tag 标签
     * @param object 日志内容
     * */
    private static void formatLog(int type, String tag, Object object) {
        StackTraceElement[] stackTraceElements = Thread.currentThread().getStackTrace();
        String filename = stackTraceElements[STACK_TRACE_ELEMENT_INDEX].getFileName();
        String classStr = stackTraceElements[STACK_TRACE_ELEMENT_INDEX].getClassName();
        String methodStr = stackTraceElements[STACK_TRACE_ELEMENT_INDEX].getMethodName();
        int lineNumber = stackTraceElements[STACK_TRACE_ELEMENT_INDEX].getLineNumber();

        StringBuilder stringBuilder = new StringBuilder();
        stringBuilder.append("[ (").append(filename).append(":").append(lineNumber).append(")#").append(methodStr).append(" ]");

        String messageContent = object.toString();
        stringBuilder.append(messageContent);
        
        switch (type) {
            case V:
                Log.v(tag, stringBuilder.toString());
                break;
            case D:
                Log.d(tag, stringBuilder.toString());
                break;
            case I:
                Log.i(tag, stringBuilder.toString());
                break;
            case W:
                Log.w(tag, stringBuilder.toString());
                break;
            case E:
                Log.e(tag, stringBuilder.toString());
                break;
            default:
                break;
        }

    }
}

代码解析

此处代码是新建了一个日志类HHLog,如果用户已经有一个日志类了,可以直接把类中的代码全部移过去,或者设计合适的设计模式,比如工厂类,由工厂类来统一管理多种日志类,不过实际项目中,建议还是使用一个就好了,设计模式在此处画蛇添足了。

HHLog中公开的静态方法:

    /**
     * 对应Log.e(String tag, String msg)进行打印,日志等级:错误
     * @param tag 标签,可以在logcat工具中被识别
     * @param object 日志内容,需要被打印输出的内容
     * */
    public static void e(String tag, Object object) {……}
   /**
     * 对应Log.e(String tag, String msg, Throwable tr)进行打印,日志等级:错误
     * @param tag 标签,可以在logcat工具中被识别
     * @param object 日志内容,需要被打印输出的内容
     * @param thr 异常信息,应一并输出到日志
     * */
    public static void e(String tag, Object object, Throwable thr) {……}

这里实现的是日志等级为Error的日志打印,开发者可以自行系统Log类中公开的那些静态方法,比如对应日志等级为Verbose、Debug、Info、Warn,每个日志等级都有两个方法,一个是普通的日志信息打印,另一个增加了异常信息Throwable的输出。

HHLog中私有的静态方法:

/**
     * 格式化并执行打印
     * @param type 日志等级,包含 5 种:V、D、I、W、E,且只能是这4个
     * @param tag 标签
     * @param object 日志内容
     * */
    private static void formatLog(int type, String tag, Object object) {……}

这里主要就是格式化输出,获取调用栈内的信息,格式化后添加到日志输出字符串的前部,使日志内容一目了然,其中

stringBuilder.append("[ (").append(filename).append(":").append(lineNumber).append(")#").append(methodStr).append(" ]");

特殊的格式利用了强大的Logcat工具,可以在Logcat中进行日志代码的快速定位,如图:

Logcat工具日志快速定位
点击图中 蓝色字部分 可以快速定位到日志所在代码行,有效提高日志调试效率。

相关文章

网友评论

      本文标题:2019-04-18 Android打印超长日志(格式化日志,提

      本文链接:https://www.haomeiwen.com/subject/lwhxgqtx.html