怎么写好日志【摘抄自两篇文章】

2022-05-17 23:04:35 阅读：169 来源： 互联网

选择恰当的日志级别

常见的日志级别有5种，分别是error、warn、info、debug、trace。日常开发中，我们需要选择恰当的日志级别，不要反手就是打印info。
- error：错误日志，指比较严重的错误
  - 对正常业务有影响，需要运维配置监控的；
  - 影响到程序正常运行、当前请求正常运行的异常情况:
  1. 打开配置文件失败
  2. 所有第三方对接的异常(包括第三方返回错误码)
  3. 所有影响功能使用的异常，包括:SQLException和除了业务异常之外的所有异常(RuntimeException和Exception)
- warn：警告日志，一般的错误，
  - 对业务影响不大，但是需要开发关注；
  - 不应该出现但是不影响程序、当前请求正常运行的异常情况
  1. 有容错机制的时候出现的错误情况
  2. 找不到配置文件，但是系统能自动创建配置文件
  即将接近临界值的时候，例如：缓存池占用达到警告线
  
  业务异常的记录,比如：当接口抛出业务异常时，应该记录此异常
- info：信息日志，记录排查问题的关键信息，如调用时间、出参入参等等；
  - 并不是所有的service都进行出入口打点记录,单一、简单service是没有意义的(job除外,job需要记录开始和结束,)。
  - 对于复杂的业务逻辑，需要进行日志打点，以及埋点记录，比如电商系统中的下订单逻辑，以及OrderAction操作(业务状态变更)。
  - 对于整个系统的提供出的接口(REST/WS)，使用info记录入参
  - 如果所有的service为SOA架构，那么可以看成是一个外部接口提供方，那么必须记录入参。
  - 调用其他第三方服务时，所有的出参和入参是必须要记录的(因为你很难追溯第三方模块发生的问题)
- debug：用于开发DEBUG的，关键逻辑里面的运行时数据；
- trace：最详细的信息，一般这些信息只记录到日志文件中。
日志要打印出方法的入参、出参

我们并不需要打印很多日志，只需要打印可以快速定位问题的有效日志。哪些算得的上有效关键的日志呢？比如说，方法进来的时候，打印入参。再然后呢，在方法返回的时候，就是打印出参，返回值。
选择合适的日志格式

理想的日志格式，应当包括这些最基本的信息：如当前时间戳（一般毫秒精确度）、日志级别，线程名字等等。在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> 
```
遇到if...else...等条件时，每个分支首行都尽量打印日志

当你碰到if...else...或者switch这样的条件时，可以在分支的首行就打印日志，这样排查问题时，就可以通过日志，确定进入了哪个分支，代码逻辑更清晰，也更方便排查问题了。
```
if(user.isVip()){
  log.info("该用户是会员,Id:{},开始处理会员逻辑",user,getUserId());
  //会员逻辑
}else{
  log.info("该用户是非会员,Id:{},开始处理非会员逻辑",user,getUserId())
  //非会员逻辑
}
```
日志级别比较低时，进行日志开关判断

对于trace/debug这些比较低的日志级别，必须进行日志级别的开关判断。如果配置的日志级别是warn的话，debug日志不会打印，但是会执行字符串拼接操作；浪费了系统资源，执行了操作，最终日志却没有打印，因此建议加日志开关判断。
不能直接使用日志系统（Log4j、Logback）中的 API，而是使用日志框架SLF4J中的API

SLF4J 是门面模式的日志框架，有利于维护和各个类的日志处理方式统一，并且可以在保证不修改代码的情况下，很方便的实现底层日志框架的更换。实现方式统一使用: Logback框架.
```
import org.slf4j.Logger; 
import org.slf4j.LoggerFactory;

private static final Logger logger = LoggerFactory.getLogger(TianLuoBoy.class);
```
建议使用参数占位{}，而不是用+拼接

反例：
```
logger.info("Processing trade with id: " + id + " and symbol: " + symbol);
```
上面的例子中，使用+操作符进行字符串的拼接，有一定的性能损耗。

正例：
```
logger.info("Processing trade with id: {} and symbol : {} ", id, symbol); 
```
使用大括号{}来作为日志中的占位符，比于使用+操作符，更加优雅简洁。并且，相对于反例，使用占位符仅是替换动作，可以有效提升性能。

使用参数占位{}的技巧：使用[]进行参数变量隔离

如有参数变量，应该写成如下写法:
```
logger.debug("Processing trade with id:[{}] and symbol : [{}] ", id, symbol);
```
这样的格式写法，可读性更好，对于排查问题更有帮助。
建议使用异步的方式来输出日志
- 日志最终会输出到文件或者其它输出流中的，IO性能会有要求的。如果异步，就可以显著提升IO性能。
- 除非有特殊要求，要不然建议使用异步的方式来输出日志。以logback为例吧，要配置异步很简单，使用AsyncAppender就行
```
<appender name="FILE_ASYNC" class="ch.qos.logback.classic.AsyncAppender">
    <appender-ref ref="ASYNC"/>
</appender>
```
不要使用e.printStackTrace()

反例：
```
try{
  // 业务代码处理
}catch(Exception e){
  e.printStackTrace();
}
```
正例：
```
try{
  // 业务代码处理
}catch(Exception e){
  log.error("你的程序有异常啦",e);
}
```
- e.printStackTrace()打印出的堆栈日志跟业务代码日志是交错混合在一起的，通常排查异常日志不太方便。
- e.printStackTrace()语句产生的字符串记录的是堆栈信息，如果信息太长太多，字符串常量池所在的内存块没有空间了,即内存满了，那么，用户的请求就卡住啦~

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

反例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);
}

禁止在线上环境开启 debug

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

反例：
```
log.error("IO exception", e);
throw new MyException(e);
```
- 这样实现的话，通常会把栈信息打印两次。这是因为捕获了MyException异常的地方，还会再打印一次。
- 这样的日志记录，或者包装后再抛出去，不要同时使用！否则你的日志看起来会让人很迷惑。
- 如果进行了抛出异常操作，请不要记录error日志，由最终处理方进行处理。
避免重复打印日志

避免重复打印日志，否则会浪费磁盘空间。如果你已经有一行日志清楚表达了意思，避免再冗余打印，反例如下：
```
if(user.isVip()){
  log.info("该用户是会员,Id:{}",user,getUserId());
  //冗余，可以跟前面的日志合并一起
  log.info("开始处理会员逻辑,id:{}",user,getUserId());
  //会员逻辑
}else{
  //非会员逻辑
}
```
如果你是使用log4j日志框架，务必在log4j.xml中设置 additivity=false，因为可以避免重复打印日志.

例如：
```
<logger name="com.taobao.dubbo.config" additivity="false"> 
```
日志文件分离
核心功能模块，建议打印较完整的日志
- 日常开发中，如果核心或者逻辑复杂的代码，建议添加详细的注释，以及较详细的日志。
  
  日志要多详细呢？脑洞一下，如果你的核心程序哪一步出错了，通过日志可以定位到，那就可以啦。

标签：info,记录,两篇,打印,摘抄,debug,日志,异常
来源： https://www.cnblogs.com/yu-zexin/p/16282756.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9

怎么写好日志【摘抄自两篇文章】