新征程软件技术平台

# 日志规范

实战！日志打印的15个好建议 (opens new window) 如何优雅地记录操作日志？ (opens new window)

# 使用slf4j

  1. 使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。

# 如何正确打印日志

# 什么时候应该打日志

  1. 定位问题 ：当你遇到问题的时候，只能通过debug功能来确定问题，你应该考虑打日志，良好的系统，是可以通过日志进行问题定位的。
  2. 执行逻辑判断 ：当你碰到if…else 或者 switch这样的分支时，要在分支的首行打印日志，用来确定进入了哪个分支

# 基本格式

必须使用参数化信息的方式:

logger.debug("Processing trade with id:[{}] and symbol : [{}] ", id, symbol);
1

对于debug日志，必须判断是否为debug级别后，才进行使用:

if (logger.isDebugEnabled()) {
    logger.debug("Processing trade with id: " +id + " symbol: " + symbol);
}
1
2
3

不要进行字符串拼接，那样会产生很多String对象，占用空间，影响性能。反例(不要这么做):

logger.debug("Processing trade with id: " + id + " symbol: " + symbol);
1

# 使用[]进行参数变量隔离

如有参数变量，应该写成如下写法:

logger.debug("Processing trade with id:[{}] and symbol : [{}] ", id, symbol);
1

这样的格式写法，可读性更好，对于排查问题更有帮助。

# 不同级别的使用

# ERROR

影响到程序正常运行、当前请求正常运行的异常情况:

  • 第三方对接的异常(包括第三方返回错误码)
  • 所有影响功能使用的异常，包括：SQLException和除了业务异常之外的所有异常(RuntimeException和Exception)

如果有Throwable信息，需要记录完成的堆栈信息:

log.error("获取用户[{}]的用户信息时出错",userName,e);
1

注意

禁止使用 e.printStackTrace() 打印异常信息

    try {
        ....
    } catch (Exception e) {
        e.printStackTrace();
    }
1
2
3
4
5

正确的方式：

    try {
        ....
    } catch (Exception e) {
       log.error("{}", e.getMessage(), e);
    }
1
2
3
4
5

如果进行了抛出异常操作，请不要记录error日志，由最终处理方进行处理：

注意

反例(不要这么做)：

try{
    ....
}catch(Exception ex){
  String errorMessage=String.format("Error while reading information of user [%s]",userName);
  logger.error(errorMessage,ex);
  throw new UserServiceException(errorMessage,ex);
}
1
2
3
4
5
6
7

# WARN

不应该出现但是不影响程序、当前请求正常运行的异常情况：

  • 有容错机制的时候出现的错误情况
  • 业务异常的记录，比如：当接口抛出业务异常时，应该记录此异常。

# INFO

系统运行信息：

  • Service方法中对于系统/业务状态的变更
  • 主要逻辑中的分步骤

外部接口部分：

  • 客户端请求参数(REST/WS)
  • 调用第三方时的调用参数和调用结果

说明

  1. 并不是所有的service都进行出入口打点记录，单一、简单service是没有意义的(job除外，job需要记录开始和结束)
  2. 对于复杂的业务逻辑，需要进行日志打点，以及埋点记录
  3. 对于整个系统的提供出的接口(REST/WS)，使用info记录入参
  4. 调用其他第三方服务时，所有的出参和入参是必须要记录的(因为你很难追溯第三方模块发生的问题)

# DEBUG

  • 可以填写所有的想知道的相关信息(但不代表可以随便写，debug信息要有意义，最好有相关参数)
  • 生产环境需要关闭DEBUG信息
  • 如果在生产情况下需要开启DEBUG，需要使用开关进行管理，不能一直开启

如果代码中出现以下代码，可以进行优化:

//1. 获取用户基本薪资

//2. 获取用户休假情况

//3. 计算用户应得薪资
1
2
3
4
5

优化后的代码:

logger.debug("开始获取员工[{}] [{}]年基本薪资",employee,year);

logger.debug("获取员工[{}] [{}]年的基本薪资为[{}]",employee,year,basicSalary);
logger.debug("开始获取员工[{}] [{}]年[{}]月休假情况",employee,year,month);

logger.debug("员工[{}][{}]年[{}]月年假/病假/事假为[{}]/[{}]/[{}]",employee,year,month,annualLeaveDays,sickLeaveDays,noPayLeaveDays);
logger.debug("开始计算员工[{}][{}]年[{}]月应得薪资",employee,year,month);

logger.debug("员工[{}] [{}]年[{}]月应得薪资为[{}]",employee,year,month,actualSalary);
1
2
3
4
5
6
7
8
9

# TRACE

特别详细的系统运行完成信息，业务代码中，不要使用。(除非有特殊用意，否则请使用DEBUG级别替代)

Last Updated: 2 years ago

← MAVEN →