前言
日志是快速定位问题的好帮手，是撕逼和甩锅的利器！打印好日志非常重要。今天我们来聊聊日志打印的 15 个好建议~
1. 选择恰当的日志级别
常见的日志级别有5种，分别是 error、warn、info、debug、trace。日常开发中，我们需要选择恰当的日志级别，不要反手就是打印 info 哈~
error：错误日志，指比较严重的错误，对正常业务有影响，需要运维配置监控的；
warn：警告日志，一般的错误，对业务影响不大，但是需要开发关注；
info：信息日志，记录排查问题的关键信息，如调用时间、出参入参等等；
debug：用于开发DEBUG的，关键逻辑里面的运行时数据；
trace：最详细的信息，一般这些信息只记录到日志文件中。
2. 日志要打印出方法的入参、出参
我们并不需要打印很多很多日志，只需要打印可以快速定位问题的有效日志。有效的日志，是甩锅的利器！
哪些算得的上有效关键的日志呢？比如说，方法进来的时候，打印入参。再然后呢，在方法返回的时候，就是打印出参，返回值。入参的话，一般就是 userId 或者 bizSeq 这些关键信息。正例如下：
publicString testLogMethod(Document doc, Mode mode){
log.debug(“method enter param：{}”,userId);
String id = "666";
log.debug(“method exitparam：{}”,id);
returnid;
}
3. 选择合适的日志格式
理想的日志格式，应当包括这些最基本的信息：如当前时间戳（一般毫秒精确度）、日志级别，线程名字等等。在 logback 日志里可以这么配置：
<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>
如果我们的日志格式，连当前时间都沒有记录，那连请求的时间点都不知道了？
4. 遇到 if...else... 等条件时，每个分支首行都尽量打印日志
当你碰到if...else...或者switch这样的条件时，可以在分支的首行就打印日志，这样排查问题时，就可以通过日志，确定进入了哪个分支，代码逻辑更清晰，也更方便排查问题了。
正例 1
if(user.isVip){
log.info( "该用户是会员,Id:{},开始处理会员逻辑",user,getUserId);
//会员逻辑
} else{
log.info( "该用户是非会员,Id:{},开始处理非会员逻辑",user,getUserId)
//非会员逻辑
}
5. 日志级别比较低时，进行日志开关判断
对于 trace/debug 这些比较低的日志级别，必须进行日志级别的开关判断。
正例 2
User user = newUser( 666L, "捡田螺的小男孩");
if( log.isDebugEnabled) {
log.debug( "userId is: {}", user.getId);
}
因为当前有如下的日志代码：
logger.debug("Processing trade withid: " + id + "andsymbol: " + symbol);
如果配置的日志级别是 warn 的话，上述日志不会打印，但是会执行字符串拼接操作，如果 symbol 是对象， 还会执行 toString 方法，浪费了系统资源，执行了上述操作，最终日志却没有打印，因此建议加日志开关判断。
6. 不能直接使用日志系统（Log4j、Logback）中的 API，而是使用日志框架 SLF4J 中的 API。
SLF4J 是门面模式的日志框架，有利于维护和各个类的日志处理方式统一，并且可以在保证不修改代码的情况下，很方便的实现底层日志框架的更换。
正例
importorg.slf4j.Logger;
importorg.slf4j.LoggerFactory;
privatestaticfinalLoggerlogger = LoggerFactory.getLogger( TianLuoBoy. class);
7. 建议使用参数占位 {}，而不是用 + 拼接。
反例
logger.info("Processing trade withid: " + id + "andsymbol: " + symbol);
上面的例子中，使用+操作符进行字符串的拼接，有一定的性能损耗。
正例如下：
logger.info(" Processingtradewithid: {} andsymbol: {} ", id, symbol);
我们使用了大括号 {} 来作为日志中的占位符，比于使用 + 操作符，更加优雅简洁。并且，相对于反例，使用占位符仅是替换动作，可以有效提升性能。
8. 建议使用异步的方式来输出日志。
日志最终会输出到文件或者其它输出流中的，IO 性能会有要求的。如果异步，就可以显著提升 IO 性能。
除非有特殊要求，要不然建议使用异步的方式来输出日志。以 logback 为例吧，要配置异步很简单，使用 AsyncAppender 就行.
<appender name= "FILE_ASYNC"class= "ch.qos.logback.classic.AsyncAppender"> < appender-refref= "ASYNC"/> </ appender>
9. 不要使用 e.printStackTrace
反例
try{ // 业务代码处理} catch( Exceptione){ e.printStackTrace;}
正例
try{ // 业务代码处理} catch(Exception e){ log.error( "你的程序有异常啦",e); }
理由
e.printStackTrace 打印出的堆栈日志跟业务代码日志是交错混合在一起的，通常排查异常日志不太方便。
e.printStackTrace 语句产生的字符串记录的是堆栈信息，如果信息太长太多，字符串常量池所在的内存块没有空间了,即内存满了，那么，用户的请求就卡住啦~
10. 异常日志不要只打一半，要输出全部错误信息
反例 1
try{ //业务代码处理} catch( Exceptione) { // 错误LOG.error( '你的程序有异常啦'); }
异常 e 都没有打印出来，所以压根不知道出了什么类型的异常。
反例 2
try{ //业务代码处理} catch( Exceptione) { // 错误LOG.error( '你的程序有异常啦', e.getMessage); }
e.getMessage 不会记录详细的堆栈异常信息，只会记录错误基本描述信息，不利于排查问题。
正例
try{
//业务代码处理} catch( Exceptione) { // 错误LOG.error( '你的程序有异常啦', e); }
11. 禁止在线上环境开启 debug
禁止在线上环境开启 debug，这一点非常重要。
因为一般系统的 debug 日志会很多，并且各种框架中也大量使用 debug 的日志，线上开启 debug 不久可能会打满磁盘，影响业务系统的正常运行。
12. 不要记录了异常，又抛出异常
反例如下：
log.error( "IO exception", e); thrownewMyException(e);
这样实现的话，通常会把栈信息打印两次。这是因为捕获了 MyException 异常的地方，还会再打印一次。
这样的日志记录，或者包装后再抛出去，不要同时使用！否则你的日志看起来会让人很迷惑。
13. 避免重复打印日志
避免重复打印日志，酱紫会浪费磁盘空间。如果你已经有一行日志清楚表达了意思，避免再冗余打印，反例如下：
if(user.isVip){ log.info( "该用户是会员,Id:{}",user,getUserId); //冗余，可以跟前面的日志合并一起log.info( "开始处理会员逻辑,id:{}",user,getUserId); //会员逻辑} else{ //非会员逻辑}
如果你是使用 log4j 日志框架，务必在 log4j.xml 中设置 additivity=false，因为可以避免重复打印日志。
正例：
< loggername= "com.taobao.dubbo.config"additivity= "false">
14. 日志文件分离
我们可以把不同类型的日志分离出去，比如 access.log，或者 error 级别 error.log，都可以单独打印到一个文件里面。
当然，也可以根据不同的业务模块，打印到不同的日志文件里，这样我们排查问题和做数据统计的时候，都会比较方便啦。
15. 核心功能模块，建议打印较完整的日志
我们日常开发中，如果核心或者逻辑复杂的代码，建议添加详细的注释，以及较详细的日志。
日志要多详细呢？脑洞一下，如果你的核心程序哪一步出错了，通过日志可以定位到，那就可以啦。
- EOF -
点击标题可跳转
1、 JetBrains 首席语言设计师：我们将如何让 Kotlin 再活几十年
2、 大多数 Java 开发者计划在明年内过渡到 Java 17
3、 Android 是怎么捕捉 Java 异常的？
看完本文有收获？请分享给更多人
推荐关注「Java开发精选」，提升Java开发技术
点赞和在看就是最大的支持❤️
温馨提示
2. 分享目的仅供大家学习和交流，您必须在下载后24小时内删除！
3. 不得使用于非法商业用途，不得违反国家法律。否则后果自负！
4. 本站提供的源码、模板、插件等等其他资源，都不包含技术服务请大家谅解！
5. 如有链接无法下载、失效或广告，请后台提交工单处理！
6. 本站资源售价只是赞助，收取费用仅维持本站的日常运营所需！
7. 如遇到加密压缩包，请使用WINRAR解压,如遇到无法解压的请后台提交工单！
【免责声明】：
本站所发布的一切资源仅限用于学习和研究目的；不得将上述内容用于商业或者非法用途，否则，一切后果请用户自负。本站信息来自网络，版权争议与本站无关。您必须在下载后的24个小时之内，从您的电脑中彻底删除上述内容。如果您喜欢该程序，请支持正版软件，购买注册，得到更好的正版服务。
【关于转载】：
本站尊重互联网版权体系，本站部分图片、文章大部分转载于互联网、所有内容不代表本站观点、不对文章中的任何观点负责、转载的目的只用于给网民提供信息阅读，无任何商业用途，所有内容版权归原作者所有
如本站（文章、内容、图片、视频）任何资料有侵权，先说声抱歉；麻烦您请联系请后台提交工单，我们会立即删除、维护您的权益。非常感谢您的理解。
【附】:
二○○二年一月一日《计算机软件保护条例》第十七条规定：为了学习和研究软件内含的设计思想和原理，通过安装、显示、传输或者存储软件等方式使用软件的，可以不经软件著作权人许可，不向其支付报酬！鉴于此，也希望大家按此说明研究软件！
注：本站资源来自网络转载，版权归原作者和公司所有，如果有侵犯到您的权益，请第一时间联系我们处理！
-----------------------------------------------------------------------------------------------------------
【版权声明】：
一、本站致力于为源码爱好者提供国内外软件开发技术和软件共享，着力为用户提供优资资源。
二、本站提供的源码下载文件为网络共享资源，请于下载后的24小时内删除。如需体验更多乐趣，还请支持正版。
三、如有内容侵犯您的版权或其他利益的，请编辑邮件并加以说明发送到站长邮箱。站长会进行审查之后，情况属实的会在三个工作日内为您删除。
-----------------------------------------------------------------------------------------------------------
源码村资源网 » 怎样看懂系统日志内容(如何查看系统日志的具体操作内容)
1 评论