slf4j、logback、log4j打印出的日志行号不正确,如何获取正确的行号(调用者类里的行号)

本文主要是介绍slf4j、logback、log4j打印出的日志行号不正确,如何获取正确的行号(调用者类里的行号),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

目录

环境信息

说明

配置信息

问题描述

原因分析

解决方案

解决思路

LocationAwareLogger.java

ch.qos.logback.classic.Logger.java

解决方法

Log.java


环境信息

SpringBoot 2.1.15.RELEASE

slf4j:1.7.25

logback:1.2.3

说明

        系统使用的是slf4j+logback日志组合,而且为了系统的个性化需求,封装了自己的日志操作类Log.java,不是直接使用slf4j的API:

private static Logger logger = LoggerFactory.getLogger(xxx.class);

配置信息

 logback配置:

logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration><property resource="configs-xml-logback.properties" /><appender name="stdout" class="ch.qos.logback.core.ConsoleAppender"><layout class="ch.qos.logback.classic.PatternLayout"><pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %msg 【%t】【%logger{0}:%L】%n</pattern></layout></appender><appender name="bizLog"class="ch.qos.logback.core.rolling.RollingFileAppender"><file>${log.root.path}/${app.name}/${app.name}.log</file><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><fileNamePattern>${log.root.path}/${app.name}/${app.name}.%d{yyyy-MM-dd}.log</fileNamePattern><maxHistory>3</maxHistory></rollingPolicy><encoder><pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %msg 【%t】【%logger{0}:%L】%n</pattern></encoder></appender><!-- 异步输出 --><appender name="ASYNC" class="ch.qos.logback.classic.AsyncAppender"><!-- 不丢失日志.默认的,如果队列的80%已满,则会丢弃TRACT、DEBUG、INFO级别的日志 --><discardingThreshold>0</discardingThreshold><!-- 更改默认的队列的深度,该值会影响性能.默认值为256 --><queueSize>256</queueSize><!-- 添加附加的appender,最多只能添加一个 --><appender-ref ref="bizLog" /></appender><logger name="java.sql.Connection" level="${sql.log.level}" /><logger name="java.sql.Statement" level="${sql.log.level}" /><logger name="java.sql.PreparedStatement" level="${sql.log.level}" /><logger name="com.eternalinfo" level="${log.dev.level}" /><root level="${log.level}"><appender-ref ref="stdout" /><appender-ref ref="ASYNC" /></root><jmxConfigurator />
</configuration>  

configs-xml-logback.properties

app.name=myApp
log.root.path=/home/myApp-logs
log.level=INFO
log.dev.level=DEBUG
sql.log.level=INFO

问题描述

logback的配置是生效的,%L是打印行号,在日志里也能显示出行号出来。

问题在于有很多行号的值不对,而且都是些重复的行数,比如51、117、149。

2021-09-22 14:06:49.238 INFO  加载第7个子配置文件:file [D:\xxx.xml] 【main】【ResourceLookuper:117】
2021-09-22 14:06:49.248 INFO  加载第8个子配置文件:file [D:\yyy.xml] 【main】【ResourceLookuper:117】
2021-09-22 14:06:49.256 DEBUG 总共加载了9配置文件 【main】【ResourceLookuper:51】
2021-09-22 14:06:49.256 DEBUG 开始处理已加载的第0个子配置文件:xxx.xml 【main】【XmlConfigDeserializer:51】
2021-09-22 14:38:27.517 WARN  获取不到HttpServletRequest对象 【pool-14-thread-1】【HttpHolderUtil:149】

原因分析

        问题出现以后,最开始是猜想这些行号是代理类里的行号,不过很快排除了:有些类并没有使用代理,打印出的日志行号还是不对。

        仔细看了下日志的行号,发现了一个规律:

DEBUG级别的日志的行号是51

INFO级别的日志的行号是117

WARN级别的日志的行号是149

所以问题很可能出在日志操作类Log.java上,这些行号是日志操作类Log里的行号。打开Log类看了下,发现确实是这样:

Log.java  有省略代码

import org.slf4j.Logger;import ch.qos.logback.classic.LoggerContext;public class Log
{public static final String LOG_LEVEL_KEY="log.level";public static final String OUT_LOG_CLASS_REGEX_KEY="out.log.class.regex";private Logger logger;private static final String PLACE_HODER_STR="\\{\\}";Log(Class<?> clz,LoggerContext loggerContext){
//		logger=LoggerFactory.getLogger(clz); 
//		if(this.loggerContext==null) {
//			loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory();
//		}logger=loggerContext.getLogger(clz);}private Logger getCurrentLog(){return logger;}private String getLogId(Object message) {String logId = LogIdUtil.getLogId()==null ?"":LogIdUtil.getLogId()+"||";return logId+message;}/*** debug记录* @param message* @param e*/public void debug(Object message,Throwable e){message = getLogId(message);getCurrentLog().debug(((String)message).replace("{}", ""),e);}/*** message记录* @param message* @param e*/public void info(Object message,Throwable e){message = getLogId(message);getCurrentLog().info(((String)message).replace("{}", ""),e);}public void warn(Object message,Throwable e){message = getLogId(message);getCurrentLog().warn(((String)message).replace("{}", ""),e);}...}

原因在于打印日志是使用的日志操作类Log,真正调用slf4j的debug、info、warn的地方是Log类,所以打印出的行号是Log类里的行号,而不是调用Log类的地方(以下称为调用者类)的行号

getCurrentLog().debug(((String)message).replace("{}", ""),e);

解决方案

解决思路

        在使用slf4j的时候,默认引用的是slf4j的org.slf4j.Logger接口(实现类看真正的日志框架是什么,比如这里是logback的ch.qos.logback.classic.Logger),而这个Logger接口还有一个子接口org.slf4j.spi.LocationAwareLogger,logback的ch.qos.logback.classic.Logger实现类也实现了这个接口:

LocationAwareLogger.java

package org.slf4j.spi;import org.slf4j.Logger;
import org.slf4j.Marker;/*** An <b>optional</b> interface helping integration with logging systems capable of * extracting location information. This interface is mainly used by SLF4J bridges * such as jcl-over-slf4j, jul-to-slf4j and log4j-over-slf4j or {@link Logger} wrappers* which need to provide hints so that the underlying logging system can extract* the correct location information (method name, line number).** @author Ceki Gulcu* @since 1.3*/
public interface LocationAwareLogger extends Logger {// these constants should be in EventContants. However, in order to preserve binary backward compatibility// we keep these constants herefinal public int TRACE_INT = 00;final public int DEBUG_INT = 10;final public int INFO_INT = 20;final public int WARN_INT = 30;final public int ERROR_INT = 40;/*** Printing method with support for location information. * * @param marker The marker to be used for this event, may be null.* @param fqcn The fully qualified class name of the <b>logger instance</b>,* typically the logger class, logger bridge or a logger wrapper.* @param level One of the level integers defined in this interface* @param message The message for the log event* @param t Throwable associated with the log event, may be null.*/public void log(Marker marker, String fqcn, int level, String message, Object[] argArray, Throwable t);}

ch.qos.logback.classic.Logger.java

public final class Logger implements org.slf4j.Logger, LocationAwareLogger, AppenderAttachable<ILoggingEvent>, Serializable {private static final long serialVersionUID = 5454405123156820674L; // 8745934908040027998L;/*** The fully qualified name of this class. Used in gathering caller* information.*/public static final String FQCN = ch.qos.logback.classic.Logger.class.getName();public void log(Marker marker, String fqcn, int levelInt, String message, Object[] argArray, Throwable t) {Level level = Level.fromLocationAwareLoggerInteger(levelInt);filterAndLog_0_Or3Plus(fqcn, marker, level, message, argArray, t);}
...
}

LocationAwareLogger这个接口的说明里写了:

这个可选接口可以帮助日志系统来输出正确的引用位置信息(方法名、行号),可以用于slf4j的桥连,比如jcl-over-slf4j, jul-to-slf4j and log4j-over-slf4j or Logger wrappers (或者Logger的装饰模式)

在这里,日志操作类Log相当于Logger的装饰器。

解决方法

修改日志操作类Log里的debug、info、warn等方法,改成LocationAwareLogger里的log方法

可以参考jcl-over-slf4j包里的org.apache.commons.logging.impl.SLF4JLocationAwareLog

Log.java

import org.slf4j.Logger;import ch.qos.logback.classic.LoggerContext;public class Log
{public static final String LOG_LEVEL_KEY="log.level";public static final String OUT_LOG_CLASS_REGEX_KEY="out.log.class.regex";private Logger logger;private static final String PLACE_HODER_STR="\\{\\}";Log(Class<?> clz,LoggerContext loggerContext){
//		logger=LoggerFactory.getLogger(clz); 
//		if(this.loggerContext==null) {
//			loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory();
//		}logger=loggerContext.getLogger(clz);}private Logger getCurrentLog(){return logger;}private String getLogId(Object message) {String logId = LogIdUtil.getLogId()==null ?"":LogIdUtil.getLogId()+"||";return logId+message;}/*** debug记录* @param message* @param e*/public void debug(Object message, Throwable e) {message = getLogId(message);// 做判断是以防更改了日志实现框架之后,logger未实现LocationAwareLogger接口。如果只是logback使用,不需要if (this.logger instanceof LocationAwareLogger) {((LocationAwareLogger) this.logger).log(null, FQCN, LocationAwareLogger.DEBUG_INT, (String) message, null, e);return;}this.logger.debug(((String) message).replace("{}", ""), e);}/*** message记录* @param message* @param e*/public void info(Object message, Throwable e) {message = getLogId(message);if (this.logger instanceof LocationAwareLogger) {((LocationAwareLogger) this.logger).log(null, FQCN, LocationAwareLogger.INFO_INT, (String) message, null, e);return;}getCurrentLog().info(((String) message).replace("{}", ""), e);}public void warn(Object message, Throwable e) {message = getLogId(message);if (this.logger instanceof LocationAwareLogger) {((LocationAwareLogger) this.logger).log(null, FQCN, LocationAwareLogger.WARN_INT, (String) message, null, e);return;}getCurrentLog().warn(((String) message).replace("{}", ""), e);}...}

参考:

Slf4j+logback实现日志打印-获取调用者类及方法行数信息_wang37444的专栏

这篇关于slf4j、logback、log4j打印出的日志行号不正确,如何获取正确的行号(调用者类里的行号)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



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

相关文章

python获取指定名字的程序的文件路径的两种方法

《python获取指定名字的程序的文件路径的两种方法》本文主要介绍了python获取指定名字的程序的文件路径的两种方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要... 最近在做项目,需要用到给定一个程序名字就可以自动获取到这个程序在Windows系统下的绝对路径,以下

SpringBoot日志级别与日志分组详解

《SpringBoot日志级别与日志分组详解》文章介绍了日志级别(ALL至OFF)及其作用,说明SpringBoot默认日志级别为INFO,可通过application.properties调整全局或... 目录日志级别1、级别内容2、调整日志级别调整默认日志级别调整指定类的日志级别项目开发过程中,利用日志

SpringBoot 获取请求参数的常用注解及用法

《SpringBoot获取请求参数的常用注解及用法》SpringBoot通过@RequestParam、@PathVariable等注解支持从HTTP请求中获取参数,涵盖查询、路径、请求体、头、C... 目录SpringBoot 提供了多种注解来方便地从 HTTP 请求中获取参数以下是主要的注解及其用法:1

Java中如何正确的停掉线程

《Java中如何正确的停掉线程》Java通过interrupt()通知线程停止而非强制,确保线程自主处理中断,避免数据损坏,线程池的shutdown()等待任务完成,shutdownNow()强制中断... 目录为什么不强制停止为什么 Java 不提供强制停止线程的能力呢?如何用interrupt停止线程s

深度剖析SpringBoot日志性能提升的原因与解决

《深度剖析SpringBoot日志性能提升的原因与解决》日志记录本该是辅助工具,却为何成了性能瓶颈,SpringBoot如何用代码彻底破解日志导致的高延迟问题,感兴趣的小伙伴可以跟随小编一起学习一下... 目录前言第一章:日志性能陷阱的底层原理1.1 日志级别的“双刃剑”效应1.2 同步日志的“吞吐量杀手”

java -jar example.jar 产生的日志输出到指定文件的方法

《java-jarexample.jar产生的日志输出到指定文件的方法》这篇文章给大家介绍java-jarexample.jar产生的日志输出到指定文件的方法,本文给大家介绍的非常详细,对大家的... 目录怎么让 Java -jar example.jar 产生的日志输出到指定文件一、方法1:使用重定向1、

c++日志库log4cplus快速入门小结

《c++日志库log4cplus快速入门小结》文章浏览阅读1.1w次,点赞9次,收藏44次。本文介绍Log4cplus,一种适用于C++的线程安全日志记录API,提供灵活的日志管理和配置控制。文章涵盖... 目录简介日志等级配置文件使用关于初始化使用示例总结参考资料简介log4j 用于Java,log4c

Android 缓存日志Logcat导出与分析最佳实践

《Android缓存日志Logcat导出与分析最佳实践》本文全面介绍AndroidLogcat缓存日志的导出与分析方法,涵盖按进程、缓冲区类型及日志级别过滤,自动化工具使用,常见问题解决方案和最佳实... 目录android 缓存日志(Logcat)导出与分析全攻略为什么要导出缓存日志?按需过滤导出1. 按

nginx配置错误日志的实现步骤

《nginx配置错误日志的实现步骤》配置nginx代理过程中,如果出现错误,需要看日志,可以把nginx日志配置出来,以便快速定位日志问题,下面就来介绍一下nginx配置错误日志的实现步骤,感兴趣的可... 目录前言nginx配置错误日志总结前言在配置nginx代理过程中,如果出现错误,需要看日志,可以把

Spring Boot集成/输出/日志级别控制/持久化开发实践

《SpringBoot集成/输出/日志级别控制/持久化开发实践》SpringBoot默认集成Logback,支持灵活日志级别配置(INFO/DEBUG等),输出包含时间戳、级别、类名等信息,并可通过... 目录一、日志概述1.1、Spring Boot日志简介1.2、日志框架与默认配置1.3、日志的核心作用