到底该不该写isDebugEnabled

最新推荐文章于 2023-01-16 18:00:14 发布
最新推荐文章于 2023-01-16 18:00:14 发布
阅读量1k 收藏 1
点赞数 1
文章标签： java 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/BASK2311/article/details/128574139
版权

序

今天又是还愿的一天，今天的计划 提前完成，想起之前评论区的一句话

juejin.cn/post/716304…

这里解答下

前提简介

彩蛋在后面

目录

链接

logback jira地址

[LOGBACK-1711] Deadlock when using Virtual Threads - QOS.ch JIRA

logback filter 文章

logback.qos.ch/manual/filt…

is判断的必要性

即使不写is判断，debug也会对是否可以输出日志 进行判断

是的

源码解析

public boolean isDebugEnabled(Marker marker) {
    FilterReply decision = this.callTurboFilters(marker, Level.DEBUG);
    if (decision == FilterReply.NEUTRAL) {
        return this.effectiveLevelInt <= 10000;
    } else if (decision == FilterReply.DENY) {
        return false;
    } else if (decision == FilterReply.ACCEPT) {
        return true;
    } else {
        throw new IllegalStateException("Unknown FilterReply value: " + decision);
    }
}
//如果系统可以打印 debug，输出 FilterReply.NEUTRAL，如果不能，输出FilterReply.DENY
private FilterReply callTurboFilters(Marker marker, Level level) {
    return this.loggerContext.getTurboFilterChainDecision_0_3OrMore(marker, this, level, (String)null, (Object[])null, (Throwable)null);
}
复制代码

可以看到，经过一些判断，最终调用到了getTurboFilterChainDecision_0_3OrMore方法，再看debug代码

public void debug(String msg) {
    this.filterAndLog_0_Or3Plus(FQCN, (Marker)null, Level.DEBUG, msg, (Object[])null, (Throwable)null);
}

private void filterAndLog_0_Or3Plus(String localFQCN, Marker marker, Level level, String msg, Object[] params, Throwable t) {
    FilterReply decision = this.loggerContext.getTurboFilterChainDecision_0_3OrMore(marker, this, level, msg, params, t);
    if (decision == FilterReply.NEUTRAL) {
        if (this.effectiveLevelInt > level.levelInt) {
            return;
        }
    } else if (decision == FilterReply.DENY) {
        return;
    }
    //如果是 占位符 只有通过前面的判断才会执行到这,所以不会有拼接的性能问题
    this.buildLoggingEventAndAppend(localFQCN, marker, level, msg, params, t);
}


public void debug(String format, Object arg) {
    this.filterAndLog_1(FQCN, (Marker)null, Level.DEBUG, format, arg, (Throwable)null);
}
复制代码

debug 也是执行了 getTurboFilterChainDecision_0_3OrMore

如果是 占位符 只有通过前面的判断才会执行到这,所以不会有拼接的性能问题，但是如果这个属性创建的内存消耗

小总结

不写is判断，输出日志的时候 也会判断

从这个角度 isDebugEnabled是可以不写的

即便系统不打印debug，新创建的对象也占用内存

准备工具

先要能验证 内存是否占用了，使用哪个工具呢？

也不用看到字节程度，直接多执行一些次数，然后看内存的差距就可以 用 java VisualVM

测试场景

看黄色的线

代码

private static final Integer count = 100;
@GetMapping("/testDebug")
public String testDebug() {
    for (int i = 0; i < count; i++) {
        log.debug(new B() + "3" + "4");//就算设置了不打印debug，也会执行内容的拼接，会影响性能
    }

    return "success";
}


@GetMapping("/testDebugForEnabled")
public String testDebugForEnabled() {

    for (int i = 0; i < count; i++) {
        if(log.isDebugEnabled()){

            log.debug(new byte[1024 * 1024] + "3" + "4");//就算设置了不打印debug，也会执行内容的拼接，会影响性能
        }
    }
    return "success";
}

public class B {

    private byte[] b = new byte[1024 * 1024];
    public B() {
        System.out.println("B的初始化");
    }
}
复制代码

系统打印debug, 无 isDebugEnabled

系统打印debug，有 isDebugEnabled

系统不打印debug, 无 isDebugEnabled

无论系统打不打印debug，如果没有isDebugEnabled 都会创建对象，占用内存

系统不打印debug，有 isDebugEnabled

小总结

从上面的简单测试，可以得出

无论系统打不打印debug，如果没有isDebugEnabled 都会创建对象，占用内存

还是需要使用isDebugEnabled的，能节省内存的消耗

虽然我们平时工作中一般都是debug日志 上生产会关闭，而且 一般日志打印的也都是一些现成的对象，而不是新建的对象，但是 还是推荐添加 isDebugEnabled

额外问题

之前为什么会有需要写is 判断呢？

在N久以前，很多日志框架都不支持{}模板的写法(如Log4j1.X, Apache Commons Logging)，于是只能通过字符串拼接来输出日志内容：

log.debug("hello, this is " + name);

这样一来，每当JVM执行到此时，不管你当前的日志级别是多少，都会执行一次字符串拼接，然后将结果做为形参传递给debug()方法，这样就带来了无用的性能损耗。这时，提前判断isDebugEnabled()可以解决此问题

if (log.isDebugEnabled()) { log.debug("hello, this is " + name); }

这样写的好处有二：

当日志级别在DEBUG以下时，log.debug("hello, this is " + name)就不会执行，从而没有字符串拼接的开销。 JIT在运行时会优化if语句，如果isDebugEnabled()返回false, 则JIT会将整个if块全部去掉。

使用占位符 能解决String 拼接的消耗？

能

看debug代码

public void debug(String msg) {
    this.filterAndLog_0_Or3Plus(FQCN, (Marker)null, Level.DEBUG, msg, (Object[])null, (Throwable)null);
}

private void filterAndLog_0_Or3Plus(String localFQCN, Marker marker, Level level, String msg, Object[] params, Throwable t) {
    FilterReply decision = this.loggerContext.getTurboFilterChainDecision_0_3OrMore(marker, this, level, msg, params, t);
    if (decision == FilterReply.NEUTRAL) {
        if (this.effectiveLevelInt > level.levelInt) {
            return;
        }
    } else if (decision == FilterReply.DENY) {
        return;
    }
    //如果是 占位符 只有通过前面的判断才会执行到这,所以不会有拼接的性能问题
    this.buildLoggingEventAndAppend(localFQCN, marker, level, msg, params, t);
}


public void debug(String format, Object arg) {
    this.filterAndLog_1(FQCN, (Marker)null, Level.DEBUG, format, arg, (Throwable)null);
}
复制代码

如果是 占位符 只有通过前面的判断才会执行到这,所以不会有拼接的性能问题，但是如果这个属性创建的内存消耗

彩蛋

为了写这篇文章，把代码下载下来

怎么判断 每个日志 是否应该输出

其实我们很多的就是 配置 包括info 以及以上的 日志输出

这里就有2个点

  1. 系统配置的info 以上才能打印，这个是哪个参数管理的
  2. 有的时候 我们在 application.yml文件中会指定哪几个包下的日志打印，又是怎么回事？

系统配置的info 以上才能打印，这个是哪个参数管理的

首先 如果这个让我们自己实现，我们肯定也是 int标识，把优先级排序

比如

public final class Level implements java.io.Serializable {

    private static final long serialVersionUID = -814092767334282137L;

    public static final int OFF_INT = Integer.MAX_VALUE;
    public static final int ERROR_INT = 40000;
    public static final int WARN_INT = 30000;
    public static final int INFO_INT = 20000;
    public static final int DEBUG_INT = 10000;
    public static final int TRACE_INT = 5000;
    public static final int ALL_INT = Integer.MIN_VALUE;
    
}
复制代码

这个没毛病，举一反三，我们还会在哪这么使用

想到Rocketmq 也有类似的

public class MQVersion {
    //这里ordinal 也是把版本号 变为int 进行比较
    public static final int CURRENT_VERSION = Version.V4_9_3.ordinal();
    
}
复制代码

好，我们继续，说到这，日志打不打印又是哪里控制的？

我们首先要看

public enum FilterReply {
    DENY, NEUTRAL, ACCEPT;
}
复制代码

分别代表着

  1. DENY 拒绝
  2. NEUTRAL 中性
  3. ACCEPT 同意
public boolean isDebugEnabled(Marker marker) {
    final FilterReply decision = callTurboFilters(marker, Level.DEBUG);
    //如果是中性 就需要进行后续判断
    if (decision == FilterReply.NEUTRAL) {
        return effectiveLevelInt <= Level.DEBUG_INT;
    } else if (decision == FilterReply.DENY) {
       //如果是拒绝 执行返回false，不用打印了
        return false;
    } else if (decision == FilterReply.ACCEPT) {
       //如果是统一 执行返回true，需要打印
        return true;
    } else {
        throw new IllegalStateException("Unknown FilterReply value: " + decision);
    }
}
复制代码

分开分析

中性

又说回到 getTurboFilterChainDecision_0_3OrMore 方法了

final FilterReply getTurboFilterChainDecision_0_3OrMore(final Marker marker, final Logger logger, final Level level,
        final String format, final Object[] params, final Throwable t) {
    if (turboFilterList.size() == 0) {
        return FilterReply.NEUTRAL;
    }
    return turboFilterList.getTurboFilterChainDecision(marker, logger, level, format, params, t);
}
复制代码

第一步判断 turboFilterList 是否为空

turboFilterList 是哪里初始化的呢？

只找到了这个，debug一下

LoggingSystem的实例化

LoggingSystem被实例化那个，默认它取得顺序是LogbackLoggingSystem>Log4J2LoggingSystem>JavaLoggingSystem，如果类存在就选择。

//源自package org.springframework.boot.logging;
public abstract class LoggingSystem {
	static {
		Map<String, String> systems = new LinkedHashMap<>();
		systems.put("ch.qos.logback.core.Appender",
				"org.springframework.boot.logging.logback.LogbackLoggingSystem");
		systems.put("org.apache.logging.log4j.core.impl.Log4jContextFactory",
				"org.springframework.boot.logging.log4j2.Log4J2LoggingSystem");
		systems.put("java.util.logging.LogManager",
				"org.springframework.boot.logging.java.JavaLoggingSystem");
		SYSTEMS = Collections.unmodifiableMap(systems);
	}
	public static LoggingSystem get(ClassLoader classLoader) {
		String loggingSystem = System.getProperty(SYSTEM_PROPERTY);
		if (StringUtils.hasLength(loggingSystem)) {//你也通过org.springframework.boot.logging.LoggingSystem来特殊指定
			if (NONE.equals(loggingSystem)) {
				return new NoOpLoggingSystem();
			}
			return get(classLoader, loggingSystem);
		}
		return SYSTEMS.entrySet().stream()
				.filter((entry) -> ClassUtils.isPresent(entry.getKey(), classLoader))
				.map((entry) -> get(classLoader, entry.getValue())).findFirst()
				.orElseThrow(() -> new IllegalStateException(
						"No suitable logging system located"));//取第一个
	}    
}    
复制代码

这个其实就是 如果 有turboFilterList 数组，就开始 for循环处理，直到返回 FilterReply

for(int i = 0; i < len; ++i) {
    TurboFilter tf = (TurboFilter)tfa[i];
    FilterReply r = tf.decide(marker, logger, level, format, params, t);
    if (r == FilterReply.DENY || r == FilterReply.ACCEPT) {
        return r;
    }
}
复制代码

说那么多没什么用，应该怎么用呢？

删除了多余的东西（logback.xml）


<appender name="INFO-APPENDER" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <!-- 过滤器，记录info级别以上的日志 -->
    <filter class="com.xxx.demo.springboot.test.C">

    </filter>
   
</appender>
复制代码

启动之后给我报错

ERROR in ch.qos.logback.core.joran.util.PropertySetter@f6efaab - "com.xxx.demo.springboot.test.C" was loaded by [sun.misc.Launcher$AppClassLoader@18b4aac2].
	at org.springframework.boot.logging.logback.LogbackLoggingSystem.loadConfiguration(LogbackLoggingSystem.java:166)

复制代码

这就要说到 ClassLoader 的加载机制 这是因为

@Component
public class C extends TurboFilter {
    @Override
    public FilterReply decide(Marker marker, Logger logger, Level level, String s, Object[] objects, Throwable throwable) {
        return FilterReply.ACCEPT;
    }
}
复制代码

后面换成

@Component
public class C   extends AbstractMatcherFilter<ILoggingEvent> {


    @Override
    public FilterReply decide(ILoggingEvent iLoggingEvent) {
        return FilterReply.ACCEPT;
    }
}
复制代码

就好了，这个时候 你可能要问

不对啊，人家调用的时候 明明代码里是 转换成TurboFilter 执行的，我不是直接实现TurboFilter 就可以了么？

还真不是，这个里面还涉及一个加载的事

spi的加载 前面还是native

这里直接给结论，如果有兴趣可以后面写一篇

细节可以看 logback.qos.ch/manual/filt…

这就需要说到 Filter和TurboFilter 区别

  1. TurboFilter对象绑定到日志上下文。因此，它们不仅在使用给定的追加器时被调用，而且在每次发出日志记录请求时都被调用。它们的范围比附加过滤器更广。
  2. 它们在LoggingEvent对象创建之前被调用。TurboFilter对象不需要实例化日志事件来过滤日志请求。因此，turbo 过滤器用于高性能地过滤日志事件，甚至在事件创建之前。

其实就一句话 turbo在事件创建之前，不是一个功能

其实还没写完，但是真的累了。。。

有机会继续补全。。。。

总结

一句话 我认为 isDebugEnabled 还是要写的

java-tools Idea 插件 在完善，满足一些开发中使用的功能，写篇文章真的累 不行，我要去吃口饭了

作者：雨夜之寂
原文链接：https://juejin.cn/post/7176087632215015461
 

「已注销」
关注
  • 1
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Log4j2 - 日志框架中isDebugEnabled()的作用
weixin_30687587的博客
08-13 916
为什么要使用isDebugEnabled() 之前在系统的代码中发现有时候会在打印日志的时候先进行一次判断，如下： if (LOGGER.isDebugEnabled()) { LOGGER.debug("Search parameters: " + searchParams); } 我们使用的是Log4j2框架，框架自身提供了类似的许多api，比如isErrorEnabled(...
聊聊logback的isDebugEnabled
最新发布
go4it
11-12 499
本文主要研究一下logback的isDebugEnabled。
isDebugEnabled作用
热门推荐
water Wang
09-07 6万+
早上写了日志级别，然后想起在使用的时候经常用isDebugEnabled，一鼓作气。彻底弄懂它； 现象if (logger.isDebugEnabled()) { logger.debug(message); }作用 ： 进行预先判断，提升系统性能举个栗子：logger.debug("The money is " + getTotalMoney());  假设我们的日志级别设置为info,那
10_SpringBoot
Flandre_rokned的博客
08-31 238
10_SpringBoot
再论到底该不该写isDebugEnabled
FeelTouch Labs
11-14 993
历来的通用做法 if (log.isDebugEnabled()) { log.debug(... ...); } 那么为什么这样做呢？ 在N久以前，很多日志框架都不支持{}模板的写法(如Log4j1.X,Apache Commons Logging)，于是只能通过字符串拼接来输出日志内容： log.debug("hello, this is " + name); 这样一来...
isDebugEnabled 、isInfoEnabled 为什么要使用
iteye_17650的博客
08-24 1580
以前一直不明白为什么在输出日志前必须使用： if (log.isDebugEnabled())？？？ 在看下面的解释之前，我先说明下，对于打印的信息没有字符拼接或者对象（说白了没有tostring的方法调用），如果打印的信息是固定字符串的话，就加上面的判断和不加其实意义是一样的（更说白了，就是节省log.debug(***)中***部分向字符串的装换。下面是一位网友写的，他说明了比较纤细，我摘...
很好用的LOG封装，可同时输出类名，方法名，行数，可控制输出不输出
10-23
例如，可以设置一个全局的`isDebugEnabled`标志，当该标志为真时，才会打印DEBUG级别的日志信息。 3. **日志级别**：标准的日志系统通常有多个级别，如TRACE、DEBUG、INFO、WARN、ERROR和FATAL，每个级别对应不同的...
log4Net使用方法介绍
11-25
可以使用`log4net.Config.DOMConfigurator.Configure()`方法进行配置，并使用`log4net.Repository.Hierarchy.Logger.IsDebugEnabled`检查调试级别是否开启。 **七、总结** log4Net作为.NET平台的强大日志工具，其...
配置Log4J的一般步骤
09-15
首先下载log4j.jar,放在WEB-INF/lib下，然后新建一个log4j.properties文件。在文件中配置已下配置项。 1. 配置Logger组件 ...if(log.isDebugEnabled()){ log.debug("==log is enable========"); }
Unity3D重新封装Debug实现自主控制是否开启Debug输出
04-11
3. 封装Unity的Debug方法，如`Debug.Log`，在新的方法中添加条件判断，只有当`IsDebugEnabled`为true时，才调用原生的Debug方法输出信息。 4. 提供设置`IsDebugEnabled`状态的接口，允许在运行时动态切换调试开关。 ...
debug-flags:检查嵌套标志的环境变量 NODE_DEBUG 的简单方法
07-01
var isDebugEnabled = require ( 'debug-flags' ) ; isDebugEnabled ( 'app' ) ; // => true isDebugEnabled ( 'app:something:nested' ) ; // => true isDebugEnabled ( 'flag' ) ; // => false isDebugEnabled ( '...
springboot配置之在配置文件中配置debug=true 开启自动配置类报告
那就这样吧~
05-22 1948
启动项目，观察控制台： 将控制台的自动配置类报告随意的抽取出来一些： ============================ CONDITIONS EVALUATION REPORT 自动配置类报告 ============================ Positive matches: 生效的自动配置类 ----------------- CacheAutoConfiguration matched: - @ConditionalOnClass found req.
log4j与logback（简介，配置项解释，配置示例，使用说明）
weixin_42100211的博客
06-26 2118
log4j与logback简介，配置示例，使用说明，配置项解释
springboot
鞠晓健
06-03 272
springboot 运行机制 @SpringbootApplication 就是spring中 @Configuration 标注为配置类 @CompanentScan spring下注解 指定需要装配的组件 注册到容器中 @EnableAutoConfigurante 开始自动配置核心 @AutoConfigurantePackage 将主类所在的包作为自动配置的包进行管理 @Import 导入一个类到IOC容器中 根据mate-inf 下spri...
Log4j.xml配置
qq_33061377的博客
03-11 689
属性配置 &lt;properties&gt; &lt;!--${sys:LOG_HOME} jvm属性--&gt; &lt;property name="LOG_HOME"&gt;${sys:LOG_HOME}/app/logs&lt;/property&gt; &lt;/properties&gt; Appenders配置 name: Appenders名，后续通过name...
log.isDebugEnabled()的作用
weixin_44991038的博客
01-16 1774
log.isDebugEnabled()的作用
还在用log.isDebugEnabled()判断debug日志？你out了
qq_35785465的博客
04-19 2602
https://juejin.cn/post/7087847327578193957/
log4j配置(很详细)
一介那个书生的博客
08-26 2223
log4j讲解和配置
logger.isDebugEnabled()的作用
broucetrong的博客
12-07 2万+
logger.isDebugEnabled()的作用
isdebugenabled 如何关闭
05-31
isDebugEnabled 是 Java 中用于检查当前是否处于调试模式的方法。如果你想完全关闭调试模式，可以在代码中移除所有的调试相关语句，如日志输出、断点等。此外，可以在代码中添加条件判断，控制调试语句是否执行，例如： ``` if (isDebugEnabled) { // 调试相关代码 } ``` 将 isDebugEnabled 设为 false 可以关闭所有的调试语句。但是需要注意的是，在生产环境中关闭调试模式可能会影响代码的可维护性和调试性，因此建议仅在必要时关闭调试模式。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值