前言
在开发过程中,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.导入依赖
1 | compile 'com.orhanobut:logger:2.1.1' |
1 | Logger.addLogAdapter(new AndroidLogAdapter()); |
注:如果在Application中初始化,记得修改 AndroidManifest.xml 中 application 标签属性,添加 android:name=”.MyApplication” ,不然不会打印。
3.使用
1 | Logger.d("hello"); |
如图:
当然,如果还有追求,继续往下看看它的其他功能。
支持的数据类型
普通类型
1 | public void testNormal(){ |
Format类型
1 | public void testFormat(){ |
集合类型
首先看看List:
1 | List list = new ArrayList(); |
1 | Log.d(TAG, list.toString()); |
首先是调用:
1 | public void d(Object object) { |
1 | public static String toString(Object object) { |
这样就不需要我们自己调用toString(),直接可以打印了。
其他的数据结构也是一样的,看图就可以了:
1 | public void testCollections(){ |
*注:打印集合的时候,特别是数组时,前面不要添加其他字符,如:Logger.d(“数组集合”+strs);这样会把整体当做一个参数,导致判断错误,不能正常输出数组类型。其次是,作者提示,打印集合时,使用DEBUG等级。*
JSON数据
1 | public void testJson(){ |
XML数据
1 | public void testXml() { |
修改默认配置
最新版修改配置,和旧版也是有不同,如下:
1 | FormatStrategy formatStrategy = PrettyFormatStrategy.newBuilder() |
具体配置大家可以自行去实践下。一般默认就可以了,这里说下,修改全局的TAG,和局部的TAG。
1.修改全局的TAG,在初始化的application中修改,如:
1 | FormatStrategy formatStrategy = PrettyFormatStrategy.newBuilder() |
2.修改局部的TAG,哪里打印就在哪里修改,只对当前打印有效,如:
1 | public void testNormal(){ |
*注:如果尝试用局部的方法,在application初始化时修改。当然,这是有效果的,但只能用一次,其他打印还是会用全局的,可自行测试。*
控制打印开关
这个功能是最喜欢的了,当我们发布软件,或者太多的log影响性能,那么就可以关闭logger打印,在application初始化的地方:
1 | Logger.addLogAdapter(new AndroidLogAdapter() { |
通过适配器控制打印,只要覆盖isLoggable()方法,返回BuildConfig.DEBUG即可。这样子,log就不再打印出来了。
*注:返回值导入的包是:import com.orhanobut.logger.BuildConfig; 有时顺手导入:com.gotechcn.frameworks,那就没有效果。*
保存log到文件
1 | Logger.addLogAdapter(new DiskLogAdapter()); |
通过打印,找到保存的路径: /storage/emulated/0
但手机里面就是没有这个文件夹,不知道什么原因,真机和模拟机多没有,知道可以留言噢,感谢!
工作流程原理图
logg框架的整体流程如图(作者原图):
其他
对Log信息的设置与过滤:
Filter:编辑默认或者自定义的标签,过滤标签以外的信息;
Disable:设置user soft wraps,即设置换行
Setting:设置log头部的信息,比如时间、线程PID、包名、TAG等开关设置
好了,对于Logger框架的介绍就到这里了。有时会更新,记得使用时看看GitHub升级了没有,同时在使用是否和以前兼容。对于一些其他的方法,可以直接看源码,具体是干什么用的。