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

反例：

lo Java 开源项目【ali1024.coding.net/public/P7/Java/git】 gger.info("Processing?trade?with?id:?"?+?id?+?"?and?symbol:?"?+?symbol);

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

正例如下：

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

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

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

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

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

<appender?name="FILE_ASYNC"?class="ch.qos.logback.classic.AsyncAppender">

<appender-ref?ref="ASYNC"/>

</appender>

9. 不要使用 e.printStackTrace()

反例：

try{

//?业务代码处理

}catch(Exception?e){

e.printStackTrace();

}

正例：

try{

//?业务代码处理

}catch(Exception?e){

log.error("你的程序有异常啦",e);

}

理由：

• e.printStackTrace()打印出的堆栈日志跟业务代码日志是交错混合在一起的，通常排查异常日志不太方便。

• e.printStackTrace()语句产生的字符串记录的是堆栈信息，如果信息太长太多，字符串常量池所在的内存块没有空间了,即内存满了，那么，用户的请求就卡住啦~

10. 异常日志不要只打一半，要输出全部错误信息

反例 1：

try?{

//业务代码处理

}?catch?(Exception?e)?{

//?错误

LOG.error('你的程序有异常啦');

}?

• 异常 e 都没有打印出来，所以压根不知道出了什么类型的异常。

反例 2：

try?{

//业务代码处理 《一线大厂 Java 面试题解析+后端开发学习笔记+最新架构讲解视频+实战项目源码讲义》开源

}?catch?(Exception?e)?{

//?错误

LOG.error('你的程序有异常啦',?e.getMessage());

}?

• e.getMessage()不会记录详细的堆栈异常信息，只会记录错误基本描述信息，不利于排查问题。

正例：

try?{

//业务代码处理

}?catch?(Exception?e)?{

//?错误

LOG.error('你的程序有异常啦',?e);

}?

11. 禁止在线上环境开启 debug

禁止在线上环境开启 debug，这一点非常重要。

因为一般系统的 debug 日志会很多，并且各种框架中也大量使用 debug 的日志，线上开启 debug 不久可能会打满磁盘，影响业务系统的正常运行。

12.不要记录了异常，又抛出异常

反例如下：

log.error("IO?exception",?e);

throw?new?MyException(e);

• 这样实现的话，通常会把栈信息打印两次。这是因为捕获了 MyException 异常的地方，还会再打印一次。

• 这样的日志记录，或者包装后再抛出去，不要同时使用！否则你的日志看起来会让人很迷惑。

13.避免重复打印日志

避免重复打印日志，酱紫会浪费磁盘空间。如果你已经有一行日志清楚表达了意思，避免再冗余打印，反例如下：

if(user.isVip()){

log.info("该用户是会员,Id:{}",user,getUserId());

//冗余，可以跟前面的日志合并一起

log.info("开始处理会员逻辑,id:{}",user,getUserId());

//会员逻辑

}else{

//非会员逻辑

最后

现在正是金三银四的春招高潮，前阵子小编一直在搭建自己的网站，并整理了全套的**【一线互联网大厂 Java 核心面试题库+解析】：包括 Java 基础、异常、集合、并发编程、JVM、Spring 全家桶、MyBatis、Redis、数据库、中间件 MQ、Dubbo、Linux、Tomcat、ZooKeeper、Netty 等等**