Log日志框架 logger13k Timber 9.1k

因此需要找一个更好的log库。以下两个都是非常好的。
https://github.com/orhanobut/logger ：简单、漂亮、强大的12929 Star  13k
https://github.com/JakeWharton/timber ：基于Android原生Log的logger，小巧易扩展。

首先Timber使用:

面临问题

1. 项目使用Log规范不统一，例如：关于okhttp的实现使用了Logging Interceptor输出log，关于rxjava的实现使用了onError，其他使用了Android Log机制
2. 项目开发时，为了方便调试，需要输出Log，但发布后，Log中包含很多项目相关的信息，如果全部暴露会有安全隐患，但完全删除也不利于发生问题后的查看调试，因此需要一个开关，关闭开关则不能输出log，打开开关则可以输出log

Timber 介绍

Timeber的使用主要通过添加Tree实例，添加Tree实例可以通过方法Timber.plant完成。实例化Tree需要尽量早，推荐在项目Application的```onCreate()````方法中完成。

其中，DebugTree自动实例化，是Timber中已经实现了tree的类，可直接拿来用，并在使用他的类中以类名为其TAG，但是其他的Tree不会自动实例化，需要进行手动实现扩展Timber.Tree实现。

下载

在build.gradle中

compile 'com.jakewharton.timber:timber:4.5.1'

注册

在onCreate()中

if (BuildConfig.DEBUG) {
      Timber.plant(new Timber.DebugTree());
 } else {
      Timber.plant(new CrashReportingTree());
}

private static class CrashReportingTree extends Timber.Tree {
    @Override 
     protected void log(int priority, String tag, String message, Throwable t) {

     }
}

使用

Timber.tag("activityName");
Timber.d("Activity Created");

好处

• 不再重复使用TAG。之前使用Log方法每次使用都需要定义并传入一个TAG，在Timber中，若使用DebugTree，默认为当前类类名，若使用自定义Tree，直接定义一次，到处使用，不需重复设置
• 在打Timber调用处，不仅可以只输出Log，还可以执行其他操作。比如：存到数据库，进行输出，Socket传输，甚至显示到UI界面上等，只需要自定义Tree，并将对应逻辑在log(int priority, String tag, String message, Throwable t)方法中实现
• 统一项目Log日志方法，输出形式，输出时间，更加符合面向对象思想

isLoggable 方法作为开关控制Log输出

语法

boolean isLoggable (String tag, int level)

通过指定标签指定级别，控制日志是否显示。默认级别为Info，表示高于或等于Info级别的日志都可以显示。

设置

1. 远程设置系统属性更改默认级别

adb -d shell setprop log.tag.<YOUR_LOG_CAT> <LEVEL>

1. 系统目录/data/local.prop，创建一个local.prop文件，文件内容：

log.tag.<YOUR_LOG_TAG>=<LEVEL>

Level级别

LEVEL	NUMBER
VERBOSE	2
DEBUG	3
INFO	4
WARN	5
ERROR	6
ASSERT	7

例子

在自定义Tree中的log方法中进行控制，若为Debug环境下，可以产出log；若为Release环境，且打开开关，则可以产生log；若为Release环境，且关闭开关，则不可产生log。

1. Java代码如下

   

    

2. 命令行中

若执行如下命令，则打开开关，可以产生log

adb -d shell setprop log.tag.MyTag DEBUG

若执行如下命令，则关闭开关，不可产生log

adb -d shell setprop log.tag.MyTag WARN

开源日志库Logger的使用

日志对于开发来说是非常重要的，不管是调试数据查看、bug问题追踪定位、数据信息收集统计，日常工作运行维护等等，都大量的使用到。

---

今天介绍著名开源日志库Logger的使用，库的地址：https://github.com/orhanobut/logger
在Android Studio中的gradle中加入，就可以引用依赖logger库：

dependencies {
  compile 'com.orhanobut:logger:1.15'
}

Logger库能提供的功能

• 线程的信息
• 类的信息
• 方法的信息
• 格式打印json、xml等
• 点击链接跳转到源码打印处

Logger的使用

使用非常简单：

String userName = "Jerry";
Logger.i(userName);

打印的效果：

 

日志效果

这个效果格式是不是很清晰，可以看到，当前打印处的线程名、方法名、方法位置、打印的信息。同时点击方法的位置还可以跳转到打印的位置，这样调试起来就非常的方便了。

可以看到上图打印的TAG是PRETTYLOGGER，这个是Logger默认的tag，如果要修改可以：

// 修改打印的tag值
Logger.init("MainActivity");
String userName = "Jerry";
Logger.i(userName);

 

修改tag的日志效果

有的小伙伴觉得，我不想一直都只用一个tag，那岂不是要写很多的Logger.init(tag)来修改，我们看方法名叫init，作者的意思估计是只用一次就好了。下面可以通过：

Logger.init("MainActivity");
String userName = "Jerry";
Logger.i(userName);
// 给当前打印的换一个单独的tag名
Logger.t("App").i(userName);
Logger.e(userName);

 

单独修改的tag打印效果

从图上可以看出，使用Logger.t(tag)这个方法就修改了tag，而且还不会影响后面其它的打印的tag，是不是灵活又方便呢。
我们继续看，我们都知道android自带的Log日志，是无法直接打印除了字符串以为的值或变量对象的。

 

系统自带的打印int，报错

有的时候确实挺麻烦，还得可以拼接成字符串来打印（宝宝(づ｡◕‿‿◕｡)づ心理的苦身为Android攻城狮都体会过），强大的Logger可以办到：

 

Logger.i("大家好，我叫%s，今年%d，很高兴大家来看我的文章！！！", "Jerry", 18);

拼接int数值打印效果

学过C语言的应该都知道：printf("age: %d", 16)这样的打印函数，是不是有似曾相识的感觉。再来改改：

Logger.t("你特么才16岁么").i("大家好，我叫%s，今年%d岁，很高兴大家来看我的文章！！！", "Jerry", 16);

 

可怜的日志君，有种被玩坏的感觉

除了这些，Logger还可以打印很多形式的数据，极大的方便了我们的开发：

Logger.d("hello");
Logger.e("hello");
Logger.w("hello");
Logger.v("hello");
Logger.wtf("hello");
// 打印json格式
String json = createJson().toString();
Logger.json(json);
// 打印xml格式
Logger.xml(XML_CONTENT);
// 打印自定义级别、tag、信息等格式日志
Logger.log(DEBUG, "tag", "message", throwable);

// 创建json数据
private JSONObject createJson() {    
    try {        
        JSONObject person = new JSONObject(); 
        person.put("phone", "12315");
        JSONObject address = new JSONObject();       
        address.put("country", "china");
        address.put("province", "fujian");       
        address.put("city", "xiamen");   
        person.put("address", address);
        person.put("married", true);        
        return person;    
    } catch (JSONException e) {        
        Logger.e(e, "create json error occured");    
    }    
    return null;
}

 

漂亮的json格式打印效果

关于打印json，还有个小插曲，博主第一次使用的时候，半天没有出效果，没打印出来，于是我改成了DDMS的Logcat，还是一样。后来去跟踪源码，看Logger.json()是怎么打印的，源码最终是使用系统的Log.d(tag, msg)来打印的。于是博主用打断点debug，发现上图格式的所有字符串都有传入到Log.d的msg中，就是不打印（心累），于是我直接：

Log.d("MainActivity", "onActivityCreated: log.d跑哪里去了...");

日志还是不显示，这就说明有可能是我的魅族MX4手机的问题，Google了一下，果然有说魅族手机Log.d()日志不打印的问题，是因为魅族默认不开启Debug模式的日志打印，需要在开发者选项---高级日志输出---选择全部允许（参考解决文章：http://blog.csdn.net/u013175701/article/details/51428870），至此日志打印出来了。
Logger库还针对显示可以自己自定义：

Settings setting = Logger.init("MainActivity");
setting.logLevel(LogLevel.FULL) //  显示全部日志，LogLevel.NONE不显示日志，默认是Full   
     .methodCount(5)         //  方法栈打印的个数，默认是2        
     .methodOffset(0)        //  设置调用堆栈的函数偏移值，0的话则从打印该Log的函数开始输出堆栈信息，默认是0
     .hideThreadInfo();      //  隐藏线程信息
     .logAdapter(new AndroidLogAdapter());// 自定义一个打印适配器，这里适配了Android的Log打印，你也可以自己实现LogAdapter接口来做一些特殊需求的日志打印适配

 

自定义日志显示

线程显示隐藏了，方法栈显示的偏移量为0，表示从打印的Log的地方开始算方法数的5个堆栈内的方法都打印出来。

打印数组、List、map等对象数据

String[] names = {"Jerry", "Emily", "小五", "hongyang", "七猫"};
Logger.d(names);  // 打印字符数组
List<User> users = new ArrayList<>();
for (int i = 0; i < names.length; i++) {    
    User user = new User(names[i], 10 + i);
    users.add(user);
}
Logger.d(users);  // 打印List

class User {    
    private String name;    
    private int age;    
    public User(String name, int age) {        
        this.name = name;        
        this.age = age;    
    }    
    public String getName() {        
        return name;    
    }    
    public void setName(String name) {        
        this.name = name;    
    }    
    public int getAge() {        
        return age;    
    }    
    public void setAge(int age) {        
        this.age = age;    
    }    
    // 要覆写对象的toString方法才可以打印出完整的日志信息
    @Override    
    public String toString() {        
      return "User{" +                
          "name='" + name + '\'' +                
          ", age=" + age +                
          '}';   
    }
  }

 

打印字符数组和List（User没有覆写toString）

 

打印字符数组和List（User已经覆写toString）

---

至此，Logger库的使用介绍算告一段落，还有什么好玩的，细节的使用方式，小伙伴有更好的建议的欢迎留言！感谢您的观看！！！