一、选择恰当的日志级别

常见的日志级别有5种，分别是error、warn、info、debug、trace。

  • error：错误日志，指比较严重的错误，对正常业务有影响，需要运维配置监控的；
  • warn：警告日志，一般的错误，对业务影响不大，但是需要开发关注；
  • info：信息日志，记录排查问题的关键信息，如调用时间、出参入参等等；
  • debug：用于开发DEBUG的，关键逻辑里面的运行时数据；
  • trace：最详细的信息，一般这些信息只记录到日志文件中。

    二. 日志要打印出方法的入参、出参

    我们并不需要打印很多很多日志，只需要打印可以快速定位问题的有效日志

    三、选择合适的日志格式

    理想的日志格式，应当包括这些最基本的信息：如当前时间戳（一般毫秒精确度）、日志级别，线程名字等等。在logback日志里可以这么配置：
    1. <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    2.   <encoder>
    3.       <pattern>%d{HH:mm:ss.SSS} %-5level [%thread][%logger{0}] %m%n</pattern>
    4.   </encoder>
    5. </appender>

    四、遇到if…else…等条件时，每个分支首行都尽量打印日志

    这样排查问题时，就可以通过日志，确定进入了哪个分支，代码逻辑更清晰，也更方便排查问题了

    五、日志级别比较低时，进行日志开关判断

    六、不能直接使用日志系统（Log4j、Logback）中的 API，而是使用日志框架SLF4J中的API。

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

private static final Logger logger = LoggerFactory.getLogger(TianLuoBoy.class);

<a name="D9Nlk"></a>
# 七、建议使用参数占位{}，而不是用+拼接。
反例：

logger.info(“Processing trade with id: “ + id + “ and symbol: “ + symbol);

上面的例子中，使用+操作符进行字符串的拼接，有一定的**性能损耗。**<br />正例如下：

logger.info(“Processing trade with id: {} and symbol : {} “, id, symbol); 

我们使用了大括号{}来作为日志中的占位符，比于使用+操作符，更加优雅简洁。并且，**相对于反例**，使用占位符仅是替换动作，可以有效提升性能。
<a name="S9ryB"></a>
# 八、建议使用异步的方式来输出日志

- 日志最终会输出到文件或者其它输出流中的，IO性能会有要求的。如果异步，就可以显著提升IO性能。
- 除非有特殊要求，要不然建议使用异步的方式来输出日志。以logback为例吧，要配置异步很简单，使用AsyncAppender就行


<a name="fGGLM"></a>
# 九、不要使用e.printStackTrace()
反例:

try{ // 业务代码处理 }catch(Exception e){ e.printStackTrace(); }

正例：

try{ // 业务代码处理 }catch(Exception e){ log.error(“你的程序有异常啦”,e); } ```

  • e.printStackTrace()打印出的堆栈日志跟业务代码日志是交错混合在一起的，通常排查异常日志不太方便。

  • e.printStackTrace()语句产生的字符串记录的是堆栈信息，如果信息太长太多，字符串常量池所在的内存块没有空间了,即内存满了，那么，用户的请求就卡住啦~

    十、禁止在线上环境开启 debug

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

    十一、日志文件分离

  • 我们可以把不同类型的日志分离出去，比如access.log，或者error级别error.log，都可以单独打印到一个文件里面。

  • 当然，也可以根据不同的业务模块，打印到不同的日志文件里，这样我们排查问题和做数据统计的时候，都会比较方便啦。

    十二、核心功能模块，建议打印较完整的日志

  • 我们日常开发中，如果核心或者逻辑复杂的代码，建议添加详细的注释，以及较详细的日志。

  • 日志要多详细呢？脑洞一下，如果你的核心程序哪一步出错了，通过日志可以定位到，那就可以啦。