Java日志系列——规范化日志

  • 规范化日志
  • 原则1：使用参数化信息打印
  • 原则2：若带有参数变量必须使用`[]`隔离
  • 原则3：严格遵守Level
  • Error
  • Warn
  • Info
  • Debug
  • Trace
  • 原则4：文件输出


规范化日志

原则1：使用参数化信息打印

当我们打印日志时我们一定要使用参数化信息的方式进行打印而不要使用字符串拼接的方式，以避免内存占用

logger.warn("....{}..{}..",arg1,arg2);
logger.warn("....{}..{}..",args[] argList);

原则2：若带有参数变量必须使用[]隔离

这样更加有利于问题排查

logger.warn("....[{}]..[{}]..",arg1,arg2);

原则3：严格遵守Level

Error

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

  1. 打开配置文件失败
  2. 所有第三方对接的异常(包括第三方返回错误码)
  3. 所有影响功能使用的异常，包括:SQLException和除了业务异常之外的
  4. 所有异常(RuntimeException和Exception)
  5. 不应该出现的情况，比如要使用阿里云传图片，但是未响应
  6. 如果有Throwable信息，需要记录完成的堆栈信息:

Warn

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

  1. 有容错机制的时候出现的错误情况
  2. 找不到配置文件，但是系统能自动创建配置文件
  3. 即将接近临界值的时候，例如:缓存池占用达到警告线，业务异常的记录，比如:用户锁定异常

Info

系统运行信息

  1. Service方法中对于系统/业务状态的变更
  2. 主要逻辑中的分步骤: 1.初始化什么 2.加载什么
  3. 外部接口部分
  4. 客户端请求参数(REST/WS)
  5. 调用第三方时的调用参数和调用结果
  6. 对于复杂的业务逻辑，需要进行日志打点，以及埋点记录，比如电商系统中的下订单逻辑，以及OrderAction操作(业务状态变更)
  7. 调用其他第三方服务时，所有的出参和入参是必须要记录的(因为你很难追溯第三方模块发生的问题)

Debug

可以填写所有的想知道的相关信息(但不代表可以随便写，debug信息要有意义,最好有相关参数)

  1. 生产环境需要关闭DEBUG信息
  2. 如果在生产情况下需要开启DEBUG,需要使用开关进行管理，不能一直开启。

Trace

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

原则4：文件输出

  1. 日志的文件输出最好指定到项目下的logs目录下统一管理
  2. 文件尽量使用量和时间处理（严格遵守时间格式化）
  3. 过期日志尽量保存15日
  4. 过期日志若不使用进行压缩处理