美文网首页Android
Android日志打印工具 - Logger

Android日志打印工具 - Logger

作者: naturs | 来源:发表于2017-09-26 22:07 被阅读1954次

    背景

    最近看了几个日志框架,最后发现Logger扩展性最好,显示效果也非常整齐,但Logger每个日志都是最少分为两部分显示(头部+日志内容)
    ,连上分割线最少显示五行,在日志很多的时候,会极为占空间,基于该原因,在该库的基础上进行了一些修改,整理了一个可以精简显示日志的库,并扩展了一些其他功能,使用方式和原Logger库几乎一致。

    介绍

    项目地址:https://github.com/naturs/Logger

    其中参考的库主要包括:

    https://github.com/orhanobut/logger

    https://github.com/ZhaoKaiQiang/KLog

    https://github.com/JakeWharton/timber

    https://github.com/pengwei1024/LogUtils

    该库除了原Logger库的特点以外,还包括以下特性:

    1. 将项目更改为Java工程,可以在Java平台上输出日志;
    2. 支持显示简化的日志信息;
    3. 添加了对Collection、Map、多维数组、Intent、Bundle的格式化输出;
    4. 支持指定调用方法栈;
    5. 大部分实现都能更改和替换;

    使用方式

    添加依赖

    如果是Java平台,仅需添加核心依赖:

    compile 'com.github.naturs.logger:logger-core:0.3'
    

    如果是Android平台,还可以添加以下依赖,主要添加了对Intent、Bundle的格式化输出,以及Logcat日志显示支持:

    compile 'com.github.naturs.logger:logger-android:0.3'
    

    初始化

    使用该库之前,需要进行初始化,主要是针对全局进行一些设置。

    如果是Java平台,可以进行如下初始化操作:

    // 以System.out.println()的方式输出日志
    Logger.addLogAdapter(new DefaultLogAdapter("Your Global Tag"));
    Logger.setLogConverter(new DefaultLogConverter());
    

    这两个方法的作用分别为:

    Logger.addLogAdapter()

    添加日志显示及输出方式,显示由DefaultLogAdapter中的成员变量FormatStrategy控制,它的作用主要是格式化日志,比如添加分割线、添加Log行数等,最后将格式化后的日志通过LogStrategy输出,比如DefaultLogAdapter默认的日志输出方式为DefaultLogStrategy,即使用System.out.println()输出。

    我们可以添加多个LogAdapter,比如部分日志需要输出到文件,我们就可以自定义一个记录到文件的LogAdapter,添加进来即可。

    Logger.setLogConverter()

    添加Log转换方式,比如将Map、Intent这样的对象转换成一个格式化后的字符串,由于默认带有多个Converter,这里使用LogConverter进行统一管理,同时方便外部调用。

    最终Log输出方式为:

    Logger -> ConverterStrategy(转换格式) -> LogAdapter -> FormatStrategy(添加额外信息并格式化) -> LogStrategy(输出)

    如果是Android平台,可以进行如下初始化操作:

    Logger.addLogAdapter(new AndroidLogAdapter("Your Global Tag"));
    Logger.setLogConverter(new AndroidLogConverter());
    

    功能和上面Java初始化方式一致。

    使用

    1、简单使用方式:

    Logger.d("message");
    Logger.i("message");
    Logger.e(Throwable);
    

    调用时会采用调用者的类名作为Tag,如果在初始化时指定了全局Tag,最终的Tag为:GlobalTag-YourTag

    2、如果要自定义Tag:

    Logger.tag("your tag").d("message");
    

    3、如果要输出格式化后的json或xml:

    Logger.json(json);
    Logger.xml(xml);
    

    4、如果要输出格式化后的对象:

    Logger.obj(object);
    

    目前Object类型支持CollectionMap多维数组BundleIntent,同时你也可以自定义Object转换方式:

    1. 实现ConverterStrategy接口;
    2. 在初始化时通过Logger.addConverterStrategy()方法加进去;

    5、如果你需要对Logger再进行一层封装,你可以写成这样:

    public class LogUtils {
    
        public static void d(String msg) {
            Logger.d(msg);
        }
    
    }
    

    但调用LogUtils.d()方法时,Tag和最终显示的方法行数都会从LogUtils.java中获取,也就是没法获取到调用LogUtils.d()方法的类的信息,这里可以稍作修改:

    public class LogUtils {
    
        public static void d(String msg) {
            Logger.invokeClass(LogUtils.class).d(msg);
        }
    
    }
    

    invokeClass()方法指定的是调用Logger的那个类,如果不指定则为当前类。

    效果

    java.png android.png

    相关文章

      网友评论

        本文标题:Android日志打印工具 - Logger

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