Timber 进阶用法

前言

本篇文章专注于 Timber 的进阶用法，包含一些稍微基础的但有用的用法简介，也包含一些自定义类实现不同的日志操作功能简介。
如果还有不熟悉 Timber 的，可以先阅读下我前面写的一篇文章：Timber 源码解析

• tag用法简介

tag() 的一般用法就是：Timber.tag("tag").d("message")，但是，前面我们分析源码知道，Timber 中 tag 是用 ThreadLocal 存储的，也就是 tag 是区分线程的，更坑爹的是，tag 的设置是一次性行为，也就是说，当你使用 getTag() 时候，获取成功后，这个 tag 也就被删除了。所以，当你想实现一个常量 tag 时，你只能按如下的方法进行输出：

Timber.tag("hello").d("one");
Timber.tag("hello").d("two");
Timber.tag("haha").d("three");

吐槽：其实我不是很明白为什么 Jake Wharton 要把 tag 设置成线程区分，感觉没什么意义；而且 tag 是设置给所有树的，那么当我们只想在一条线程进行 tag 设置时，其他线程的下一个日志输出也会被强制输出前面设置的 tag，而这却是我们不想要的行为，总之，我感觉 Timber 的 tag 设置是有待商榷的。当然，我们可以在实现自定义Tree 时，忽略父类 tag 设置行为，说到这里，我又要吐槽一下，因为 Tree.getTag() 是一个包级访问权限，这也就是说我们没办法在其他包目录对 getTag() 进行复写，改变它的行为 -_-，有点坑。

public static abstract class Tree {
    final ThreadLocal explicitTag = new ThreadLocal<>();

    String getTag() {
      String tag = explicitTag.get();
      if (tag != null) {
        explicitTag.remove();
      }
      return tag;
    }

前面的路走不通，那我们只能另寻他路，办法总比困难多嘛!通过查看源码我们可以知道，tag() 函数设置的 tag 最终被传递给 Tree的纯虚函数 log()里面。

 protected abstract void log(int priority, String tag, String message, Throwable t);

所以，我们在实现 Tree 子类时，忽略这个 tag 就相当于忽略了父类的 tag 行为，然后，实现我们自己想要的 tag 行为就行了。

进阶用法：1. 常量 Tag 实现

比如，我们想实现一个常量 tag 功能，使我们能只进行一个 tag 设置，就能一直使用，其不区分线程，不区分类····，使我们调用能像下面代码所示一样：

Timber.plant(new ConstTagTree().setTag("ConstTag"));
Timber.v("watch the tag"); //tag == "ConstTag"
Timber.v("watch the tag haha");//tag == "ConstTag"
Timber.v("watch the tag hehe");//tag == "ConstTag"

实现这个代码很简单，子类提供一个 setTag(String tag) 函数，复写父类 log() 函数时，使用前面 setTag(String tag) 的值就行了。
详细代码可以查看：ConstTagTree
ConstTagTree 实现了常量 tag设置，如果没有设置 tag，默认以调用者类名作为 tag。
使用方法如下：

Timber.plant(new ConstTagTree().setTag("ConstTag")); //set const tag
//Timber.plant(new ConstTagTree()); //const tag not set,uses class name instead.
Timber.w("Application haha");    

进阶用法：2. Release版本调试：ReleaseTree

我们知道，Timber 默认已经为我们实现了一个调试版本的日志记录类：DebugTree，但是 Release 版本的未提供。那么我们就自己实现一个 Release版本的日志记录类：ReleaseTree。
ReleaseTree 主要用于 Release 版本日志记录，并且只记录 warn,error,wtf 信息的日志。

public class ReleaseTree extends Timber.DebugTree {
    @Override
    protected boolean isLoggable(String tag, int priority) {
        return priority == Log.WARN
                || priority == Log.ERROR
                || priority == Log.ASSERT;
    }
}

好了，就是这么简单，整个 ReleaseTree 的完整代码就是上面所示。
可以看到，ReleaseTree 是继承了 DebugTree ，因此也就拥有了不设置 tag 就自动使用调用者类名作为 tag 的功能，不过，Release 集成 Debug 这个继承关系其实给人的感觉是不太友好的，这两者没有继承关系这个概念（这里使用继承仅仅是为了使用到自动类名 tag 这个功能，与继承没有直接关系），但是，还是上面那个问题，由于 Timber 中 Tree.getTag() 是包级权限，子类没办法获取，也就是没办法复写 tag 的行为，那我们只能采用继承的方法获取同个包级下的 DebugTree 的 tag 功能了。
ReleaseTree 的代码详见：ReleaseTree

进阶用法：3. 文件日志记录功能：FileTree

很多情况下，当我们的app运行在裸机上时，我们没办法直接获取到app运行日志信息，那么，将app运行日志信息保存到文件中或许就是一个良好的解决方法，通过查看文件日志，我们就可以看出app运行中哪个方面出现了问题，这在项目中应该是非常有用处的。
那下面我们就来实现一个简单的 FileTree：FileTree
FileTree 代码相对较多，这里就不进行展示了，我们这里就看下使用方法：

String path = Environment.getExternalStorageDirectory().getAbsolutePath();
Timber.plant(new FileTree().name("FileTree.txt").storeAt(path));
Timber.v("log in file"); //this will be store in file

进阶用法：4. 集成其他日志框架

上面我们所介绍的都是通过自己直接或间接地继承 Tree 来实现我们所需要的日志操作功能，如果你觉得自己去实现这些日志操作太麻烦，一件值得高兴的事，由于 Timber 其实是一个封装日志操作的一个框架，不涉及具体功能的实现，所以，基于这样的架构设计，我们就可以在 Github 上找到一些具体的执行日志操作功能的项目，然后种植到 Timber 中就行了。
这里，我随便找一份日志操作项目：Logger
很凑巧的是，该库本身就考虑到集成到 Timber 中来，其 ReadMe.md 中就给我们直接指出了集成方法：

// Set methodOffset to 5 in order to hide internal method calls
Timber.plant(new Timber.DebugTree() {
  @Override protected void log(int priority, String tag, String message, Throwable t) {
    Logger.log(priority, tag, message, t);
  }
});

进阶用法：5. 多 Tag 功能实现：MultiTagTree

有些时候，我们希望日志输出既包含类名，也包含我们自定义的其他 tag，这样做的好处是一方面我们可以只关注部分日志（通过类名过滤），另一方面，我们也希望能查看一下完整的日志（通过自定义 tag 过滤）。
我这边的实现思路是将自定义 tag 插入到 原来的 tag 前面，并以分隔符“-”进行分割。

public class MultiTagTree extends Timber.DebugTree {
    private static final String SEPARATOR = "-";
    private List mTags = new CopyOnWriteArrayList<>();

    @Override
    protected void log(int priority, String tag, String message, Throwable t) {
        String newTag = produceTag(tag);
        super.log(priority, newTag, message, t);
    }

    //override this method to produce your own multi tag
    protected String produceTag(String originTag) {
        StringBuilder builder = new StringBuilder();
        for (int i = 0, lenth = mTags.size(); i < lenth; ++i) {
            builder.append(mTags.get(i))
                    .append(i != lenth - 1 ? SEPARATOR :
                            (originTag == null ? "" : SEPARATOR + originTag));
        }
        return builder.toString();
    }
···
详细代码可查看：[MultiTagTree]
···
}

Timber.plant(new MultiTagTree().addTag("Whyn111")); //then the tag is like "Whyn111-MainActivity"

这样，我们就可以实现多 tag 功能。

最后，附上本章源码：TimberExtendedDemo