Android 常用三种日志框架[Logger、Timber、XLog]

2024-09-02 23:36

本文主要是介绍Android 常用三种日志框架[Logger、Timber、XLog],希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

一、日志框架背景

如果我们需要用三方库,那就意味着基于原生方案会存在一些痛点,我们不得不使用某种手段去解决这些痛点。那原生 Logcat 存在哪些痛点,我们来聊一聊:

  • 日志不能持久化,缓冲区日志很容易丢失
  • 如果系统压力大有可能会导致日志折叠、丢失
  • 无法定义日志输出格式,如:json、xml
  • 无法快速定位日志输出时的代码位置
  • 其实前两个才是主要痛点,日志不丢失,有途径能获取到已打印的日志这是我们最基础的需求。只要日志不丢失,其他问题说实话都可以克服。

二、期望日志框架能力

  • 方案轻量,入侵度越低越好
  • 集成方便、快捷,不应该在集成日志库上花费太多时间
  • 日志留存,至少可以存储到本地磁盘
  • 文件策略管理,处理文件备份、删除等策略
  • 输出格式规整,最好能自定义输出格式
  • 方便筛选,可根据日志级别、标签筛选
  • 代码位置定位,可从 IDE 直接调到相关代码位置
  • 配置丰富,给开发者高度的自由

三、框架介绍

这里主要说下XLog的用法,也是博主目前在项目中采用的日志框架,其他两种如果需要,自行研究,这里简单介绍。

1、Logger

Logger orhanobut/logger是一个比较早期的日志框架,积累到现在的人气超高,拥有将近 14K 的 Star。这个库非常轻量,满打满算整个库只有 13 个类

日志输出格式还是挺好看的,可以直接输出 Collection、json、xml 类型数据,但是不能自定义输出格式。 日志可以保存到磁盘,但不能配置文件相关策略(文件名、备份、删除等),可以理解为,有存储文件功能,但不多。

前面也提到,这个框架非常轻量,只有十多个类,它可以满足我们基本的日志需求,将日志保存到文件,且不会丢失。日志输出格式也还不错。但相对而言,对于个性化的支持就比较欠缺了。比如,输出格式是不能简单自定义的,比如我如果只想输出一行日志,不输出表格线,那就会比较麻烦。

2、Timber

Timber JakeWharton/timber是 Jake Wharton 大神出品。他原话是:老是要把打日志这部分代码拷来拷去太麻烦了,所以以库的形式开源出来。Timber 与其他日志库不太一样的是它并没有提供很多功能,而是搭建了一个日志功能框架,大家可以按照自己的需求来构建自己的Tree

前面我们说 Logger 库很简单只有十几个类,而 Timber 更简单,只有一个类文件,使用 Kotlin 语言。不过这些代码主要是框架代码,只有一个实现类DebugTree用来实现原生控制台输出日志,可以自已自定义输出格式,可以不用指定 TAG,默认 TAG 为类名.

注:如果你需要将日志输出到文件的实现,那这个库是不支持的。它可以将日志多种输出形式集中成Tree,通过Forest去统一管理

3、XLog

轻量、美观强大、可扩展的 Android 和 Java 日志库,可同时将日志打印在如 Logcat、Console 和文件中。如果你愿意,你可以将日志打印到任何地方。

https://github.com/elvishew/xLog

日志格式与 Logger 还是挺像的,不同的是 XLog 可以自定义输出格式,Logger 不行。就比如这些花里胡哨的 boder,在 XLog 里可以方便配置,而 Logger 则麻烦不少。

常用日志配置:

java
复制代码
LogConfiguration config = new LogConfiguration.Builder().logLevel(BuildConfig.DEBUG ? LogLevel.ALL             // 指定日志级别,低于该级别的日志将不会被打印,默认为 LogLevel.ALL: LogLevel.NONE).tag("MY_TAG")                                         // 指定 TAG,默认为 "X-LOG".enableThreadInfo()                                    // 允许打印线程信息,默认禁止.enableStackTrace(2)                                   // 允许打印深度为 2 的调用栈信息,默认禁止.enableBorder()                                        // 允许打印日志边框,默认禁止.jsonFormatter(new MyJsonFormatter())                  // 指定 JSON 格式化器,默认为 DefaultJsonFormatter.xmlFormatter(new MyXmlFormatter())                    // 指定 XML 格式化器,默认为 DefaultXmlFormatter.throwableFormatter(new MyThrowableFormatter())        // 指定可抛出异常格式化器,默认为 DefaultThrowableFormatter.threadFormatter(new MyThreadFormatter())              // 指定线程信息格式化器,默认为 DefaultThreadFormatter.stackTraceFormatter(new MyStackTraceFormatter())      // 指定调用栈信息格式化器,默认为 DefaultStackTraceFormatter.borderFormatter(new MyBoardFormatter())               // 指定边框格式化器,默认为 DefaultBorderFormatter.addObjectFormatter(AnyClass.class,                    // 为指定类型添加对象格式化器new AnyClassObjectFormatter())                     // 默认使用 Object.toString().addInterceptor(new BlacklistTagsFilterInterceptor(    // 添加黑名单 TAG 过滤器"blacklist1", "blacklist2", "blacklist3")).addInterceptor(new MyInterceptor())                   // 添加一个日志拦截器.build();Printer androidPrinter = new AndroidPrinter(true);         // 通过 android.util.Log 打印日志的打印器
Printer consolePrinter = new ConsolePrinter();             // 通过 System.out 打印日志到控制台的打印器
Printer filePrinter = new FilePrinter                      // 打印日志到文件的打印器.Builder("<日志目录全路径>")                             // 指定保存日志文件的路径.fileNameGenerator(new DateFileNameGenerator())        // 指定日志文件名生成器,默认为 ChangelessFileNameGenerator("log").backupStrategy(new NeverBackupStrategy())             // 指定日志文件备份策略,默认为 FileSizeBackupStrategy(1024 * 1024).cleanStrategy(new FileLastModifiedCleanStrategy(MAX_TIME))     // 指定日志文件清除策略,默认为 NeverCleanStrategy().flattener(new MyFlattener())                          // 指定日志平铺器,默认为 DefaultFlattener.writer(new MyWriter())                                // 指定日志写入器,默认为 SimpleWriter.build();XLog.init(                                                 // 初始化 XLogconfig,                                                // 指定日志配置,如果不指定,会默认使用 new LogConfiguration.Builder().build()androidPrinter,                                        // 添加任意多的打印器。如果没有添加任何打印器,会默认使用 AndroidPrinter(Android)/ConsolePrinter(java)consolePrinter,filePrinter);

XLog 的配置非常丰富、灵活,所以它比前两个库类要多一些,50+左右,也算非常轻量。如果你不想自定义配置,只需要XLog.init(LogLevel.ALL);即可完成初始化,全部使用 XLog 缺省配置。

XLog 的配置非常多,主要分为几大类,我们来看下配置接口的目录结构:

arduino
复制代码
├── formatter  
│ ├── Formatter.java  // 日志输出格式化接口
│ ├── border  
│ │ └── BorderFormatter.java  // 装饰线格式化接口
│ ├── message  
│ │ ├── json  
│ │ │ └── JsonFormatter.java  // json 格式化接口
│ │ ├── object  
│ │ │ └── ObjectFormatter.java  // 对象格式化接口
│ │ ├── throwable  
│ │ │ └── ThrowableFormatter.java  // 异常格式化接口
│ │ └── xml  
│ │ └── XmlFormatter.java  // xml 格式化接口
│ ├── stacktrace  
│ │ └── StackTraceFormatter.java  // 堆栈格式化接口
│ └── thread  
│ └── ThreadFormatter.java  // 线程id、name 输出格式化
├── interceptor  
│ └── Interceptor.java  // 拦截器
└── printer  
│ └── Printer.java //日志输出接口  
├── file  
│ ├── backup  
│ │ ├── BackupStrategy.java  // 日志备份策略接口
│ │ └── BackupStrategy2.java  
│ ├── clean  
│ │ └── CleanStrategy.java  // 日志清除策略接口  
│ ├── naming  
│ │ └── FileNameGenerator.java  // 文件命名接口
│ └── writer  
│   └── Writer.java  // 文件输入接口
└── flattener  └── LogFlattener.java // 日志字段排列接口

配置主要分为以下几类:

  • 日志打印
  • 日志格式化
  • 文件输入
  • 文件备份策略
  • 文件清除策略
  • 日志字段排列

 XLog 的架构思想与 Timber 差不多是一致的,日志框架基于功能接口管理所有日志输出,框架本身的日志输出实现一样是基于框架定义的接口。不同的是,XLog 接口定义得更细致,有二十多个接口。同时,框架本身也有所有接口的全部默认实现,这些实现就已经可以满足部分开发者。如果不满足,那 XLog 的高可配置性就体现出来了,你可以基于框架定义自己的实现。

四、XLog集成和使用示例

(该示例仅提供参考,具体可以根据需要扩展)

1、集成

在项目build.gradle中添加

implementation("com.elvishew:xlog:1.11.1")
2、封装的XLog工具类-XLogUtil.kt,代码如下
object XLogUtil {fun init() {val config = LogConfiguration.Builder().logLevel(LogLevel.ALL).tag("AndroidGifAgent").enableThreadInfo().xmlFormatter(DefaultXmlFormatter()).stackTraceFormatter(DefaultStackTraceFormatter()).build();val androidPrinter =AndroidPrinter(true) Printer that print the log using android.util.Logval logFolder =Environment.getExternalStorageDirectory().toPath().toString() + "/android_gif"val filePrinter = FilePrinter.Builder(logFolder).fileNameGenerator(MyFileNameGenerator())//日志文件名格式.backupStrategy(FileSizeBackupStrategy((500 * 1024 * 1024).toLong()))//单个日志文件的大小默认:FileSizeBackupStrategy(1024 * 1024).cleanStrategy(FileLastModifiedCleanStrategy(10L * 24L * 60L * 60L * 1000L))//日志文件存活时间,单位毫秒.flattener(ClassicFlattener())//配置写入文件日志格式:年月日时分秒.writer(SimpleWriter())//配置了writer才支持日志写文件.build()XLog.init(config, androidPrinter, filePrinter)}fun d(msg: String) {XLog.d(msg)}fun i(msg: String) {XLog.i(msg)}fun e(msg: String) {XLog.e(msg)}fun w(msg: String) {XLog.w(msg)}fun v(msg: String) {XLog.v(msg)}
}
3、在application中初始化
XLogUtil.init()
4、使用XLog
XLogUtil.d("btnClientSend data")

这篇关于Android 常用三种日志框架[Logger、Timber、XLog]的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1131386

相关文章

HarmonyOS学习(七)——UI(五)常用布局总结

自适应布局 1.1、线性布局(LinearLayout) 通过线性容器Row和Column实现线性布局。Column容器内的子组件按照垂直方向排列,Row组件中的子组件按照水平方向排列。 属性说明space通过space参数设置主轴上子组件的间距,达到各子组件在排列上的等间距效果alignItems设置子组件在交叉轴上的对齐方式,且在各类尺寸屏幕上表现一致,其中交叉轴为垂直时,取值为Vert

JS常用组件收集

收集了一些平时遇到的前端比较优秀的组件,方便以后开发的时候查找!!! 函数工具: Lodash 页面固定: stickUp、jQuery.Pin 轮播: unslider、swiper 开关: switch 复选框: icheck 气泡: grumble 隐藏元素: Headroom

【C++】_list常用方法解析及模拟实现

相信自己的力量,只要对自己始终保持信心,尽自己最大努力去完成任何事,就算事情最终结果是失败了,努力了也不留遗憾。💓💓💓 目录   ✨说在前面 🍋知识点一:什么是list? •🌰1.list的定义 •🌰2.list的基本特性 •🌰3.常用接口介绍 🍋知识点二:list常用接口 •🌰1.默认成员函数 🔥构造函数(⭐) 🔥析构函数 •🌰2.list对象

常用的jdk下载地址

jdk下载地址 安装方式可以看之前的博客: mac安装jdk oracle 版本:https://www.oracle.com/java/technologies/downloads/ Eclipse Temurin版本:https://adoptium.net/zh-CN/temurin/releases/ 阿里版本: github:https://github.com/

Android实现任意版本设置默认的锁屏壁纸和桌面壁纸(两张壁纸可不一致)

客户有些需求需要设置默认壁纸和锁屏壁纸  在默认情况下 这两个壁纸是相同的  如果需要默认的锁屏壁纸和桌面壁纸不一样 需要额外修改 Android13实现 替换默认桌面壁纸: 将图片文件替换frameworks/base/core/res/res/drawable-nodpi/default_wallpaper.*  (注意不能是bmp格式) 替换默认锁屏壁纸: 将图片资源放入vendo

Android平台播放RTSP流的几种方案探究(VLC VS ExoPlayer VS SmartPlayer)

技术背景 好多开发者需要遴选Android平台RTSP直播播放器的时候,不知道如何选的好,本文针对常用的方案,做个大概的说明: 1. 使用VLC for Android VLC Media Player(VLC多媒体播放器),最初命名为VideoLAN客户端,是VideoLAN品牌产品,是VideoLAN计划的多媒体播放器。它支持众多音频与视频解码器及文件格式,并支持DVD影音光盘,VCD影

30常用 Maven 命令

Maven 是一个强大的项目管理和构建工具,它广泛用于 Java 项目的依赖管理、构建流程和插件集成。Maven 的命令行工具提供了大量的命令来帮助开发人员管理项目的生命周期、依赖和插件。以下是 常用 Maven 命令的使用场景及其详细解释。 1. mvn clean 使用场景:清理项目的生成目录,通常用于删除项目中自动生成的文件(如 target/ 目录)。共性规律:清理操作

cross-plateform 跨平台应用程序-03-如果只选择一个框架,应该选择哪一个?

跨平台系列 cross-plateform 跨平台应用程序-01-概览 cross-plateform 跨平台应用程序-02-有哪些主流技术栈? cross-plateform 跨平台应用程序-03-如果只选择一个框架,应该选择哪一个? cross-plateform 跨平台应用程序-04-React Native 介绍 cross-plateform 跨平台应用程序-05-Flutte

Spring框架5 - 容器的扩展功能 (ApplicationContext)

private static ApplicationContext applicationContext;static {applicationContext = new ClassPathXmlApplicationContext("bean.xml");} BeanFactory的功能扩展类ApplicationContext进行深度的分析。ApplicationConext与 BeanF

android-opencv-jni

//------------------start opencv--------------------@Override public void onResume(){ super.onResume(); //通过OpenCV引擎服务加载并初始化OpenCV类库,所谓OpenCV引擎服务即是 //OpenCV_2.4.3.2_Manager_2.4_*.apk程序包,存