工作总结！日志打印的15个建议

• error：错误日志，指比较严重的错误，对正常业务有影响，需要运维配置监控的；

• warn：警告日志，一般的错误，对业务影响不大，但是需要开发关注；

• info：信息日志，记录排查问题的关键信息，如调用时间、出参入参等等；

• debug：用于开发DEBUG的，关键逻辑里面的运行时数据；

• trace：最详细的信息，一般这些信息只记录到日志文件中。

2. 日志要打印出方法的入参、出参

---

我们并不需要打印很多很多日志，只需要打印可以快速定位问题的有效日志。有效的日志，是甩锅的利器！

哪些算得的上有效关键的日志呢？比如说，方法进来的时候，打印入参。再然后呢，在方法返回的时候，就是打印出参，返回值。入参的话，一般就是userId或者bizSeq这些关键信息。正例如下：

public String testLogMethod(Document doc, Mode mode){

log.debug(“method enter param：{}”,userId);

String id = “666”;

log.debug(“method exit param：{}”,id);

return id;

}

3. 选择合适的日志格式

---

理想的日志格式，应当包括这些最基本的信息：如当前时间戳（一般毫秒精确度）、日志级别，线程名字等等。在logback日志里可以这么配置：

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

 

如果我们的日志格式，连当前时间都沒有记录，那连请求的时间点都不知道了？

4. 遇到if…else…等条件时，每个分支首行都尽量打印日志

---

当你碰到if…else…或者switch这样的条件时，可以在分支的首行就打印日志，这样排查问题时，就可以通过日志，确定进入了哪个分支，代码逻辑更清晰，也更方便排查问题了。

正例：

if(user.isVip()){

log.info(“该用户是会员,Id:{},开始处理会员逻辑”,user,getUserId());

//会员逻辑

}else{

log.info(“该用户是非会员,Id:{},开始处理非会员逻辑”,user,getUserId())

//非会员逻辑

}

5.日志级别比较低时，进行日志开关判断

---

对于trace/debug这些比较低的日志级别，必须进行日志级别的开关判断。

正例：

User user = new User(666L, “公众号”, “捡田螺的小男孩”);

if (log.isDebugEnabled()) {

log.debug(“userId is: {}”, user.getId());

}

因为当前有如下的日志代码：

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

如果配置的日志级别是warn的话，上述日志不会打印，但是会执行字符串拼接操作，如果symbol是对象， 还会执行toString()方法，浪费了系统资源，执行了上述操作，最终日志却没有打印，因此建议加日志开关判断。

6. 不能直接使用日志系统（Log4j、Logback）中的 API，而是使用日志框架SLF4J中的API。

---

SLF4J 是门面模式的日志框架，有利于维护和各个类的日志处理方式统一，并且可以在保证不修改代码的情况下，很方便的实现底层日志框架的更换。

正例：

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

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

7. 建议使用参数占位{}，而不是用+拼接。

---

反例：

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

上面的例子中，使用+操作符进行字符串的拼接，有一定的性能损耗。

正例如下：

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

我们使用了大括号{}来作为日志中的占位符，比于使用+操作符，更加优雅简洁。并且，相对于反例，使用占位符仅是替换动作，可以有效提升性能。

8. 建议使用异步的方式来输出日志。

---

• 日志最终会输出到文件或者其它输出流中的，IO性能会有要求的。如果异步，就可以显著提升IO性能。

• 除非有特殊要求，要不然建议使用异步的方式来输出日志。以logback为例吧，要配置异步很简单，使用AsyncAppender就行

9. 不要使用e.printStackTrace()

---

反例：

try{
自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注Java获取）

最后

分享一些系统的面试题，大家可以拿去刷一刷，准备面试涨薪。

这些面试题相对应的技术点：

• JVM
• MySQL
• Mybatis
• MongoDB
• Redis
• Spring
• Spring boot
• Spring cloud
• Kafka
• RabbitMQ
• Nginx
• …

大类就是：

• Java基础
• 数据结构与算法
• 并发编程
• 数据库
• 设计模式
• 微服务
• 消息中间件

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！
链图片转存中…(img-Pa5aFarD-1712914374225)]

[外链图片转存中…(img-6fHWQqMw-1712914374225)]

[外链图片转存中…(img-XxOjqQRs-1712914374225)]

[外链图片转存中…(img-TCBnGlMr-1712914374225)]

[外链图片转存中…(img-hxFda030-1712914374226)]

[外链图片转存中…(img-o9hwkqKz-1712914374226)]
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！