Android轻量级日志管理框架

谁践踏了优雅 2022-05-29 13:08 267阅读 0赞

> 代码地址如下：  
> [http://www.demodashi.com/demo/12134.html][http_www.demodashi.com_demo_12134.html]

# ViseLog #

Android 轻量级日志框架，使用森林对象维护不同的日志树进行日志输出，可以是Logcat树、文件树等，支持Bundle、Intent、Reference、Throwable、Map、Collection、JSON、Xml等格式化的输出。

*  项目引用：`compile 'com.vise.xiaoyaoyou:viselog:1.1.2'`

## 功能介绍 ##

1、在Logcat中完美的格式化输出，能很好的过滤手机和其他App的日志信息；

2、包含线程、类、方法信息，可以清楚地看到日志记录的调用堆栈；

3、支持跳转到源码处；

4、支持格式化输出JSON、XML格式信息；

5、支持List、Set、Map和数组的格式化输出；

6、支持系统对象如Bundle、Intent、Reference和Throwable的格式化输出；

7、支持自定义对象的格式化输出；

8、支持字符串格式化后输出；

9、支持自定义对象解析器；

10、支持自定义日志输出树，如输出到文件的树等。

## 项目结构 ##

![项目结构][M8yXxro9whaxJe36p4j.png]

## 使用介绍 ##

使用前需要进行日志的配置初始化及日志树的添加，默认实现了打印到Logcat的日志树，但需要在应用启动时进行添加，这样才能将日志信息打印到Logcat中。一般需要在自定义Application的OnCreate方法中进行如下配置：

ViseLog.getLogConfig()
        .configAllowLog(true)//是否输出日志
        .configShowBorders(true)//是否排版显示
        .configTagPrefix("ViseLog")//设置标签前缀
        .configFormatTag("%d{HH:mm:ss:SSS} %t %c{-5}")//个性化设置标签，默认显示包名
        .configLevel(Log.VERBOSE)；//设置日志最小输出级别，默认Log.VERBOSE
    ViseLog.plant(new LogcatTree());//添加打印日志信息到Logcat的树

1、打印基本信息

ViseLog.d("test message");

![这里写图片描述][SouthEast]

2、打印基本对象

ViseLog.d(new Boolean(true));

![这里写图片描述][SouthEast 1]

3、打印Bundle对象

ViseLog.d(new Bundle());

![这里写图片描述][SouthEast 2]

4、打印Intent对象

ViseLog.d(new Intent());

![这里写图片描述][SouthEast 3]

5、打印Reference对象

ViseLog.d(new SoftReference(0));

![这里写图片描述][SouthEast 4]

6、打印Throwable对象

ViseLog.e(new NullPointerException("this object is null!"));

![这里写图片描述][SouthEast 5]

7、打印List集合

List<String> list = new ArrayList<>();
    for (int i = 0; i < 5; i++) {
        list.add("test" + i);
    }
    ViseLog.d(list);

![这里写图片描述][SouthEast 6]

8、打印Map集合

Map<String, String> map = new HashMap<>();
    for (int i = 0; i < 5; i++) {
        map.put("xyy" + i, "test" + i);
    }
    ViseLog.d(map);

![这里写图片描述][SouthEast 7]

9、打印JSON字符串

String json = "{'xyy1':[{ 'test1':'test1'},{ 'test2':'test2'}],'xyy2':{
       'test3':'test3','test4':'test4'}}"; ViseLog.json(json);

![这里写图片描述][SouthEast 8]

10、打印XML字符串

String xml = "<xyy><test1><test2>key</test2></test1><test3>name</test3><test4>value</test4></xyy>";
    ViseLog.xml(xml);

![这里写图片描述][SouthEast 9]

## 核心功能讲解 ##

1、森林结构  
其核心思想是将日志系统看成一个森林对象统一进行维护，森林可以添加树和移除树，只有添加了指定的功能树才会有日志输出。日志功能由ITree接口进行定义，统一由主干树SoulsTree来分配，并将日志输出功能提供给上层实现，默认已经实现了日志打印到Logcat的树DefaultTree。

2、自定义解析器  
实现Parser接口，并实现parseClassType()和parseString()方法，再通过addParserClass()配置到ViseLog就行，详细可参考文档[自定义对象打印器][Link 1]；

3、个性标签设置详解

<table> 
 <thead> 
  <tr> 
   <th>变量</th> 
   <th>简写</th> 
   <th>描述</th> 
   <th>参数</th> 
   <th>示例</th> 
   <th>输出结果</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>%%</td> 
   <td>无</td> 
   <td>转义%</td> 
   <td>无</td> 
   <td>%%d</td> 
   <td>%d</td> 
  </tr> 
  <tr> 
   <td>%date</td> 
   <td>%d</td> 
   <td>当前时间</td> 
   <td>格式化时间,如HH:mm:ss</td> 
   <td>%d{HH:mm:ss:SSS}</td> 
   <td>22:12:12:112</td> 
  </tr> 
  <tr> 
   <td>%thread</td> 
   <td>%t</td> 
   <td>当前线程名称</td> 
   <td>无</td> 
   <td>%t</td> 
   <td>thread-112</td> 
  </tr> 
  <tr> 
   <td>%caller</td> 
   <td>%c</td> 
   <td>线程信息和类路径</td> 
   <td>一般用%c{-5}就好了，用法为%c{整数}或者%caller{整数}，整数为包名路径，如路径为com.vise.logapp.MainActivity.onCreate(MainActivity.java:108),%c{1}输出com，以.分割的第一个,如果小于0就是排除前面n个，如%c{-1},vise.logapp.MainActivity.onCreate(MainActivity.java:135)</td> 
   <td>%c{-3}</td> 
   <td>MainActivity.onCreate(MainActivity.java:108)</td> 
  </tr> 
 </tbody> 
</table>

4、日志配置详解

<table> 
 <thead> 
  <tr> 
   <th>方法</th> 
   <th>描述</th> 
   <th>取值</th> 
   <th>缺省</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>configAllowLog</td> 
   <td>是否允许日志输出</td> 
   <td>boolean</td> 
   <td>true</td> 
  </tr> 
  <tr> 
   <td>configTagPrefix</td> 
   <td>日志log的前缀</td> 
   <td>String</td> 
   <td>“ViseLog”</td> 
  </tr> 
  <tr> 
   <td>configShowBorders</td> 
   <td>是否显示边界</td> 
   <td>boolean</td> 
   <td>false</td> 
  </tr> 
  <tr> 
   <td>configLevel</td> 
   <td>日志显示最小等级</td> 
   <td>Log</td> 
   <td>Log.VERBOSE</td> 
  </tr> 
  <tr> 
   <td>addParserClass</td> 
   <td>自定义对象打印</td> 
   <td>Parser</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td>configFormatTag</td> 
   <td>个性化设置Tag</td> 
   <td>String</td> 
   <td>%c{-5}</td> 
  </tr> 
 </tbody> 
</table>

Android轻量级日志管理框架

> 代码地址如下：  
> [http://www.demodashi.com/demo/12134.html][http_www.demodashi.com_demo_12134.html]
> 
> 注：本文著作权归作者，由demo大师发表，拒绝转载，转载需要作者授权

[http_www.demodashi.com_demo_12134.html]: http://www.demodashi.com/demo/12134.html
[M8yXxro9whaxJe36p4j.png]: /images/20220529/53bae5ec8155405cb793cf2846880f2d.png
[SouthEast]: /images/20220529/2df2179fc74f4c77afac4844fa5ba999.png
[SouthEast 1]: /images/20220529/077b5c229f614efba33ab065a6e2ba29.png
[SouthEast 2]: /images/20220529/e4012a5dd3ef480ab62fe1411d2eb8aa.png
[SouthEast 3]: /images/20220529/f3257c1b2dc54129b43b1f0312ae2177.png
[SouthEast 4]: /images/20220529/d906b5f21b5c4a909cac45762f29e89b.png
[SouthEast 5]: /images/20220529/fa5000d5de114814aa77cf146cee1a71.png
[SouthEast 6]: /images/20220529/61b53050d5fa49b59822f86d3d985ac4.png
[SouthEast 7]: /images/20220529/4da6f7e2ab0347169ab53e4aa7abc4d7.png
[SouthEast 8]: /images/20220529/a1c9e85710b14e57a56ea4337d169db7.png
[SouthEast 9]: /images/20220529/89b488dcf14941229455bfdde774ac31.png
[Link 1]: https://github.com/pengwei1024/LogUtils/blob/master/doc/custom_parser.md