文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

十个Java编程中记录日志的小技巧

2024-11-30 03:22

关注

本文介绍一些简单且实用的技巧,以帮助读者在Java编程中改善日志记录,使其更加高效和易于调试。

1 选择适当的日志格式

理想的日志格式应包含最基本的信息,例如当前时间戳(通常精确到毫秒)、日志级别、线程名称等。可以像下面这样配置logback日志:


    
       %d{HH:mm:ss.SSS} %-5level [%thread][%logger{0}] %m%n
    

如果开发者的日志格式不记录当前时间,那么甚至无法知道请求发生的时间。

2 选择适当的日志级别

常见的日志级别有五个,分别是error、warn、info、debug和trace。在日常开发中,开发者需要选择适当的日志级别,不要直接打印info级别的日志。

3 当日志级别较低时,进行日志开关判断

对于较低的日志级别,如trace/debug级别,必须进行日志级别开关判断。

User user = new User(666L, "demo");
if (log.isDebugEnabled()) {
    log.debug("userId is: {}", user.getId());
}

由于目前存在以下日志代码:

logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);

如果配置的日志级别是warn,上述日志将不会被打印,但仍会执行字符串拼接操作。如果符号是对象,还将执行toString()方法,这会浪费系统资源。尽管进行了上述操作,但最终日志并未打印出来,因此建议添加日志开关判断。

4 日志应打印出该方法的输入和输出参数

开发人员不需要打印大量的日志,只需要打印能够快速定位问题的有效日志。什么是有效和关键的日志呢?

就参数而言,通常是关键信息,比如userId等。

5 日志系统中的API(如Log4j、Logback)不能直接使用,但可以使用日志框架SLF4J中的API

SLF4J是一个以门面模式(facade mode)工作的日志框架,有利于统一各个类的维护和日志处理方法,而且可以轻松替换底层的日志框架且不需要修改代码。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

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

6 当遇到诸如 if...else... 或 switch 等条件语句时,尽量在每个分支的第一行打印日志

当遇到 if...else... 或 switch 等条件语句时,应尽量在分支的第一行打印日志,这样在排查问题时,可以通过日志确定进入了哪个分支,代码逻辑更清晰,也更容易排查问题。

if (user.isVip()) {
  log.info("User isVip, Id: {}", user.getUserId());
} else {
  log.info("User not isVip, Id: {}", user.getUserId());
}

以上代码示例在每个分支的第一行使用日志打印。

7 建议使用参数占位符 {} 代替 + 进行字符串拼接

错误的用法:

logger.info("Processing trade with id: " + id + " and symbol: " + symbol);

在上面的例子中,使用 + 运算符来拼接字符串会带来一定的性能损失。

正确的用法:

logger.info("Processing trade with id: {} and symbol: {}", id, symbol);

在日志中使用花括号 {} 作为占位符,这比使用 + 运算符更加优雅和简洁。与负面示例相比,占位符的使用只是一个替换操作,可以有效提高性能。

8 不要使用e.printStackTrace()

错误的用法:

try {
  ...
} catch (Exception e) {
  e.printStackTrace();
}

正确的用法:

try {
  ...
} catch (Exception e) {
  log.error("error", e);
}

使用e.printStackTrace()打印的堆栈日志与业务代码日志交织在一起,通常不方便检查异常日志。

e.printStackTrace()语句生成的字符串记录了堆栈信息。如果信息过长,字符串常量池所在的内存块没有空间,也就是内存已满,那么用户的请求会被阻塞。

9 建议以异步方式输出日志

日志最终会输出到文件或其他输出流中,这涉及到IO性能。如果采用异步方式,可以显著提高IO性能。

除非有特殊要求,建议使用异步方式输出日志。以logback为例,配置异步非常简单,只需使用AsyncAppender:


    

以上配置使用AsyncAppender来实现异步输出日志。

10 禁止在联机环境中启用调试功能

在联机环境中禁用调试功能非常重要。

因为通常系统会有大量的调试日志,各种框架也会大量使用调试日志,在线调试可能会很快填满磁盘,影响业务系统的正常运行。

来源:Java学研大本营内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯