参考博文： https://www.baeldung.com/spring-boot-logging https://www.baeldung.com/logback http://tengj.top/2017/04/05/springboot7/

Spring Boot在所有内部日志中使用Commons Logging，但是默认配置也提供了对常用日志的支持，如：Java Util Logging，Log4J, Log4J2和Logback。每种Logger都可以通过配置使用控制台或者文件输出日志内容。

SLF4J —— Simple Logging Facade For Java，它是一个针对于各类Java日志框架的统一Facade抽象。Java日志框架众多——常用的有java.util.logging, log4j, logback，commons-logging, Spring框架使用的是Jakarta Commons Logging API（JCL）。而SLF4J定义了统一的日志抽象接口，而真正的日志实现则是在运行时决定的——它提供了各类日志框架的绑定。

Logback是log4j框架的作者开发的新一代日志框架，它效率更高、能够适应诸多的运行环境，同时天然支持SLF4J。

默认情况下，Spring Boot会用Logback来记录日志，并用INFO级别输出到控制台。在运行应用程序和其他例子时，你应该已经看到很多INFO级别的日志了。

  1.   _   _   _   _   _   _  
  2.  / \ / \ / \ / \ / \ / \ 
  3. ( m | r | b | i | r | d )
  4.  \_/ \_/ \_/ \_/ \_/ \_/ 
  5. 2018-02-08 15:05:03.368  INFO 14404 --- [ main] cc.mrbird.Application                    : Starting Application on SC-201802012049 with PID 14404 (D:\neonWorkspace\mrbird\target\classes started by Administrator in D:\neonWorkspace\mrbird)
  6. 2018-02-08 15:05:03.375  INFO 14404 --- [ main] cc.mrbird.Application                    : No active profile set, falling back to default profiles: default
  7. 2018-02-08 15:05:03.777  INFO 14404 --- [ main] ationConfigEmbeddedWebApplicationContext : Refreshing org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext@31321838: startup date [Thu Feb 08 15:05:03 CST 2018]; root of context hierarchy
  8. 2018-02-08 15:05:05.083  INFO 14404 --- [ main] o.s.b.f.s.DefaultListableBeanFactory     : Overriding bean definition for bean 'advisorAutoProxyCreator' with a different definition: replacing [Root bean: class [null]; scope=; abstract=false; lazyInit=false; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=shiroConfig; factoryMethodName=advisorAutoProxyCreator; initMethodName=null; destroyMethodName=(inferred); defined in class path resource [cc/mrbird/config/ShiroConfig.class]] with [Root bean: class [null]; scope=; abstract=false; lazyInit=false; autowireMode=3; dependencyCheck=0; autowireCandidate=true; primary=false; factoryBeanName=com.alibaba.druid.spring.boot.autoconfigure.stat.DruidSpringAopConfiguration; factoryMethodName=advisorAutoProxyCreator; initMethodName=null; destroyMethodName=(inferred); defined in class path resource [com/alibaba/druid/spring/boot/autoconfigure/stat/DruidSpringAopConfiguration.class]]
  9. 2018-02-08 15:05:05.554  INFO 14404 --- [ main] trationDelegate$BeanPostProcessorChecker : Bean 'shiroConfig' of type [cc.mrbird.config.ShiroConfig$$EnhancerBySpringCGLIB$$b7e43ac8] is not eligible for getting processed by all BeanPostProcessors (for example: not eligible for auto-proxying)
  10. 2018-02-08 15:05:05.600  INFO 14404 --- [ main] trationDelegate$BeanPostProcessorChecker : Bean 'com.alibaba.druid.spring.boot.autoconfigure.stat.DruidSpringAopConfiguration' of type [com.alibaba.druid.spring.boot.autoconfigure.stat.DruidSpringAopConfiguration] is not eligible for getting processed by all BeanPostProcessors (for example: not eligible for auto-proxying)
  11. 2018-02-08 15:05:06.231  INFO 14404 --- [ main] trationDelegate$BeanPostProcessorChecker : Bean 'mybatis-org.mybatis.spring.boot.autoconfigure.MybatisProperties' of type [org.mybatis.spring.boot.autoconfigure.MybatisProperties] is not eligible for getting processed by all BeanPostProcessors (for example: not eligible for auto-proxying)
  12. ...

从上面可以看到，日志输出内容元素具体如下：

  1. 时间日期：精确到毫秒；
  2. 日志级别：ERROR, WARN, INFO, DEBUG or TRACE；
  3. 进程ID；
  4. 分隔符：---标识实际日志的开始；
  5. 线程名：方括号括起来（可能会截断控制台输出）；
  6. Logger名：通常使用源代码的类名；
  7. 日志内容。

添加日志依赖

假如maven依赖中添加了spring-boot-starter-logging：

  1. <dependency>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-starter-logging</artifactId>
  4. </dependency>

那么，我们的Spring Boot应用将自动使用logback作为应用日志框架，Spring Boot启动的时候，由org.springframework.boot.logging.Logging-Application-Listener根据情况初始化并使用。

默认配置属性支持

Spring Boot为我们提供了很多默认的日志配置，所以，只要将spring-boot-starter-logging作为依赖加入到当前应用的classpath，则“开箱即用”。 下面介绍几种在application.properties就可以配置的日志相关属性。

控制台输出

日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出。 Spring Boot中默认配置ERROR、WARN和INFO级别的日志输出到控制台。您还可以通过启动您的应用程序–debug标志来启用“调试”模式（开发的时候推荐开启）,以下两种方式皆可：

  • 在运行命令后加入–debug标志，如：$ java -jar springTest.jar --debug。
  • 在application.properties中配置debug=true，该属性置为true的时候，核心Logger（包含嵌入式容器、hibernate、spring）会输出更多内容，但是你自己应用的日志并不会输出为DEBUG级别。

文件输出

默认情况下，Spring Boot将日志输出到控制台，不会写到日志文件。如果要编写除控制台输出之外的日志文件，则需在application.properties中设置logging.file或logging.path属性。

  • logging.file.name，设置文件，可以是绝对路径，也可以是相对路径。如：logging.file.name=my.log #./logs/my.log。
  • logging.file.path，设置目录，会在该目录下创建spring.log文件，并写入日志内容，如：logging.file.path=/var/log。

如果只配置 logging.file，会在项目的当前路径下生成一个 xxx.log 日志文件。

如果只配置 logging.path，在 /var/log文件夹生成一个日志文件为 spring.log。

级别控制

所有支持的日志记录系统都可以在Spring环境中设置记录级别（例如在application.properties中） 格式为：logging.level.* = LEVEL

  • logging.level：日志级别控制前缀，*为包名或Logger名
  • LEVEL：选项TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF

举例：

  • logging.level.com.mrbird=DEBUG：com.mrbird包下所有class以DEBUG级别输出。
  • logging.level.root=WARN：root日志以WARN级别输出。

自定义日志配置

由于日志服务一般都在ApplicationContext创建前就初始化了，它并不是必须通过Spring的配置文件控制。因此通过系统属性和传统的Spring Boot外部配置文件依然可以很好的支持日志控制和管理。

根据不同的日志系统，你可以按如下规则组织配置文件名，就能被正确加载：

  • Logback：logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
  • Log4j：log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
  • Log4j2：log4j2-spring.xml, log4j2.xml
  • JDK (Java Util Logging)：logging.properties

Spring Boot官方推荐优先使用带有-spring的文件名作为你的日志配置（如使用logback-spring.xml，而不是logback.xml），命名为logback-spring.xml的日志配置文件，spring boot可以为它添加一些spring boot特有的配置项（下面会提到）。

上面是默认的命名规则，并且放在src/main/resources下面即可。

如果你即想完全掌控日志配置，但又不想用logback.xml作为Logback配置的名字，可以在application.properties配置文件里面通过logging.config属性指定自定义的名字：

  1. logging.config=classpath:logging-config.xml

虽然一般并不需要改变配置文件的名字，但是如果你想针对不同运行时Profile使用不同的日 志配置，这个功能会很有用。

下面我们来看看一个普通的logback-spring.xml例子:

  1. <?xml version="1.0" encoding="UTF-8"?>
  3. <configuration  scan="true" scanPeriod="60 seconds" debug="false">
  4.     <contextName>logback</contextName>
  5.     <property name="log.path" value="log" />
  6.     <!--输出到控制台-->
  7.     <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
  8.        <!-- <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
  9.             <level>ERROR</level>
  10.         </filter>-->
  11.         <encoder>
  12.             <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
  13.         </encoder>
  14.     </appender>
  16.     <!--输出到文件-->
  17.     <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
  18.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  19.             <fileNamePattern>${log.path}/logback.%d{yyyy-MM-dd}.log</fileNamePattern>
  20.         </rollingPolicy>
  21.         <encoder>
  22.             <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
  23.         </encoder>
  24.     </appender>
  26.     <root level="info">
  27.         <appender-ref ref="console" />
  28.         <appender-ref ref="file" />
  29.     </root>
  31.     <!-- logback为java中的包 -->
  32.     <logger name="com.mrbird.controller"/>
  33.     <!--logback.LogbackDemo：类的全路径 -->
  34.     <logger name="com.mrbird.controller.LoginController" level="WARN" additivity="false">
  35.         <appender-ref ref="console"/>
  36.     </logger>
  37. </configuration>

根节点<configuration>包含的属性

  • scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
  • scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。
  • debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。

根节点<configuration>的子节点：<configuration>下面一共有2个属性，3个子节点，分别是：

属性一：设置上下文名称**<contextName>**

每个logger都关联到logger上下文，默认上下文名称为“default”。但可以使用设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改,可以通过%contextName来打印日志上下文名称。

  1. <contextName>logback</contextName>

属性二：设置变量**<property>** 用来定义变量值的标签，有两个属性，name和value；其中name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。

  1. <property name="log.path" value="log" />

子节点一<appender>

appender用来格式化日志输出节点，有俩个属性name和class，class用来指定哪种输出策略，常用就是控制台输出策略和文件输出策略。

控制台输出ConsoleAppender：

  1. <!--输出到控制台-->
  2. <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
  3.     <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
  4.         <level>ERROR</level>
  5.     </filter>
  6.     <encoder>
  7.         <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
  8.     </encoder>
  9. </appender>

<encoder>表示对日志进行编码：

  • %d{HH: mm:ss.SSS}——日志输出时间。
  • %thread——输出日志的进程名字，这在Web应用以及异步任务处理中很有用。
  • %-5level——日志级别，并且使用5个字符靠左对齐。
  • %logger{36}——日志输出者的名字。
  • %msg——日志消息。
  • %n——平台的换行符。

ThresholdFilter为系统定义的拦截器，例如我们用ThresholdFilter来过滤掉ERROR级别以下的日志不输出到文件中。如果不用记得注释掉，不然你控制台会发现没日志~

输出到文件RollingFileAppender：

另一种常见的日志输出到文件，随着应用的运行时间越来越长，日志也会增长的越来越多，将他们输出到同一个文件并非一个好办法。RollingFileAppender用于切分文件日志：

  1. <!--输出到文件-->
  2. <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
  3.     <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  4.         <fileNamePattern>${log.path}/logback.%d{yyyy-MM-dd}.log</fileNamePattern>
  5.         <maxHistory>30</maxHistory>
  6.         <totalSizeCap>1GB</totalSizeCap>
  7.     </rollingPolicy>
  8.     <encoder>
  9.         <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
  10.     </encoder>
  11. </appender>

其中重要的是rollingPolicy的定义：

  • <fileNamePattern>${log.path}/logback.%d{yyyy-MM-dd}.log</fileNamePattern>定义了日志的切分方式——把每一天的日志归档到一个文件中；
  • <maxHistory>30</maxHistory>表示只保留最近30天的日志，以防止日志填满整个磁盘空间。同理，可以使用%d{yyyy-MM-dd_HH-mm}来定义精确到分的日志切分方式；
  • <totalSizeCap>1GB</totalSizeCap>用来指定日志文件的上限大小，例如设置为1GB的话，那么到了这个值，就会删除旧的日志。

logback 每天生成和大小生成冲突的问题可以看这个解答：http://blog.csdn.net/wujianmin577/article/details/68922545。

子节点二<root>

root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性，用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能设置为INHERITED或者同义词NULL。

默认是DEBUG。可以包含零个或多个元素，标识这个appender将会添加到这个logger。

  1. <root level="debug">
  2.     <appender-ref ref="console" />
  3.     <appender-ref ref="file" />
  4. </root>

子节点三<logger>

<logger>用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>。<logger>仅有一个name属性，一个可选的level和一个可选的addtivity属性。

  • name：用来指定受此logger约束的某一个包或者具体的某一个类。
  • level：用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。如果未设置此属性，那么当前logger将会继承上级的级别。
  • addtivity：是否向上级logger传递打印信息。默认是true。

logger在实际使用的时候有两种情况：

先来看一看代码中如何使用：

  1. package com.mrbird.controller;
  3. @Controller
  4. public class LearnController {
  5.     private Logger logger = LoggerFactory.getLogger(this.getClass());
  7.     @RequestMapping(value = "/login",method = RequestMethod.POST)
  8.     @ResponseBody
  9.     public Map<String,Object> login(HttpServletRequest request, HttpServletResponse response){
  10.         //日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出。
  11.         logger.trace("日志输出 trace");
  12.         logger.debug("日志输出 debug");
  13.         logger.info("日志输出 info");
  14.         logger.warn("日志输出 warn");
  15.         logger.error("日志输出 error");
  16.         Map<String,Object> map =new HashMap<String,Object>();
  17.         String userName=request.getParameter("userName");
  18.         String password=request.getParameter("password");
  19.         if(!userName.equals("") && password!=""){
  20.             User user =new User(userName,password);
  21.             request.getSession().setAttribute("user",user);
  22.             map.put("result","1");
  23.         }else{
  24.             map.put("result","0");
  25.         }
  26.         return map;
  27.     }
  28. }

这是一个登录的判断的方法，我们引入日志，并且打印不同级别的日志，然后根据logback-spring.xml中的配置来看看打印了哪几种级别日志。
Screen Shot 2021-10-16 at 5.19.54 PM.png

第一种：带有logger的配置，不指定级别，不指定appender：

  1. <logger name="com.mrbird.controller"/>

<logger name="com.mrbird.controller" />将控制controller包下的所有类的日志的打印，但是并没用设置打印级别，所以继承他的上级的日志级别“info”；

没有设置addtivity，默认为true，将此logger的打印信息向上级传递；

没有设置appender，此logger本身不打印任何信息。

<root level="info">将root的打印级别设置为“info”，指定了名字为“console”的appender。

当执行com.mrbird.controller.LearnController类的login方法时，LearnController 在包com.mrbird.controller中，所以首先执行<logger name="com.mrbird.controller"/>，将级别为“info”及大于“info”的日志信息传递给root，本身并不打印； root接到下级传递的信息，交给已经配置好的名为“console”的appender处理，“console”appender将信息打印到控制台；

打印结果如下：

  1. 16:00:17.407 logback [http-nio-8080-exec-8] INFO  com.mrbird.controller.LearnController - 日志输出 info
  2. 16:00:17.408 logback [http-nio-8080-exec-8] WARN  com.mrbird.controller.LearnController - 日志输出 warn
  3. 16:00:17.408 logback [http-nio-8080-exec-8] ERROR com.mrbird.controller.LearnController - 日志输出 error

第二种：带有多个logger的配置，指定级别，指定appender；

  1. <!--logback.LogbackDemo：类的全路径 -->
  2. <logger name="com.mrbird.controller.LearnController" level="WARN" additivity="false">
  3.     <appender-ref ref="console"/>
  4. </logger>

控制com.mrbird.controller.LearnController类的日志打印，打印级别为“WARN”;additivity属性为false，表示此logger的打印信息不再向上级传递；指定了名字为“console”的appender。

这时候执行com.mrbird.controller.LearnController类的login方法时，先执行<logger name="com.mrbird.controller.LearnController" level="WARN" additivity="false">, 将级别为“WARN”及大于“WARN”的日志信息交给此logger指定的名为“console”的appender处理，在控制台中打出日志，不再向上级root传递打印信息。

打印结果如下：

  1. 16:00:17.408 logback [http-nio-8080-exec-8] WARN  com.mrbird.controller.LearnController - 日志输出 warn
  2. 16:00:17.408 logback [http-nio-8080-exec-8] ERROR com.mrbird.controller.LearnController - 日志输出 error

当然如果你把additivity=”false”改成additivity=”true”的话，就会打印两次，因为打印信息向上级传递，logger本身打印一次，root接到后又打印一次。