android日志框架Logger的详细使用（目前最新版2.1.1）

最新推荐文章于 2024-06-21 17:35:35 发布

M-Ellen

最新推荐文章于 2024-06-21 17:35:35 发布

阅读量2w

点赞数 18

分类专栏： android框架文章标签： Logger android日志框架

本文链接：https://blog.csdn.net/pzm1993/article/details/78264994

版权

android框架专栏收录该内容

1 篇文章 0 订阅

订阅专栏

前言

在开发过程中，log日志是每个人多会用上的。平时在开发大项目的时候，几乎每个类多需要加log，然而在发布之前，要求全部删除，真是累。因为系统log暂时没有统一管理的方法。还有就是，特别是在调试的时候，对于线程并发或者子线程的调试，还是加log调试比较精确，用debug工具调试经常和实际不符合。那么，如果使用系统log，调试完又得找出来删除，累++。

作为程序猿，这种笨方法肯定是会鄙视的。对于这种需求，我们自己封装一个简单的工具包。当然这里介绍的是，github上很多人用log框架：logger。

相信很多人多用过，这里给还没有尝试过的人简单介绍下，使用也超级简单。

logger作为调试框架，可以支持多种格式：

线程的信息
类、方法的信息
格式化将 json、xml 输出
支持字符串格式参数
各种集合输出，list、map、array、set等，（只支持debug输出）
支持从日志跳转到源码
......

如下图（引用原作者）：

可以看出，和系统对比，它最大的亮点是优雅的输出log信息，当然同时提供很多其他信息，一目了然，更清晰！

如果你每天被log折磨的生不如死，那么让logger来拯救你吧~

作者：Orhan Obut

github：https://github.com/orhanobut/logger

目前，将近7.5k个star让他位列调试框架第二名，屈居facebook的stetho之后,8.5k个star。但这2个调试工具应用场景不用，所以简单的调试，logger是最佳选择了。这里简单介绍下stetho，它是一款提供在Chrome开发者工具上调试Android app的开源框架，可以在Chrome查看数据库，不用想以前那样把数据库导出，然后在用工具查看；配合网络框架可以直接打印查看网络请求的数据，而不需要一个一个添加打印出来，省去很多繁琐的事情。有兴趣的可以了解：

作者：FaceBook

官网地址： http://facebook.github.io/stetho/

github https://github.com/facebook/stetho

使用Logger

使用框架，是比较简单的，如果可以看英文版，可以直接到https://github.com/orhanobut/logger了解。

logger目前的最新版本是2.1.1，网上也很多人使用1.15的版本，如果使用最新版，单独修改配置文件，是有报错的。因为，最新版在初始化这块和原来有了较大的改动。

主要是初始化、和控制Log打印这2方面。这里介绍2.11的版本使用，所以想升级的也可以往下看看哦。

3步，只要3步，你就学会使用Logger，请：

1.导入依赖

compile 'com.orhanobut:logger:2.1.1'

2.初始化

Logger.addLogAdapter(new AndroidLogAdapter());

注：如果在Application中初始化，记得修改 AndroidManifest.xml 中 application 标签属性，添加 android:name=".MyApplication" ，不然不会打印。

3.使用

Logger.d("hello");

如图：

ok，恭喜你，你已经学会了，这样子就可以使用啦~真是so easy！

当然，如果还有追求，继续往下看看它的其他功能。

支持的数据类型

普通类型

    public void testNormal(){
        Logger.d("DEBUG日志");
        Logger.i("INFO日志");
        Logger.e("ERROR日志");
    }

Format类型

public void testFormat(){
        Logger.d("hello %s, luck number is %d", "world", 5);
    }

集合类型

首先看看List：

List list = new ArrayList();
list.add("hello");
list.add("world");
Logger.d(list);

使用该框架，可以直接支持打印，其他数据类型也一样。如果是使用系统Log打印的话，需要加toString变成string类型才可以

Log.d(TAG, list.toString());

那么就可以猜测，里面肯定已经帮我们实现好了toString()方法，看源码：

首先是调用：

@Override public void d(Object object) {
    log(DEBUG, null, Utils.toString(object));
  }

将打印对象传给了工具类Utils.toString（），然后：

public static String toString(Object object) {
    if (object == null) {
      return "null";
    }
    if (!object.getClass().isArray()) {
      return object.toString();
    }
    if (object instanceof boolean[]) {
      return Arrays.toString((boolean[]) object);
    }
    if (object instanceof byte[]) {
      return Arrays.toString((byte[]) object);
    }
    if (object instanceof char[]) {
      return Arrays.toString((char[]) object);
    }
    if (object instanceof short[]) {
      return Arrays.toString((short[]) object);
    }
    if (object instanceof int[]) {
      return Arrays.toString((int[]) object);
    }
    if (object instanceof long[]) {
      return Arrays.toString((long[]) object);
    }
    if (object instanceof float[]) {
      return Arrays.toString((float[]) object);
    }
    if (object instanceof double[]) {
      return Arrays.toString((double[]) object);
    }
    if (object instanceof Object[]) {
      return Arrays.deepToString((Object[]) object);
    }
    return "Couldn't find a correct type for the object";
  }

这样就不需要我们自己调用toString()，直接可以打印了。

其他的数据结构也是一样的，看图就可以了：

public void testCollections(){
        /**
         * Map
         */
        Map map = new HashMap();
        map.put("map1","hello");
        map.put("map2","world");
        Logger.d(map);

        /**
         * Set
         */
        Set set = new HashSet();
        set.add("hello");
        set.add("world");
        Logger.d(set);

        /**
         * Array
         */
        String [] strs = {"hello", "world"};
        Logger.d(strs);
    }

注：打印集合的时候，特别是数组时，前面不要添加其他字符，如：Logger.d("数组集合"+strs);这样会把整体当做一个参数，导致判断错误，不能正常输出数组类型。其次是，作者提示，打印集合时，使用DEBUG等级。

JSON数据

public void testJson(){
        String jsonDate = "{\"id\":859,\"channelnumber\":681,\"bilingual\":0,\"name\":\"beIN Sports 2 English 600K H265\",\n" +
                " \"language\":\"EN\",\n" +
                " \"videotype\":\"MPEG2\",\"audiotype\":\"MPEP1\",\"callsign\":\"beIN Sports 2 English 600K H265\",\"country\":\"cn\"};";

        Logger.json(jsonDate);
        Log.d(TAG, jsonDate);
    }

与系统Log的打印区别如图：

XML数据

public void testXml() {
        String xmlDate = "<province id=\"01\" name=\"北京\">  \n" +
                "    <city id=\"0101\" name=\"北京\">  \n" +
                "      <county id=\"010101\" name=\"北京\" weatherCode=\"101010100\"/>  \n" +
                "      <county id=\"010102\" name=\"海淀\" weatherCode=\"101010200\"/>  \n" +
                "      <county id=\"010103\" name=\"朝阳\" weatherCode=\"101010300\"/>  \n" +
                "      <county id=\"010110\" name=\"石景山\" weatherCode=\"101011000\"/>  \n" +
                "    </city>  \n" +
                "  </province>  ";
        Logger.xml(xmlDate);
        Log.d(TAG, xmlDate);
    }

如图：

修改默认配置

最新版修改配置，和旧版也是有不同，如下：

FormatStrategy formatStrategy = PrettyFormatStrategy.newBuilder()
  .showThreadInfo(false)      //（可选）是否显示线程信息。 默认值为true
  .methodCount(2)               // （可选）要显示的方法行数。 默认2
  .methodOffset(7)               // （可选）设置调用堆栈的函数偏移值，0的话则从打印该Log的函数开始输出堆栈信息，默认是0
  .logStrategy(customLog)  //（可选）更改要打印的日志策略。 默认LogCat
  .tag("MyTAG")                  //（可选）每个日志的全局标记。 默认PRETTY_LOGGER（如上图）
  .build();
Logger.addLogAdapter(new AndroidLogAdapter(formatStrategy));

具体配置大家可以自行去实践下。一般默认就可以了，这里说下，修改全局的TAG，和局部的TAG。

1.修改全局的TAG，在初始化的application中修改，如：

FormatStrategy formatStrategy = PrettyFormatStrategy.newBuilder()
                .tag("MyTAG")
                .build();
Logger.addLogAdapter(new AndroidLogAdapter(formatStrategy));

2.修改局部的TAG，哪里打印就在哪里修改，只对当前打印有效，如：

public void testNormal(){
        Logger.t("hello").d("DEBUG日志");
        Logger.i("INFO日志");
    }

注：如果尝试用局部的方法，在application初始化时修改。当然，这是有效果的，但只能用一次，其他打印还是会用全局的，可自行测试。

控制打印开关

这个功能是最喜欢的了，当我们发布软件，或者太多的log影响性能，那么就可以关闭logger打印，在application初始化的地方：

Logger.addLogAdapter(new AndroidLogAdapter() {
  @Override public boolean isLoggable(int priority, String tag) {
    return BuildConfig.DEBUG;
  }
});

通过适配器控制打印，只要覆盖isLoggable()方法，返回BuildConfig.DEBUG即可。这样子，log就不再打印出来了。

注：返回值导入的包是：import com.orhanobut.logger.BuildConfig; 有时顺手导入：com.gotechcn.frameworks，那就没有效果。

保存log到文件

有时需要将log保存起来，再进一步分析，那么，logger框架支持将log日志保存在文件中，只需换一个适配器即可。

Logger.addLogAdapter(new DiskLogAdapter());

该适配器同样也可以重新配置默认的参数，但会有点不同，配置的是日期格式等。

通过打印，找到保存的路径： /storage/emulated/0

但手机里面就是没有这个文件夹，不知道什么原因，真机和模拟机多没有，知道可以留言噢，感谢！

补充：

对于log的保存，官网只有这些内容了。。。（难道是忘了？）

评论中，提出要解决这个问题，于是，我再看了一下源码。。。

于是，最后的最后：改源码！！！（貌似如果不改动，另存log还真实现不了）

首先，要改源码，就不能自动依赖了，需要下载源码，手动导入...(鼓捣一下)；

其次，阅读源码，找到log保存的源码：在 CsvFormatStrategy 类中，找打如下代码：

@NonNull public CsvFormatStrategy build() {
      if (date == null) {
        date = new Date();
      }
      if (dateFormat == null) {
        dateFormat = new SimpleDateFormat("yyyy.MM.dd HH:mm:ss.SSS", Locale.UK);
      }
      if (logStrategy == null) {
        String diskPath = Environment.getExternalStorageDirectory().getAbsolutePath();
        String folder = diskPath + File.separatorChar + "logger";

        HandlerThread ht = new HandlerThread("AndroidFileLogger." + folder);
        ht.start();
        Handler handler = new DiskLogStrategy.WriteHandler(ht.getLooper(), folder, MAX_BYTES);
        logStrategy = new DiskLogStrategy(handler);
      }
      return new CsvFormatStrategy(this);
    }

这里可以看到，这里有默认保存的路径，只要修改这里路径就可以了（之前log保存没有成功，是找不到路径，所以方向是改路径）。那接下里就是修改了：

修改有2种：

1.如果路径不需要上下文Content，直接在CsvFormatStrategy 类中修改，方便快捷；

2.如果路径需要上下文Content，目前CsvFormatStrategy 没有这个参数，那么在自己工程中，提供一个自定义的FormatStrategy；

那么，这里选择第2种修改方式，代码如下：

        // 保存在包名路径下的（Android/data/包名/cache/log）       
        String folder  = getExternalCacheDir().getAbsolutePath() +  File.separator + "log";
        HandlerThread ht = new HandlerThread("AndroidFileLogger." + folder);
        ht.start();
        Handler handler = new DiskLogStrategy.WriteHandler(ht.getLooper(), folder, 500 * 1024);
        LogStrategy logStrategy = new DiskLogStrategy(handler);

        FormatStrategy formatStrategy = CsvFormatStrategy.newBuilder()
                .logStrategy(logStrategy)
                .tag("MyTAG")
                .build();
        Logger.addLogAdapter(new DiskLogAdapter(formatStrategy));

这咋一看，自定义一个FormatStrategy，不用修改源码呀。。。但是，有报错：

那么这里就需要修改内部类 WriteHandler的构造函数，添加public 修饰就可以了...

最后，就可以验证了，终于找到了你要的log文件...

保存log还挺有用，经常给测试人员测试的时候，保存一些偶现的bug...

如果如果，你觉得这样改动起来很麻烦，而且还要手动导入项目，你觉得：太难了！

那也是有办法的，前面自定义FormatStrategy时，是WriteHandler不能再外部使用，那么在外面复制一个出来就可以了，然后使用外面的WriteHandler。未验证，应该是可以的~~

工作流程原理图

logg框架的整体流程如图（作者原图）：

其他

对Log信息的设置与过滤：

Filter：编辑默认或者自定义的标签，过滤标签以外的信息；

Disable：设置user soft wraps，即设置换行

Setting：设置log头部的信息，比如时间、线程PID、包名、TAG等开关设置

好了，对于Logger框架的介绍就到这里了。有时会更新，记得使用时看看GitHub升级了没有，同时在使用是否和以前兼容。对于一些其他的方法，可以直接看源码，具体是干什么用的。

如果能帮你，可以顶顶支持下，感谢++

M-Ellen

关注

18
点赞
踩
32

收藏

觉得还不错? 一键收藏
15
评论
android日志框架Logger的详细使用（目前最新版2.1.1）

前言在开发过程中，log日志是每个人多会用上的。平时在开发大项目的时候，几乎每个类多需要加log，然而在发布之前，要求全部删除，真是累。因为系统log暂时没有统一管理的方法。还有就是，特别是在调试的时候，对于线程并发或者子线程的调试，还是加log调试比较精确，用debug工具调试经常和实际不符合。那么，如果使用系统log，调试完又得找出来删除，累++。作为程序猿，这种笨方法肯定是会鄙视的。...
复制链接

扫一扫

专栏目录