打印 Logger 日志时,需不需要再封装一下工具类?

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: 在开发过程中,打印日志是必不可少的,因为日志关乎于应用的问题排查、应用监控等。现在打印日志一般都是使用 slf4j,因为使用日志门面,有助于打印方式统一,即使后面更换日志框架,也非常方便。在 《Java 开发手册》中也有相关的规约。

在开发过程中,打印日志是必不可少的,因为日志关乎于应用的问题排查、应用监控等。现在打印日志一般都是使用 slf4j,因为使用日志门面,有助于打印方式统一,即使后面更换日志框架,也非常方便。在 《Java 开发手册》中也有相关的规约。

所以在开发中,一般使用下面这种方式来打印日志。

LOGGER.info("print: {}", "this is the log");

不过有的应用会将 LOGGER 再封装一下,最终写成:

LoggerUtil.info(LOGGER, "print: {}", "this is the log");

本文的主要内容是讨论为什么要封装,有没有必要封装,以及怎样封装,如果小伙伴有更好的建议,可以提出,进行互相学习。

为什么要封装

很多人觉得 slf4j 本来就是日志门面,已经封装的很好了,为什么要多此一举,再额外封装一个 LoggerUtil 呢?

其实这块也是在开发规范中有说明的:

如果不进行封装,则会写成下面这种:

if (LOGGER.isInfoEnabled()) {
    LOGGER.info("print: {}", "this is the log");
}

所以,一般封装是将 if 判断这块逻辑统一封装为一个工具类。

可能到这里还有小伙伴不是很理解为什么要加 if 判断,可以看下下面这段代码:

可以看出转换逻辑这块相对比较复杂、耗时,在这里只是模拟的场景,实际使用可能会有其他情况,比如打印方法的出参入参、计算耗时等:

LOGGER.info("xxx 方法请求参数为:{}", JSON.toJSONString(req));
LOGGER.info("xxx 执行耗时:{}ms", System.currentTimeMillis() - startTime);

在某些场景下为了提高性能,需要关闭日志,比如大促,秒杀等等。

说到这里相信小伙伴已经看出问题了,因为这样写的话,当我关闭日志打印时,只是关闭了磁盘输出,但是耗时逻辑依然会继续执行。

# 日志级别调整到 error
logging.level.com.liuzhihang=error

这也是为什么在开发规范中建议大家手写判断,虽然日志框架中帮我们进行了判断,那只是避免了打印输出日志,实际上像组装日志,序列化实例对象等等还是会被执行的。

logback 框架中的判断逻辑

当然如果当前应用只有个位数的 tps 或者 tpm 那完全没必要考虑这些,也没必要因噎废食,正常使用就行。

该怎样封装

为了避免每次都要 if 判断的问题,会将 if 模块封装为工具类:

上面的封装,有效避免了每次都需要进行判断,只需要将代码中的打印日志换成 LogUtil 即可:

但是这种情况只能避免打印既有参数时的 if 判断,对方法类型的没有作用,这里就需要使用 Supplier

实际使用效果:

以上仅为一种封装方式,其他的封装可以自行考虑,比如整个日志框架都封装。

其他使用

这部分封装在 log4j-api-2.17.2.jar 中也有所体现,只不过 slf4j 里面并没有封装 Supplier 支持,详细实现可以自行阅读源码。

那为什么 slf4j 不支持,其实也是有讨论的,可以看 issue #70,里面进行了一系列讨论。

最终结果是在 2.0 支持了 Fluent Logging API 语法。

slf4j 2.0 使用

<!-- slf4j 2.0 依赖 -->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>2.0.1</version>
</dependency>
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-simple</artifactId>
    <version>2.0.0</version>
</dependency>

按照官方文档的使用案例直接使用即可:

logger.atDebug()
    .setMessage("Temperature set to {}. Old value was {}.")
    .addArgument(() -> t16()).addArgument(oldT)
    .log();

为什么要这样写,只能说是人家的 API 设计就是如此,当然也有其他的考虑,可以看看 github issue。具体使用哪种,用不用封装等等,这些都是根据自己的实际情况来使用。

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
目录
相关文章
|
3月前
|
运维 Linux Windows
[运维技术]PowerShell中实现一个最基本的日志器logger
[运维技术]PowerShell中实现一个最基本的日志器logger
63 1
|
4天前
|
消息中间件 监控 搜索推荐
OpenFeign日志组件Logger原理与应用
该文章详细解释了如何在OpenFeign中配置并使用请求和响应的GZIP压缩功能。
|
8天前
|
Java
OpenFeign 各种用法、 logger 日志记录
OpenFeign 各种用法、 logger 日志记录
21 0
|
2月前
|
监控 Linux 数据处理
深入了解Linux的logger命令:日志记录与监控
`logger`命令在Linux中用于向系统日志发送消息,便于记录系统事件和应用程序状态。它与`syslogd`配合,允许用户指定优先级、标识符和内容。简单易用,灵活适应不同日志需求。示例:`logger -p user.warning -t MYAPP &quot;A warning occurred.&quot;`。注意选择合适优先级,使用有意义的标识符,并结合其他工具如`logrotate`进行日志管理。
|
3月前
|
监控 安全 API
orhanobut/logger - 强大的Android日志打印库
orhanobut/logger - 强大的Android日志打印库
115 1
|
Java Spring
logger的日志笔记
logger的日志笔记
56 0
|
开发工具 git C++
Qt的简易日志库实现及封装
Qt的简易日志库实现及封装
|
7天前
|
SQL 存储 JSON
更快更强,SLS 推出高性能 SPL 日志查询模式
从海量的日志数据中,按照各种灵活的条件进行即时查询搜索,是可观测场景下的基本需求。本文介绍了 SLS 新推出的高性能 SPL 日志查询模式,支持 Unix 风格级联管道式语法,以及各种丰富的 SQL 处理函数。同时通过计算下推、向量化计算等优化,使得 SPL 查询可以在数秒内处理亿级数据,并支持 SPL 过滤结果分布图、随机翻页等特性。
252 66
|
5天前
|
数据采集 监控 数据安全/隐私保护
掌握Selenium爬虫的日志管理:调整–log-level选项的用法
在Selenium Web数据采集时,日志管理至关重要。通过调整`–log-level`参数可优化日志详细度,如设置为`INFO`记录一般操作信息。结合代理IP、Cookie及user-agent配置,不仅能提高采集成功率,还能规避反爬机制。合理选择日志级别有助于调试与性能平衡,在复杂的数据采集任务中保持程序稳定与可控。
掌握Selenium爬虫的日志管理:调整–log-level选项的用法

热门文章

最新文章