我要评论一、为什么要打印日志？
优秀的代码不仅要功能正确，更要具备良好的可维护性。而规范的日志打印，正是实现这一目标的关键要素之一。需要打印日志的目的有如下：
- 开发人员快速定位和修复bug
- 运维人员监控系统健康状况
- 业务人员追踪关键业务流程
- 安全人员审计系统操作行为
二、15 条日志建议
2.1 选择恰当的日志级别
一般情况下面都是用info和error级别的日志比较多，更多级别如下：
error：错误日志，指比较严重的错误，对正常业务有影响，需要运维配置监控的；
warn：警告日志，一般的错误，对业务影响不大，但是需要开发关注；
info：信息日志，记录排查问题的关键信息，如调用时间、出参入参等等；
debug：用于开发debug的，关键逻辑里面的运行时数据；
trace：最详细的信息，一般这些信息只记录到日志文件中。
2.2 打印方法的入参出参
我们并不需要打印很多很多日志，只需要打印可以快速定位问题的有效日志。有效的日志，是甩锅的利器:
哪些算得的上有效关键的日志呢？比如说，方法进来的时候，打印入参。再然后呢，在方法返回的时候，就是打印出参，返回值。入参的话，一般就是userid或者bizseq这些关键信息。
2.3 遇到if条件时，每个分支都打印日志
当你碰到if...else...或者switch这样的条件时，可以在分支的首行就打印日志，这样排查问题时，就可以通过日志，确定进入了哪个分支，代码逻辑更清晰，也更方便排查问题了。
if(user.isvip()){
log.info("该用户是会员,id:{},开始处理会员逻辑",user,getuserid());
//会员逻辑
}else{
log.info("该用户是非会员,id:{},开始处理非会员逻辑",user,getuserid())
//非会员逻辑
}2.4 日志开关判断
对于trace/debug这些比较低的日志级别，必须进行日志级别的开关判断。
user user = new user(666l, "公众号", "捡田螺的小男孩");
if (log.isdebugenabled()) {
log.debug("userid is: {}", user.getid());
}如果配置的日志级别是warn的话，上述日志不会打印，但是会执行字符串拼接操作，如果symbol是对象， 还会执行tostring()方法，浪费了系统资源，执行了上述操作，最终日志却没有打印，因此建议加日志开关判断。
2.5 建议使用日志框架slf4j中的api
建议不要直接使用日志系统（log4j、logback）中的 api，而是使用日志框架slf4j中的api。
slf4j 是门面模式的日志框架，有利于维护和各个类的日志处理方式统一，并且可以在保证不修改代码的情况下，很方便的实现底层日志框架的更换。
//使用 slf4j： import org.slf4j.logger; import org.slf4j.loggerfactory; private static final logger logger = loggerfactory.getlogger(tianluoboy.class); //使用 jcl： import org.apache.commons.logging.log; import org.apache.commons.logging.logfactory; private static final log log = logfactory.getlog(test.class);
2.6 建议用参数占位{}代替“+拼接“
- 使用
+操作符进行字符串的拼接，有一定的性能损耗。 - 使用大括号
{}来作为日志中的占位符，比于使用+操作符，更加优雅简洁。并且，相对于反例，使用占位符仅是替换动作，可以有效提升性能。
案例：
//反例
logger.info("processing trade with id: " + id + " and symbol: " + symbol);
//正例
logger.info("processing trade with id: {} and symbol : {} ", id, symbol); 2.7 建议异步输出日志
- 日志最终会输出到文件或者其它输出流中的，io性能会有要求的。如果异步，就可以显著提升io性能。
- 除非有特殊要求，要不然建议使用异步的方式来输出日志。以logback为例吧，要配置异步很简单，使用asyncappender就行
如：
<appender name="file_async" class="ch.qos.logback.classic.asyncappender">
<appender-ref ref="async"/>
</appender>2.8 不要使用e.printstacktrace()
理由：
- e.printstacktrace()打印出的堆栈日志跟业务代码日志是交错混合在一起的，通常排查异常日志不太方便。
- e.printstacktrace()语句产生的字符串记录的是堆栈信息，如果信息太长太多，字符串常量池所在的内存块没有空间了,即内存满了，那么，用户的请求就卡住啦~
案例：
//正例
try{
// 业务代码处理
}catch(exception e){
log.error("你的程序有异常啦",e);
}
//反例
try{
// 业务代码处理
}catch(exception e){
e.printstacktrace();
}2.9 异常日志要打印全面
反例1：
try {
//业务代码处理
} catch (exception e) {
// 错误
log.error('你的程序有异常啦');
} - 异常e都没有打印出来，所以压根不知道出了什么类型的异常。
反例2：
try {
//业务代码处理
} catch (exception e) {
// 错误
log.error('你的程序有异常啦：{}', e.getmessage());
} e.getmessage()不会记录详细的堆栈异常信息，只会记录错误基本描述信息，不利于排查问题。
正例：
try {
//业务代码处理
} catch (exception e) {
// 错误
log.error('你的程序有异常啦:{}', e.getmessage());
} 2.10 禁止在线上环境开启 debug
因为一般系统的debug日志会很多，并且各种框架中也大量使用 debug的日志，线上开启debug不久可能会打满磁盘，影响业务系统的正常运行。
2.11 选择合适的日志格式
在排查问题的时候，除了根据打印日志的关键字排查外，还有一个重要的信息就是时间节点。
理想的日志格式，应当包括这些最基本的信息：如当前时间戳（一般毫秒精确度）、日志级别，线程名字等等。在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> 2.12 不要打印又抛出相同异常信息
反例如下：
log.error("io exception", e);
throw new myexception(e);- 这样实现的话，通常会把栈信息打印两次。这是因为捕获了myexception异常的地方，还会再打印一次。
- 这样的日志记录，或者包装后再抛出去，不要同时使用！否则你的日志看起来会让人很迷惑
2.13 避免重复打印日志
避免重复打印日志，酱紫会浪费磁盘空间。如果你已经有一行日志清楚表达了意思，避免再冗余打印，反例如下：
if(user.isvip()){
log.info("该用户是会员,id:{}",user,getuserid());
//冗余，可以跟前面的日志合并一起
log.info("开始处理会员逻辑,id:{}",user,getuserid());
//会员逻辑
}else{
//非会员逻辑
}如果你是使用log4j日志框架，务必在log4j.xml中设置 additivity=false，因为可以避免重复打印日志。
2.14 日志文件分离
- 我们可以把不同类型的日志分离出去，比如access.log，或者error级别error.log，都可以单独fen打印到一个文件里面。
- 当然，也可以根据不同的业务模块，打印到不同的日志文件里，这样我们排查问题和做数据统计的时候，都会比较方便啦。
2.15 打印时禁止直接用 json 工具转换对象
说明：如果对象里某些 get 方法被覆写，存在抛出异常的情况，则可能会因为打印日志而影响正常业务流程的执行。
正例：打印日志时仅打印出业务相关属性值或者调用其对象的 tostring() 方法。
以上就是java实现日志打印的15条新手建议的详细内容，更多关于java日志打印建议的资料请关注代码网其它相关文章！
发表评论