Timber 进阶用法

前言

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

  • tag用法简介

tag() 的一般用法就是:Timber.tag("tag").d("message"),但是,前面我们分析源码知道,Timbertag 是用 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,而这却是我们不想要的行为,总之,我感觉 Timbertag 设置是有待商榷的。当然,我们可以在实现自定义Tree 时,忽略父类 tag 设置行为,说到这里,我又要吐槽一下,因为 Tree.getTag() 是一个包级访问权限,这也就是说我们没办法在其他包目录对 getTag() 进行复写,改变它的行为 -_-,有点坑。

public static abstract class Tree {
    final ThreadLocal<String> 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 这个功能,与继承没有直接关系),但是,还是上面那个问题,由于 TimberTree.getTag() 是包级权限,子类没办法获取,也就是没办法复写 tag 的行为,那我们只能采用继承的方法获取同个包级下的 DebugTreetag 功能了。
ReleaseTree 的代码详见:ReleaseTree

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

很多情况下,当我们的app运行在裸机上时,我们没办法直接获取到app运行日志信息,那么,将app运行日志信息保存到文件中或许就是一个良好的解决方法,通过查看文件日志,我们就可以看出app运行中哪个方面出现了问题,这在项目中应该是非常有用处的。
那下面我们就来实现一个简单的 FileTreeFileTree
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<String> 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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,132评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,802评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,566评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,858评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,867评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,695评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,064评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,705评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,915评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,677评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,796评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,432评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,041评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,992评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,223评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,185评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,535评论 2 343

推荐阅读更多精彩内容