当前位置:首页 > 科技  > 软件

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

来源: 责编: 时间:2024-01-08 09:16:23 275观看
导读在Java编程中,良好的日志记录是一项重要的实践。无论是在调试代码还是在生产环境中追踪问题,准确的日志信息能够提供有价值的上下文和跟踪数据。然而,对于许多开发者来说,正确地记录日志可能是个挑战。本文介绍一些简单且

在Java编程中,良好的日志记录是一项重要的实践。无论是在调试代码还是在生产环境中追踪问题,准确的日志信息能够提供有价值的上下文和跟踪数据。然而,对于许多开发者来说,正确地记录日志可能是个挑战。T4228资讯网——每日最新资讯28at.com

本文介绍一些简单且实用的技巧,以帮助读者在Java编程中改善日志记录,使其更加高效和易于调试。T4228资讯网——每日最新资讯28at.com

1 选择适当的日志格式

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

<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">    <encoder>       <pattern>%d{HH:mm:ss.SSS} %-5level [%thread][%logger{0}] %m%n</pattern>    </encoder></appender>

如果开发者的日志格式不记录当前时间,那么甚至无法知道请求发生的时间。T4228资讯网——每日最新资讯28at.com

2 选择适当的日志级别

常见的日志级别有五个,分别是error、warn、info、debug和trace。在日常开发中,开发者需要选择适当的日志级别,不要直接打印info级别的日志。T4228资讯网——每日最新资讯28at.com

  • Error(错误):指相对严重的错误,会影响正常业务,并需要进行运维配置监控。
  • Warn(警告):一般的错误,对业务影响较小,但需要开发人员的注意。
  • Info(信息):记录关键的故障排查信息,例如调用时间、输入输出参数等。
  • Debug(调试):用于开发阶段的关键逻辑的运行时数据。
  • Trace(追踪):最详细的信息,一般只在日志文件中记录。

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

对于较低的日志级别,如trace/debug级别,必须进行日志级别开关判断。T4228资讯网——每日最新资讯28at.com

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

由于目前存在以下日志代码:T4228资讯网——每日最新资讯28at.com

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

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

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

开发人员不需要打印大量的日志,只需要打印能够快速定位问题的有效日志。什么是有效和关键的日志呢?T4228资讯网——每日最新资讯28at.com

  • 输入方法时,打印输入参数。
  • 方法返回时,打印出参数和返回值。

就参数而言,通常是关键信息,比如userId等。T4228资讯网——每日最新资讯28at.com

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

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

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

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

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

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

以上代码示例在每个分支的第一行使用日志打印。T4228资讯网——每日最新资讯28at.com

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

错误的用法:T4228资讯网——每日最新资讯28at.com

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

在上面的例子中,使用 + 运算符来拼接字符串会带来一定的性能损失。T4228资讯网——每日最新资讯28at.com

正确的用法:T4228资讯网——每日最新资讯28at.com

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

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

8 不要使用e.printStackTrace()

错误的用法:T4228资讯网——每日最新资讯28at.com

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

正确的用法:T4228资讯网——每日最新资讯28at.com

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

使用e.printStackTrace()打印的堆栈日志与业务代码日志交织在一起,通常不方便检查异常日志。T4228资讯网——每日最新资讯28at.com

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

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

日志最终会输出到文件或其他输出流中,这涉及到IO性能。如果采用异步方式,可以显著提高IO性能。T4228资讯网——每日最新资讯28at.com

除非有特殊要求,建议使用异步方式输出日志。以logback为例,配置异步非常简单,只需使用AsyncAppender:T4228资讯网——每日最新资讯28at.com

<appender name="FILE_ASYNC" class="ch.qos.logback.classic.AsyncAppender">    <appender-ref ref="ASYNC"/></appender>

以上配置使用AsyncAppender来实现异步输出日志。T4228资讯网——每日最新资讯28at.com

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

在联机环境中禁用调试功能非常重要。T4228资讯网——每日最新资讯28at.com

因为通常系统会有大量的调试日志,各种框架也会大量使用调试日志,在线调试可能会很快填满磁盘,影响业务系统的正常运行。T4228资讯网——每日最新资讯28at.com

本文链接:http://www.28at.com/showinfo-26-57889-0.html十个Java编程中记录日志的小技巧

声明:本网页内容旨在传播知识,若有侵权等问题请及时与本网联系,我们将在第一时间删除处理。邮件:2376512515@qq.com

上一篇: Golang流水线设计模式实践

下一篇: 别被前端框架 PUA 了!

标签:
  • 热门焦点
  • 5月安卓手机好评榜:魅族20 Pro夺冠

    性能榜和性价比榜之后,我们来看最后的安卓手机好评榜,数据来源安兔兔评测,收集时间2023年5月1日至5月31日,仅限国内市场。第一名:魅族20 Pro好评率:97.50%不得不感慨魅族老品牌还
  • 5月iOS设备好评榜:iPhone 14仅排第43?

    来到新的一月,安兔兔的各个榜单又重新汇总了数据,像安卓阵营的榜单都有着比较大的变动,不过iOS由于设备的更新换代并没有那么快,所以相对来说变化并不大,特别是iOS好评榜,老款设
  • 跑分安卓第一!Redmi K60至尊版8月发布!卢伟冰:目标年度性能之王

    8月5日消息,Redmi K60至尊版将于8月发布,在此前举行的战略发布会上,官方该机将搭载搭载天玑9200+处理器,安兔兔V10跑分超177万分,是目前安卓阵营最高的分数
  • JavaScript 混淆及反混淆代码工具

    介绍在我们开始学习反混淆之前,我们首先要了解一下代码混淆。如果不了解代码是如何混淆的,我们可能无法成功对代码进行反混淆,尤其是使用自定义混淆器对其进行混淆时。什么是混
  • Automa-通过连接块来自动化你的浏览器

    1、前言通过浏览器插件可实现自动化脚本的录制与编写,具有代表性的工具就是:Selenium IDE、Katalon Recorder,对于简单的业务来说可快速实现自动化的上手工作。Selenium IDEKat
  • Temu起诉SHEIN,跨境电商战事升级

    来源 | 伯虎财经(bohuFN)作者 | 陈平安日前据外媒报道,拼多多旗下跨境电商平台Temu正对竞争对手SHEIN提起新诉讼,诉状称Shein&ldquo;利用市场支配力量强迫服装厂商与之签订独家
  • 信通院:小米、华为等11家应用商店基本完成APP签名及验签工作

    中国信通院表示,目前,小米、华为、OPPO、vivo、360手机助手、百度手机助手、应用宝、豌豆荚和努比亚等9家应用商店,以及抖音和快手2家新型应用分发平
  • 滴滴违法违规被罚80.26亿 共存在16项违法事实

    滴滴违法违规被罚80.26亿 存在16项违法事实开始于2121年7月,历经一年时间,网络安全审查办公室对“滴滴出行”网络安全审查终于有了一个暂时的结束。据“网信
  • 利用职权私自解除被封帐号 Meta开除20多名员工

    11月18日消息,据外媒援引知情人士表示,过去一年时间内,Facebook母公司Meta解雇或处罚了20多名员工以及合同工,指控这些人通过内部系统以不当方式重置用户帐号,其
Top