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")

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/pingmian/52940.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

高等代数精解【10】

高等代数精解【10】

文章目录 线性方程组概述增广矩阵基础一、增广矩阵的作用二、增广矩阵的实际应用例题 高斯消元法基础julia代码实现高斯消元法算法方阵高斯消元法非方阵的情况 Julia 中将整型矩阵转换为浮点型矩阵。方法 1&#xff1a;使用类型转换函数方法 2&#xff1a;使用 convert 函数方法…
阅读更多...
C语言字符串拼接

C语言字符串拼接

在 C 语言中&#xff0c;可以使用标准库函数 strcat 或 strncat 来拼接字符串。这些函数位于 string.h 头文件中&#xff0c;负责将一个字符串追加到另一个字符串的末尾。 1. 使用 strcat 进行字符串拼接 strcat 函数用于将源字符串&#xff08;source&#xff09;追加到目标…
阅读更多...
Linux CentOS 添加路由

Linux CentOS 添加路由

一、临时添加 查看当前路由表 ip route show添加路由 假设你要添加一条到特定网络的路由&#xff0c;可以使用以下命令&#xff1a; sudo ip route add <destination_network>/<netmask> via <gateway> dev <interface>例如&#xff0c;要添加一条…
阅读更多...
【Python123题库】#统计文章字符数 #查询高校信息 #查询高校名

【Python123题库】#统计文章字符数 #查询高校信息 #查询高校名

禁止转载&#xff0c;原文&#xff1a;https://blog.csdn.net/qq_45801887/article/details/140081854 参考教程&#xff1a;B站视频讲解——https://space.bilibili.com/3546616042621301 有帮助麻烦点个赞 ~ ~ Python123题库 统计文章字符数查询高校信息查询高校名 统计文章…
阅读更多...
Qt/QML学习-Tumbler

Qt/QML学习-Tumbler

QML学习 Tumbler例程视频讲解代码 main.qml import QtQuick 2.15 import QtQuick.Window 2.15 import QtQuick.Controls 2.15Window {width: 640height: 480visible: truetitle: qsTr("Hello World")Tumbler {id: tumbleranchors.centerIn: parent// 只显示3个视图…
阅读更多...
第二十章 rust多平台编译

第二十章 rust多平台编译

注意 本系列文章已升级、转移至我的自建站点中，本章原文为：rust多平台编译 目录 注意一、前言二、跨平台代码编写三、跨平台编译四、静态编译一、前言 相比于C/C++，rust最方便的一个东西除了包管理之外，便是跨平台编译了。 rust提供了一系列的工具可以帮助我们非常容易的…
阅读更多...
创建一个Spring MVC项目（配置，导入依赖，以及前端控制器）

创建一个Spring MVC项目（配置，导入依赖，以及前端控制器）

Tomcat&#xff08;10.1.28&#xff09;配置 详细讲解&#xff01; 链接https://blog.csdn.net/or77iu_N/article/details/141266535?spm1001.2014.3001.5502 1、创建 Java Web 项目 File -> New -> Project 2、导入 Spring MVC 相关依赖 <dependency> <gro…
阅读更多...
汽车乘客热舒适度大挑战，如何利用仿真技术提高汽车环境舒适度

汽车乘客热舒适度大挑战，如何利用仿真技术提高汽车环境舒适度

舒适性在人们选择汽车的决定性方面占比越来越重&#xff0c;而汽车乘员舱环境的舒适性是指为乘员提供舒适愉快便利的乘坐环境与条件&#xff0c;包括良好的平顺性、车内的低噪声、适宜的空气环境以及良好的驾驶操作性能。 舒适性 经济性 安全性、动力性 典型的乘员舱热舒适性模…
阅读更多...
测试 UDP 端口可达性的方法

测试 UDP 端口可达性的方法

前言&#xff1a; UDP (User Datagram Protocol) 是一种无连接的传输层协议&#xff0c;它不像 TCP 那样提供确认机制来保证数据包的可靠传输。因此&#xff0c;测试 UDP 端口的可达性通常需要一些特殊的方法&#xff0c;因为传统的端口扫描工具&#xff08;如 nmap&#xff0…
阅读更多...
AGI系列（9）手把手带你玩转 Coze 画板节点

AGI系列（9）手把手带你玩转 Coze 画板节点

本文以智能体“日签卡片生成器”的制作来阐述 Coze 画板节点的使用方法。 效果演示 核心流程 日签卡片生成器工作流整体分为两部分&#xff1a; 工作流&#xff1a;其核心流程为通过用户输入的主题词生成卡片的标题、内容 图像流&#xff1a;通过LLM输出的内容在图像流完成卡…
阅读更多...
Verilog开源项目——百兆以太网交换机（七）包修改模块设计

Verilog开源项目——百兆以太网交换机（七）包修改模块设计

Verilog开源项目——百兆以太网交换机&#xff08;七&#xff09;包修改模块设计 &#x1f508;声明&#xff1a;未经作者允许&#xff0c;禁止转载 &#x1f603;博主主页&#xff1a;王_嘻嘻的CSDN主页 &#x1f511;全新原创以太网交换机项目&#xff0c;Blog内容将聚焦整体…
阅读更多...
Java项目: 基于SpringBoot+mysql网上订餐系统分前后台(含源码+数据库+开题报告+PPT+毕业论文)

Java项目: 基于SpringBoot+mysql网上订餐系统分前后台(含源码+数据库+开题报告+PPT+毕业论文)

一、项目简介 本项目是一套基于SpringBootmysql网上订餐系统分前后台 包含&#xff1a;项目源码、数据库脚本等&#xff0c;该项目附带全部源码可作为毕设使用。 项目都经过严格调试&#xff0c;eclipse或者idea 确保可以运行&#xff01; 该系统功能完善、界面美观、操作简单…
阅读更多...
【北森-注册安全分析报告-无验证方式导致安全隐患】

【北森-注册安全分析报告-无验证方式导致安全隐患】

前言 由于网站注册入口容易被黑客攻击&#xff0c;存在如下安全问题&#xff1a; 1. 暴力破解密码&#xff0c;造成用户信息泄露 2. 短信盗刷的安全问题&#xff0c;影响业务及导致用户投诉 3. 带来经济损失&#xff0c;尤其是后付费客户&#xff0c;风险巨大&#xff0c;造…
阅读更多...
（二）Kafka离线安装 - Zookeeper下载及安装

（二）Kafka离线安装 - Zookeeper下载及安装

一、下载 下载ZooKeeper之前&#xff0c;需要根据下载的Kafka版本&#xff0c;来确定ZooKeeper的版本。 Kafka官方地址&#xff1a;Apache Kafka 1、先下载源码版本&#xff0c;下载完后解压&#xff0c;在kafka-3.8.0-src\gradle目录下找到dependencies.gradle文件&#xff…
阅读更多...
Spring高手之路

Spring高手之路

成为一名Spring框架的高手是一个涉及广泛知识面和深入实践的过程。Spring框架是Java EE领域的一个开源的、轻量级的、控制反转(IoC)的、面向切面(AOP)的容器框架&#xff0c;它提供了展示层和业务层的框架功能。以下是一些关键步骤和资源&#xff0c;可以帮助你走上成为Spring高…
阅读更多...
我用GPT对RAG技术的学习和探索

我用GPT对RAG技术的学习和探索

思维导图 下图是我的学习和探索过程&#xff0c;红点表示已研究&#xff0c;黄点表示待研究 目录 思维导图RAG技术概述RAG 的关键优点应用场景 如何了解RAG技术的原理和应用1. **基础理论学习**2. **实战演练**3. **学习资源利用**4. **保持学习的连贯性**5. **多角度理解**6. …
阅读更多...
RASA使用长文记录以及一些bug整理

RASA使用长文记录以及一些bug整理

RASA 学习笔记整理 一 安装 在虚拟环境中安装&#xff0c;进入python3版本的环境 conda activate python3 ai04机器旧版本&#xff1a;rasa-nlu和rasa-core是分开安装的 最新版本&#xff1a;rasa 将二者做了合并 直接安装 pip3 install rasa 在安装到如下步骤时候会报…
阅读更多...
2024年华为OD E卷

2024年华为OD E卷

第一题&#xff08;一星题&#xff09; 输入两个正整数n,m,编号1~n围成一圈的人&#xff0c;从1开始报数&#xff0c;数到m&#xff0c;m就退出&#xff0c;接着从下一个编号从1开始报数&#xff0c;当剩下的人少与m时停止报数&#xff0c;并按从小到大的顺序输出剩下的人在原…
阅读更多...
应急响应-爆破漏洞应急响应流程（以SSH爆破为例）

应急响应-爆破漏洞应急响应流程（以SSH爆破为例）

目录 概述研判分析登录成功登录失败历史命令authorized_keys 定损止损攻击链路还原清理恢复总结复盘参考 概述 爆破漏洞是比较常见漏洞&#xff0c;端口开放&#xff0c;管理后台没有做登录频率限制等情况都可能遭受到爆破攻击&#xff0c;本文以SSH爆破为例&#xff0c;介绍下…
阅读更多...
LuaJit分析（八）LuaJit预编译库函数加载过程

LuaJit分析（八）LuaJit预编译库函数加载过程

在luajit的pmain函数中&#xff0c;在执行命令行输入的参数之前&#xff0c;会执行如下函数&#xff1a; luaL_openlibs(L); 该函数位于lib_init.c中&#xff0c;实现如下&#xff1a; LUALIB_API void luaL_openlibs(lua_State *L) {const luaL_Reg *lib;for (lib lj_lib_…
阅读更多...
最新文章

Copyright @ 2022~2023