Android|记一个导致 logback 无法输出日志的问题

news/2024/9/21 10:54:19/

之前写过《Android|集成 slf4j + logback 作为日志框架》,最近在给手上的另外一个 Android 项目添加 logback 日志框架时,遇到一个导致无法输出日志到文件的问题,也耽误了不少时间,这里记录一下。

现象

代码里通过 @Slf4j 注解注入 logger,正常 log.info(xxx),但是程序启动后,发现没有生成日志文件。

排查

检查配置文件

有前一个项目的成功经验,我直接复制了之前项目的配置文件,只是将日志存储文件夹修改为了 ${DATA_DIR}/log,其中 DATA_DIR 变量是指代 Context.getFilesDir(),它也不存在权限申请之类的问题。测试了将它写死成一个绝对路径,也没有日志文件生成。

基本排除配置文件的问题。

打开 logback 的 debug 模式

logback.xml 文件的根元素 <configuration> 添加 debug="true" 属性,重启程序,查看 logcat 输出,发现如下异常:

11:34:06,785 |-ERROR in ch.qos.logback.core.rolling.RollingFileAppender[local_file] - Failed to create parent directories for [/log/app.log]
11:34:06,786 |-ERROR in ch.qos.logback.core.rolling.RollingFileAppender[local_file] - openFile(/log/student.log,true) failed java.io.FileNotFoundException: /log/app.log: open failed: ENOENT (No such file or directory)at java.io.FileNotFoundException: /log/student.log: open failed: ENOENT (No such file or directory)...at 	at org.slf4j.LoggerFactory.getLogger(LoggerFactory.java:416)at 	at org.mazhuang.OnlineApplication.<clinit>(OnlineApplication.java:21)

初始化日志文件路径失败,但是输出的日志文件路径是 /log/app.log,而不是我配置的 ${DATA_DIR}/log/app.log,这里有问题。

可以看出是 logback 没有正确解析 ${DATA_DIR} 变量,导致日志文件路径错误。但是为什么会这样呢?并没有什么头绪,难道是 logback 的 bug?

检查 logback-android 的 wiki

在想了好久仍然没有头绪之后,浏览 logback-android 的 wiki,发现在介绍 DATA_DIR 等变量的地方,有这么一段以前没留意的描述:

Note these special properties are initialized when the first logger is instantiated (i.e., via LoggerFactory.getLogger()), but that must be done when the application context is available (e.g., in the onCreate method of your Application class or at any point thereafter). Otherwise, the special properties will resolve to empty strings.

这段话大意是,DATA_DIR 等这些变量,是在第一次调用 LoggerFactory.getLogger() 时初始化的,但是必须在 application context 可用之后(例如在 Application 类的 onCreate 方法中或之后的任何时候)。否则,这些变量将解析为空字符串。

结合上面异常堆栈里的信息,可以判断是因为在 Application 类的类初始化(clinit)过程中调用了 LoggerFactory.getLogger(),此时 application context 还不可用,导致 logback 无法正确解析 ${DATA_DIR} 变量。

进一步探究

而为什么 Application 类的类初始化过程中会调用 LoggerFactory.getLogger() 呢?检查代码,发现是在自定义 Application 类及其基类中使用了 @Slf4j 注解,这个注解会生成一个静态的 logger,而这个 logger 的初始化会调用 LoggerFactory.getLogger()——太早了。

参见 @Slf4j 注解源文件里的注释:

Causes lombok to generate a logger field.
Complete documentation is found at the project lombok features page for lombok log annotations .
Example:@Slf4jpublic class LogExample {}will generate:public class LogExample {private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExample.class);}

解决

去掉自定义 Application 类及其基类上的 @Slf4j 注解,如果需要在 Application 类里打印日志,改为在 onCreate 方法中手动初始化 logger。

又一次印证了认真阅读文档的重要性。😢

参考

  • https://github.com/tony19/logback-android/wiki#special-properties-for-xml-config


http://www.ppmy.cn/news/1440083.html

相关文章

Istio介绍

1.什么是Istio Istio是一个开源的服务网格&#xff08;Service Mesh&#xff09;框架&#xff0c;它提供了一种简单的方式来为部署在Kubernetes等容器编排平台上的微服务应用添加网络功能。Istio的核心功能包括&#xff1a; 服务治理&#xff1a;Istio能够帮助管理服务之间的…

DRF 查询(排序、过滤、分页)

查询(排序、过滤、分页) 【0】准备 &#xff08;1&#xff09;Q查询 详细内容可见&#xff1a;Django模型层-CSDN博客Django 的 Q 对象提供了一种在数据库查询中构造复杂查询的方法。当你想在单个查询中组合多个过滤条件&#xff0c;并且这些条件之间不仅仅是简单的 AND 关系…

IDEA pom.xml依赖警告

IDEA中&#xff0c;有时 pom.xml 中会出现如下提示&#xff1a; IDEA 2022.1 升级了检测易受攻击的 Maven 和 Gradle 依赖项&#xff0c;并建议修正&#xff0c;通过插件 Package Checker 捆绑到 IDE 中。 这并不是引用错误&#xff0c;不用担心。如果实在强迫症不想看到这个提…

由对极约束得到基础矩阵

对极约束是计算机视觉中的一种几何约束&#xff0c;特别是在双目视觉和多目视觉系统中&#xff0c;用于解决摄像机相对姿态估计和三维重建的问题。对极几何基于两个摄像机在同一时刻拍摄同一场景的不同视图这一事实&#xff0c;研究的是同一空间点在不同摄像机图像平面上的投影…

MySQL 主主复制在生产环境常见的问题有哪些

MySQL 主主复制&#xff08;Master-Master Replication&#xff09;是一种常见的数据库架构&#xff0c;它可以提供高可用性和负载均衡。在生产环境中&#xff0c;可能会遇到以下常见问题&#xff1a; 数据冲突&#xff1a;在主主复制环境下&#xff0c;两个主库同时写入相同的…

HTTP慢连接攻击的原理和防范措施

随着互联网的快速发展&#xff0c;网络安全问题日益凸显&#xff0c;网络攻击事件频繁发生。其中&#xff0c;HTTP慢速攻击作为一种隐蔽且高效的攻击方式&#xff0c;近年来逐渐出现的越来越多。 为了防范这些网络攻击&#xff0c;我们需要先了解这些攻击情况&#xff0c;这样…

【漏洞复现】GB28181摄像头管理平台user未授权漏洞

漏洞描述&#xff1a; GB28181是公共安全视频监控联网系统信息传输、交换、控制技术要求的标准。该标准主要定义了基于IP网络的音视频监控系统的整体架构&#xff0c;包括前端设备、存储设备、管理平台等组成部分&#xff0c;以及设备接入、流媒体传输、信令交互、存储管理、安…

MySQL双层游标嵌套循环方法

文章目录 1、需求描述2、思路3、创建存储过程 1、需求描述 1、在项目中&#xff0c;需要将A表中主键id&#xff0c;逐个取出&#xff0c;作为条件&#xff0c;在B表中去逐一查询&#xff0c;将B表查询到的结果集&#xff08;A表B表关系&#xff1a;一对多&#xff09;&#xf…