北京西站地铁是几号线,做网络营销推广的公司,盐山县做网站价格,如何快速用手机做网站前言 日志是快速定位问题的好帮手#xff0c;是撕逼和甩锅的利器#xff01;打印好日志非常重要。今天我们来聊聊日志打印的15个好建议~1. 选择恰当的日志级别 常见的日志级别有5种#xff0c;分别是error、warn、info、debug、trace。日常开发中#xff0c;我们需要选择恰… 前言 日志是快速定位问题的好帮手是撕逼和甩锅的利器打印好日志非常重要。今天我们来聊聊日志打印的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 nameSTDOUT classch.qos.logback.core.ConsoleAppenderencoderpattern%d{HH:mm:ss.SSS} %-5level [%thread][%logger{0}] %m%n/pattern/encoder
/appender如果我们的日志格式连当前时间都沒有记录那连请求的时间点都不知道了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就行appender nameFILE_ASYNC classch.qos.logback.classic.AsyncAppenderappender-ref refASYNC/
/appender9. 不要使用e.printStackTrace() 反例try{// 业务代码处理
}catch(Exception e){e.printStackTrace();
}正例try{// 业务代码处理
}catch(Exception e){log.error(你的程序有异常啦,e);
}理由e.printStackTrace()打印出的堆栈日志跟业务代码日志是交错混合在一起的通常排查异常日志不太方便。e.printStackTrace()语句产生的字符串记录的是堆栈信息如果信息太长太多字符串常量池所在的内存块没有空间了,即内存满了那么用户的请求就卡住啦~10. 异常日志不要只打一半要输出全部错误信息 反例1try {//业务代码处理
} catch (Exception e) {// 错误LOG.error(你的程序有异常啦);
}异常e都没有打印出来所以压根不知道出了什么类型的异常。反例2try {//业务代码处理
} 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{//非会员逻辑
}如果你是使用log4j日志框架务必在log4j.xml中设置 additivityfalse因为可以避免重复打印日志正例logger namecom.taobao.dubbo.config additivityfalse14.日志文件分离 我们可以把不同类型的日志分离出去比如access.log或者error级别error.log都可以单独打印到一个文件里面。当然也可以根据不同的业务模块打印到不同的日志文件里这样我们排查问题和做数据统计的时候都会比较方便啦。15. 核心功能模块建议打印较完整的日志 我们日常开发中如果核心或者逻辑复杂的代码建议添加详细的注释以及较详细的日志。日志要多详细呢脑洞一下如果你的核心程序哪一步出错了通过日志可以定位到那就可以啦。-- end--往期推荐40 个 SpringBoot 常用注解让生产力爆表聊聊Spring事务失效的12种场景太坑了SpringBoot 中 4 大核心组件你了解多少
