Java⽇志打印的15个好建议
⽬录
1. 选择恰当的⽇志级别
2. ⽇志要打印出⽅法的⼊参、出参
3. 选择合适的⽇志格式
4. 遇到if...等条件时，每个分⽀⾸⾏都尽量打印⽇志
5.⽇志级别⽐较低时，进⾏⽇志开关判断
6. 不能直接使⽤⽇志系统（Log4j、Logback）中的 API，⽽是使⽤⽇志框架SLF4J中的API。
7. 建议使⽤参数占位{}，⽽不是⽤+拼接。
8. 建议使⽤异步的⽅式来输出⽇志。
9. 不要使⽤e.printStackTrace()
10. 异常⽇志不要只打⼀半，要输出全部错误信息
11. 禁⽌在线上环境开启 debug
12.不要记录了异常，⼜抛出异常
13.避免重复打印⽇志
14.⽇志⽂件分离
15. 核⼼功能模块，建议打印较完整的⽇志
总结
1. 选择恰当的⽇志级别
常见的⽇志级别有5种，分别是error、warn、info、debug、trace。⽇常开发中，我们需要选择恰当的⽇志级别，不要反⼿就是打印info哈~
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⽇志⾥可以这么配置：
<appender name="STDOUT" class="ch.ConsoleAppender">
<encoder>
<pattern>%d{HH:mm:ss.SSS} %-5level [%thread][%logger{0}] %m%n</pattern>
</encoder>
</appender>
如果我们的⽇志格式，连当前时间都沒有记录，那连请求的时间点都不知道了？
4. 遇到if...等条件时，每个分⽀⾸⾏都尽量打印⽇志
当你碰到if...或者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: {}", Id());
}
因为当前有如下的⽇志代码：
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 = Logger(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就⾏
<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){
<("你的程序有异常啦",e);
}
理由：
e.printStackTrace()打印出的堆栈⽇志跟业务代码⽇志是交错混合在⼀起的，通常排查异常⽇志不太⽅便。
e.printStackTrace()语句产⽣的字符串记录的是堆栈信息，如果信息太长太多，字符串常量池所在的内存块没有空间了,
即内存满了，那么，⽤户的请求就卡住啦~
10. 异常⽇志不要只打⼀半，要输出全部错误信息
反例1：
try {
//业务代码处理
} catch (Exception e) {
// 错误
<('你的程序有异常啦');
}
异常e都没有打印出来，所以压根不知道出了什么类型的异常。
反例2：
log4j2 appendertry {
//业务代码处理
} catch (Exception e) {
// 错误
<('你的程序有异常啦', e.getMessage());
}
正例：
try {
//业务代码处理
} catch (Exception e) {
// 错误
<('你的程序有异常啦', e);
}
11. 禁⽌在线上环境开启 debug
禁⽌在线上环境开启debug，这⼀点⾮常重要。
因为⼀般系统的debug⽇志会很多，并且各种框架中也⼤量使⽤ debug的⽇志，线上开启debug不久可能会打满磁盘，影响业务系统的正常运⾏。
12.不要记录了异常，⼜抛出异常
反例如下：
<("IO exception", e);
throw new MyException(e);
这样实现的话，通常会把栈信息打印两次。这是因为捕获了MyException异常的地⽅，还会再打印⼀次。
这样的⽇志记录，或者包装后再抛出去，不要同时使⽤！否则你的⽇志看起来会让⼈很迷惑。
13.避免重复打印⽇志
避免重复打印⽇志，酱紫会浪费磁盘空间。如果你已经有⼀⾏⽇志清楚表达了意思，避免再冗余打印，反例如下：
if(user.isVip()){
log.info("该⽤户是会员,Id:{}",user,getUserId());
//冗余，可以跟前⾯的⽇志合并⼀起
log.info("开始处理会员逻辑,id:{}",user,getUserId());
//会员逻辑
}else{
//⾮会员逻辑
}
版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。
发表评论