springboot中统一日志管理

Springboot中统一日志管理

一、为什么要用日志？

一般分为两个大类：操作日志和系统日志

**操作日志：**用户在操作软件时记录下来的操作步骤，便于用户自己查看。主要针对的是用户。

**系统日志：**系统日志是记录系统中硬件、软件和系统问题的信息，同时还可以监视系统中发生的事件。用户可以通过它来检查错误发生的原因，或者寻找受到攻击时攻击者留下的痕迹。系统日志包括系统日志、应用程序日志和安全日志。主要针对的是软件开发人员（包括测试、维护人员）。

日志的作用：

日志是系统运行的“照妖镜”，通过它能够实时反映系统的运行状态；

良好的日志便于后期运维和开发人员迅速定位线上问题，加快止损速度，减少系统故障带来的损失；

日志能够无缝与监控系统结合，通过监控系统进行日志采集，拿到系统运行的相关性能指标，有利于分析系统的性能瓶颈、提前规避风险；

便于统计与业务相关的指标数据，进行相关业务分析和功能优化.

二、日志级别

使用日志级别的好处在于，调整级别，就可以屏蔽掉很多调试相关的日志输出。不同的日志框架定义的日志级别不太一样，不过也都大同小异。

ALL 最低等级的，用于打开所有日志记录。

TRACE 很低的日志级别，一般不会使用。

DEBUG 指出细粒度信息事件对调试应用程序是非常有帮助的，主要用于开发过程中打印一些运行信息。比如函数里的输入输出。

INFO 消息在粗粒度级别上突出强调应用程序的运行过程。打印一些你感兴趣的或者重要的信息，这个可以用于生产环境中输出程序运行的一些重要信息，但是不能滥用，避免打印过多的日志。

WARN 表明会出现潜在错误的情形，有些信息不是错误信息，但是也要给程序员的一些提示。

ERROR 指出虽然发生错误事件，但仍然不影响系统的继续运行。打印错误和异常信息，如果不想输出太多的日志，可以使用这个级别。

FATAL 指出每个严重的错误事件将会导致应用程序的退出。这个级别比较高了。重大错误，这种级别你可以直接停止程序了。

OFF 最高等级的，用于关闭所有日志记录。

如果将log level设置在某一个级别上，在你的系统中如果开启了某一级别的日志后，就不会打印比它级别低的日志，只打印比此级别优先级高的log。例如，如果设置优先级为WARN，那么OFF、FATAL、ERROR、WARN 4个级别的log能正常输出，而INFO、DEBUG、TRACE、 ALL级别的log则会被忽略。Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。

三、什么时候打印什么级别的日志

我们之前讲Mybatis时也打印过日志，比如打印一下sql，但现在看来只是打印Sql是不够的，那么我们应该在哪些地方打印，打印哪些东西，打印什么级别的呢？

3.1 在哪些地方需要打印日志？

1、调用第三方接口时会打印日志，比如具体的Request和Response
2、状态变化
3、重要方法的输入和输出
4、业务异常
5、非预期执行（比如删除一条数据，可能成功可能数据本身不存在）
6、很少出现的else情况
7、程序运行时间
8、大批量数据的执行进度

3.2 打印哪些内容？

打印的内容一定要从实际出发。也就是说如果在实际的生产环境中，你的用户量很大，日志在不停地刷新，如何定位某个用户的整个登录以及后续的操作呢？当然就是根据用户名来跟踪。所以打印内容的第一要素就是要能便于定位；定位过后也许用户在好几个模板中进行操作，还是定位，这个时候定的是模块的位；还有一点当然就是用户操作时的具体参数；最后一点就是用户干了什么。

总结就是，[id, module, params, content]（关键字，模块，参数，内容）。

比如：

log.error("{}|ReqId={}|ID={}|业务执行异常|参数={}|e={}",EVENT_NAME, ReqId, ID, param, e.toString(), e);
log.debug("开始获取员工[{}] [{}]年基本薪资",employee,year);

3.3 打印什么级别?

ERROR级别:

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

1. 打开配置文件失败
2. 所有第三方对接的异常(包括第三方返回错误码)
3. 所有影响功能使用的异常，包括:SQLException和除了业务异常之外的所有异常(RuntimeException和Exception)

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

try{
   
    ....
}catch(Exception ex){
   
 
  logger.error(....); //不要在这里加error日志 ，应该在处理这个异常的类中加
  throw new UserServiceException(errorMessage,ex);
}

WARN级别

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

1. 有容错机制的时候出现的错误情况

2. 找不到配置文件，但是系统能自动创建配置文件

3. 即将接近临界值的时候，例如：缓存池占用达到警告线,业务异常的记录等

INFO级别

系统运行信息和调用第三方接口信息

1. Service方法中对于系统/业务状态的变更
2. 主要逻辑中的分步骤
3. 客户端请求参数(REST/WS)
4. 调用第三方时的调用参数和调用结果

DEBUG级别

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

四、Java日志框架体系

Java 中的日志框架主要分为两大类：日志门面和日志实现。

日志门面

日志门面定义了一组日志的接口规范，它并不提供底层具体的实现逻辑。Apache Commons Logging 和 Slf4j 就属于这一类。

日志实现

日志实现则是日志具体的实现，包括日志级别控制、日志打印格式、日志输出形式（输出到数据库、输出到文件、输出到控制台等）。Log4j、Log4j2、Logback 以及 Java Util Logging 则属于这一类。

如图所示：

我们使用的时候一般是 ,一个"门面"搭配一个实现层使用。

比如：Slf4j +Log4j

​ Slf4j +Logback 。

五 、SpringBoot中如何统一日志管理

spring boot默认使用slf4j+logback作为日志框架。

5.1 怎么导入Logback框架

​ 在 Spring Boot 项目中，只要添加了 web 依赖，日志依赖就自动添加进来了：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>