概述

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

Java 中的日志体系：

日志门面

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

• 日志门面的作用：解决系统与日志实现框架的耦合性。

  每一种日志框架都有自己单独的 API，要使用对应的框架就要使用其对应的 API，这就大大的增加应用程序代码对于日志框架的耦合性。将日志门面和日志实现分离其实是一种典型的门面模式，这种方式可以让具体业务在不同的日志实现框架之间自由切换，而不需要改动任何代码，开发者只需要掌握日志门面的 API 即可。

• 日志门面是不能单独使用的，它必须和一种具体的日志实现框架相结合使用。

日志实现

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

  • Log4j：Apache 的一个开源项目，可以控制日志信息输送的目的地是控制台、文件、GUI 组件等，可以控制每一条日志的输出格式，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。

    虽然已经停止维护了，但目前绝大部分企业都是用的 log4j

  • LogBack：是 Log4j 的一个改良版本

  • Log4j2：Log4j2 已经不仅仅是 Log4j 的一个升级版本了，它从头到尾都被重写了。

    相比与其他的日志系统，log4j2 的性能无论在同步日志模式还是异步日志模式下都是最佳的：

    • log4j2 丢数据这种情况少；
    • disruptor 技术，在多线程环境下，性能高于 logback 等10倍以上；
    • 利用jdk1.5 并发的特性，减少了死锁的发生；

  • java.util.logging：是 JDK 在 1.4 版本中引入的 Java 原生日志框架。

    Java Util Logging 系统在 JVM 启动时读取配置文件并完成初始化，一旦应用程序开始运行，就无法修改配置。

    这种日志实现配置也不太方便，只能在 JVM 启动时传递参数，例如：

    -Djava.util.logging.config.file=<config-file-name>。
    

    由于这些局限性，导致 Java Util Logging 并未广泛使用。

Java 类中日志的使用方式

初始化日志对象

• 方式1（推荐）：使用 lombok 插件的注解 @slf4j

  在pom.xml文件中添加 lombok 依赖：

      <dependency>
          <groupId>org.project.lombok<groupId>
          <artifactId>lombok<artifactId>
          <optional>true<optional>
      <dependency>
  

  然后再类上面使用 @slf4j 注解

• 方式2：在每个类中添加日志对象：

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

变量的打印

• 方式1（推荐）：使用占位符

  log.info("name: {}, wx: {}", name, wx);
  

• 方式2：使用字符串 +

  log.info("name: " + name + ", wx: " + wx);
  

  注意：这种方式会存在构造消息参数的成本，即字符串相加，并且无论是否记录消息，都是如此，即那怕日志级别为 EROR，也会执行括号里面的操作，但是日志不会输出

Spring Boot 日志实现

介绍、依赖

• Spring Boot 自带 spring-boot-starter-logging 库实现系统日志功能。

  spring-boot-starter-logging 依赖了三个框架，分别是：slf4j（日志门面）、logback、log4j。

  在开发过程中，可以采用 slf4j 的 api 去记录日志，底层的实现就是根据配置来决定使用 logback 还是 log4j 日志框架。

  其中 Log4j 可以认为是一个过时的函数库，已经停止更新，不推荐使用，相比之下，性能和功能也是最差的。

• springboot2.x 以后默认采用了：slf4j（日志门面）+ logback（日志实现）的日志搭配。

  logback 虽然是 Spring Boot 默认的，但性能上还是不及 Log4j2，因此，在现阶段，日志记录首选 Log4j2

  SLF4J + Log4j2 是比较推荐的日志记录选型

• 系统运行日志默认输出到控制台（console ），也能通过配置输出到文件中。

依赖

可以在 pom.xml 文件中添加 spring-boot-starter-logging 依赖，但其实只要加入任意的 Spring Boot starter 都会默认引入 spring-boot-starter-logging，因此不需要单独添加 spring-boot-starter-logging 依赖。

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

配置

简述

在使用 SpringBoot 时收集日志时，如果对日志的显示格式以及日志文件的输出内容没有特殊的要求时，可以不需要定义日志实现框架的配置文件，只需在 SpringBoot 的配置文件中添加基本日志配置即可满足需求，当然这些配置项有些只是针对默认的 logback 才生效，基础配置项列表如下 ：

debug=false
trace=false
# LOGGING
logging.config=
logging.exception-conversion-word=%wEx
logging.file=
logging.file.max-history=0
logging.file.max-size=10MB
logging.group.*=
logging.level.*=
logging.path=
logging.pattern.console=
logging.pattern.dateformat=yyyy-MM-dd HH:mm:ss.SSS
logging.pattern.file=
logging.pattern.level=%5
plogging.register-shutdown-hook=false

• debug、trace 属性

  默认 false，如果为 true，则表示打开调试或跟踪模式，调试或跟踪模式只针对 SpringBoot 系统内部日志，并不是所有的日志都以debug级别显示，比如手动通过 api 输出的日志就不受影响。

• logging.config 属性

  该属性指定日志配置文件的所在位置，默认会从 classpath 的根路径加载，如果两种方式都没有指定，则根据日志框架实现类型加载默认的日志配置文件（在框架内部）。

• logging.exception-conversion-word 属性

  默认值“%wEx”，主要用彩色异常日志的格式化，不常用。

• logging.group 属性

  此属性表示的是一个日志组，它的作用在于方便的控制某个组下的日志级别，例如：

  # 定义com.icypt.controller包下的日志，统一由controller组管理
  logging.group.controller=com.icypt.controller
  # 控制日志组日志级别
  loggin.level.contoller=info
  

  SpringBoot 也预定义了一些日志组，如下：

  logging.group.web=org.springframework.core.codec, org.springframework.http, org.springframework.web, org.springframework.boot.actuate.endpoint.web, org.springframework.boot.web.servlet.ServletContextInitializerBeans
  logging.group.sql=org.springframework.jdbc.core, org.hibernate.SQL
  

  所以在以后调试 SpringBoot 项目时可以通过这些预定义组来临时修改日志级别，是很方便的。

日志级别

springboot 默认日志级别是：info

logging:
  level:
    root: debug  # 指定日志级别，把根路径下所有日志修改成为debug，默认info
    com.exmaple: error  # 指定日志级别，把com.exmaple包路径的日志指定修改为error

注意：logging.level 后跟的路径越详细优先级越高

logging.level.包.类 > logging.level.包 > logging.level.组 > logging.level.root

日志输出文件

springboot 日志默认情况仅打印在 console（控制台），若需要日志输出到文件需要在 yaml 中配置。

• 方式1（常用）：file.name 配置项

  logging:
    file:
      name: /ouput/logs/${HOSTNAME:spring}.log  # 指定存储的位置和日志文件的名称
  

• 方式2：file.path 配置项

  logging:
    file:
      path: output/logs  # 指定存储的位置，默认的日志名是: spring. log
  

  注：logging.file.name 和 logging.file.path 只需配置一个，若同时存在，则 path 无效

其他配置项：

logging:
  file:
    # 清理历史日志文件，缺省默认为false
    clean-history-on-start: true
     # 最大日志文件大小，达到该上限后，会自动压缩（仅支持默认的Logback设置），默认10M
    max-size: 20M
    # 保留的归档日志文件的最大天数（仅支持默认的Logback设置），(SpringBoot 2.1+默认为7)缺省默认为7。0表示永远存档，如果大于0表示最多保留x天。该属性只在 max-size属性存在的情况下才有意义
    max-history: 7
    # 压缩归档的日志归档的总大小，当超过该阈值时，将删除备份
    total-size-cap: 100M

日志格式

指定日志格式

logging:
  pattern:
    # 指定打印在控制台的日志格式
    console: "%d{yyyy-MM-dd HH:mm:ss.SSS}  %-5level [%thread] %logger{36} : %msg %n"
    # 指定打印在文件的日志格式
    file: "%d{yyyy-MM-dd HH:mm:ss.SSS} ---- [%thread] %-5level %Logger{50}- %msg%n"
    # 格式化日志日期时间
    dateformat: yyyy-MM-dd HH:mm:ss.SSS
    # 格式化日志级别
    level: %5p 

默认日志输出格式表达式

logging:
  pattern:
    # 指定打印在控制台的日志格式
    console: "%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n"

占位符说明：

• %clr(表达式){颜色}：设置输出内容的颜色

  常用的有一下几种颜色，大致如下（环境不同实际输出会有色差）：blue 蓝色、cyan 青色、faint 淡灰色、green 绿色、magenta 品红色、red 红色、yellow 黄色

• %d{yyyy-MM-dd HH:mm:ss.SSS}：显示日期，年-月-日 时-分-秒.毫秒（2021-01-01 01:01:01.001）

• ${LOG_LEVEL_PATTERN:%5p}：先去环境中去取变量 LOG_LEVEL_PATTERN 的值，如果为 null，那么就会取 : 后的值 %5p

  注：${value:value2} 为 SpringBoot 占位符 + null 条件的表达式，即先去环境中去取变量 value 的值，如果为 null，那么就会取 : 后的值 value2

• %p或 %level ：输出日志级别（ERROR，WARN，INFO，DEBUG，TRACE）

  %5p或 %-5level ：输出日志级别（优先级）

  %5p ：右对齐输出日志级别，并且固定输出5个字符，如果不足在左边用空格填充

  %-5p ：左对齐输出日志级别，并且固定输出5个字符，如果不足在右边用空格填充

  注：

  • %5 ：右对齐输出，若字符长度小于5，则左侧用空格填充
  • %-5：左对齐输出，若字符长度小于5，则右侧用空格填充
  • %.15：若字符长度超过15，截去多余字符
  • %15.15：若字符长度小于15，则右边用空格填充；若字符长度超过15，截去多余字符

• %t 或 %thread ：显示产生该日志的线程名

• %logger 或 %c 或 %C：输出 logger 名称，因为 Root Logger 没有名称，所以没有输出

• %msg 或 %m：日志文本

• %n ：换行

• %l ：输出完整的日志位置，包括类名、方法名、文件名及在代码中的行数

• %L ：输出行号

• %F ：输出所在的类文件名，如 Log4j2Test.java

• %M 或 %method ：输出所在方法名

• %replace{pattern}{regex}{substitution} ：将 pattern 的输出结果按照正则表达式 regex 替换成 substitution

引入日志配置文件

logging:
  # 实现根据日期生成日志
  config:
    # 引入配置
    classpath:logback-spring.xml

指定使用 log4j2

1. 在当前项目中排除 spring-boot-starter-logging

   <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
      <exclusions>
         <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
         </exclusion>
      </exclusions>
   </dependency>
   

2. 引入 spring-boot-starter-log4j2

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

自定义日志配置

根据日志记录系统，将加载以下文件：

记录系统	文件名称
logback	logback-spring.xml，logback-spring.groovy，logback.xml，或者logback.groovy
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 特有的配置项。

  注：因为在使用 logback-spring.xml 时，会先将配置送由 SpringBoot 进行解析（比如要想支持特殊配置 <springProfile>，必须命名为 logback-spring.xml 这种形式），而在使用 logback.xml 时，配置文件将直接被日志框架加载。使用 logback-spring.xml 将使 SpringBoot 得到完全控制权。

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

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

  logging.config=classpath:logging-config.xml
  

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

  一般不需要这个属性，而是直接在 logback-spring.xml 中使用 springProfile 配置，不需要 logging.config 指定不同环境使用不同配置文件。springProfile 配置详见下文。

• 当进行了自定义的日志文件的配置后，properties 文件中的配置就会失效（loging.file 和 logging.pattern 会失效，需要在自定义的日志配置文件中定义）

自定义 logback.xml 日志配置文件

logback 配置文件加载说明

logback 在启动时：

1. 在 classpath 中寻找 logback-test.xml 文件
2. 如果找不到 logback-test.xml，则在 classpath 中寻找 logback.groovy 文件
3. 如果找不到 logback.groovy，则在 classpath 中寻找 logback.xml 文件
4. 如果上述的文件都找不到，则 logback 会使用 JDK 的 SPI 机制查找 META-INF/services/ch.qos.logback.classic.spi.Configurator 中的 logback 配置实现类，这个实现类必须实现 Configuration 接口，使用它的实现来进行配置
5. 如果上述操作都不成功，logback 就会使用它自带的 BasicConfigurator 来配置，并将日志输出到 console

常见术语概念

配置文件元素：

• appender（输出源）：主要控制日志输出到哪里，比如：文件、数据库、控制台打印等
• logger（记录器）：用来设置某一个包或者具体某一个类的日志打印级别、以及指定 appender
• root：也是一个 logger，是一个特殊的父 logger。所有的子 logger 最终都会将输出流交给 root，除非在子 logger 中配置了additivity=“false”
• rollingPolicy：指定滚动策略，按照一定周期或文件大小切割存放日志文件
• RolloverStrategy：日志清理策略。通常是指日志保留的时间。

其他概念：

• 同步日志：主线程要等到日志写磁盘完成之后，才能继续向下执行

• 异步日志：单独开一个线程做日志的写操作，达到不阻塞主线程的目的。

  异步日志，主线程写日志只是将日志消息放入一个队列，之后就继续向下执行，这个过程是在内存层面完成的。之后由专门的线程从队列中获取日志数据写入磁盘，所以不阻塞主线程。主线程（核心业务代码）执行效率很高。

一个基本的 xml 配置

Logback 基于三个主要类：Logger（记录器），Appender（附加器）和 Layout（布局）。 这三种类型的组件协同工作，使开发人员能够根据消息类型和级别记录消息，并在运行时控制这些消息的格式以及报告的位置。

一个基本的 xml 配置如下：

<configuration>
 
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <!-- encoders are assigned the type
         ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
    <encoder>
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
  </appender>
 
  <logger name="chapters.configuration" level="INFO"/>
 
  <!-- Strictly speaking, the level attribute is not necessary since -->
  <!-- the level of the root level is set to DEBUG by default.       -->
  <root level="DEBUG">          
    <appender-ref ref="STDOUT" />
  </root>  
  
</configuration>

配置文件节点详解

configuration 节点

• logback.xml 配置文件的基本结构可以描述为 <configuration> 元素，包含零个或多个 <appender> 元素，后跟零个或多个 <logger> 元素，后跟最多一个 <root> 元素

  基本结构 图示：
  

• 可选属性：

  • scan：当此属性设置为 true 时，配置文件如果发生改变，将会被重新加载，默认值为 true

  • scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。

    当 scan 为 true 时，此属性生效。默认的时间间隔为1分钟。

  • debug：当此属性设置为 true 时，将打印出 logback 内部日志信息，实时查看 logback 运行状态。默认值为 false

root 节点和 logger 节点

logger 节点

• logger（记录器）：用来设置某一个包或者具体某一个类的日志打印级别以及指定 appender

• <logger> 元素只接受一个必需的 name 属性，一个可选的 level 属性和一个可选的 additivity 属性：

  • name 属性：指定项目中的某个包路径（包括引入的依赖的包路径）

  • level 属性：指定日志级别。缺省默认将强制记录器的级别从层次结构中的较高级别继承

    允许一个不区分大小写的字符串值：TRACE，DEBUG，INFO，WARN，ERROR，ALL 或 OFF

  • additivity 属性：是否允许累计打印日志到输出层次级别更高的 appender，缺省默认为 true

• <logger> 元素可以包含零个或多个 <appender-ref> 元素；这样引用的每个 appender 都被添加到指定的 logger 中，logger元素级别具有继承性。

root 节点

• root 节点是必选节点，用来指定最基础的日志输出级别

• <root> 元素也是一个 logger，是一个特殊的父 logger。所有的子 logger 最终都会将输出流交给 root，除非在子 logger 中配置了additivity=“false”

• 只有一个可选的 level 属性：

  • level：设置打印级别，缺省默认为 DEBUG

    允许一个不区分大小写的字符串值：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF

    不能设置为 INHERITED 或者同义词 NULL

• <root> 元素可以包含零个或多个 <appender-ref> 元素，这样引用的每个 appender 都被添加到 root 记录器中

• 示例：

  <root level="debug">
    <appender-ref ref="console" />
    <appender-ref ref="file" />
  </root>
  

contextName 节点

• <contextName> 元素：设置上下文名称

  每个 logger 都关联到 logger 上下文，默认上下文名称为“default”。

  但可以使用设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改。

  可以通过 %contextName 来打印日志上下文名称，一般来说不用这个属性，可有可无

property 节点

• <property> 元素：用来定义变量值的标签

  属性：

  • name 属性：变量的名称

  • value 属性：变量定义的值

    name 和 value 属性通常一起使用，直接配置参数值

  • file 属性：引入参数文件

      <!-- 引入项目内的文件指定文件所在的包路径 -->
      <property file="src/main/java/chapters/configuration/variables1.properties" />
      <!-- 引入项目外的文件指定文件所在的绝对路径 -->
      <property file="/home/logback/variables.properties" />
    

  • resource 属性：引入参数文件

      <!-- 使用classpath的方式引入文件，只需写明文件名即可 -->
      <property resource="resource1.properties" />
    

  通过定义的值会被插入到 logger 上下文中

  定义变量后，可以使 “${}” 来使用变量

• 示例：

  <property name="logback.logdir" value="/Users/inke/dev/log/tomcat"/>
  <property name="logback.appname" value="app"/>
  

appender 节点

• appender（输出源）：用来格式化日志输出节点

• 有两个必需属性 name 和 class：

  • name 属性：指定 appender 的名称
  • class 属性：指定要实例化的 appender 类的完全限定名称（输出策略），常用：控制台输出策略和文件输出策略

• <appender> 元素可以包含零个或一个 <layout> 元素，零个或多个 <encoder> 元素以及零个或多个 <filter> 元素。

  常见结构 图示：

• Appender 是一个接口，它有许多子接口和实现类，其中最重要的两个为：ConsoleAppender 、RollingFileAppender：

  • ConsoleAppender：将日志输出到控制台上。

  • RollingFileAppender：是 FileAppender 的一个子类，扩展了 FileAppender，具有翻转日志文件的功能。

    例如，RollingFileAppender 可以记录到名为 log.txt 文件的文件，并且一旦满足某个条件，就将其日志记录目标更改为另一个文件。

    与 RollingFileAppender 交互的两个重要子组件：

    • RollingPolicy：负责执行翻转所需的操作。

    • TriggeringPolicy：将确定是否以及何时发生翻转。

      即，RollingPolicy 负责什么操作，TriggeringPolicy 负责什么时候。

    RollingFileAppender 必须同时设置 RollingPolicy 和 TriggeringPolicy。 但是，如果其 RollingPolicy 也实现了 TriggeringPolicy 接口，则只需要显式指定前者。

    滚动策略：

    • TimeBasedRollingPolicy：根据时间定义翻转策略，例如按天或按月，最常用的滚动策略。

      TimeBasedRollingPolicy 承担滚动和触发所述翻转的责任（其同时实现了RollingPolicy 和 TriggeringPolicy 接口）

      常用子节点：

      • <fileNamePattern>：设置日志归档路径以及格式

      • <maxHistory>：可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。

        注：maxHistory 的单位是根据 fileNamePattern 中的翻转策略自动推算出来的，例如上面选用了yyyy-MM-dd，则单位为天，如果上面选用了 yyyy-MM，则单位为月。另外上面的单位默认为 yyyy-MM-dd

      示例：

      <!-- 设置滚动日志记录的滚动策略 -->
      <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
          <!-- 日志归档路径以及格式 -->
          <fileNamePattern>${log.path}/info/log-rolling-%d{yyyy-MM-dd}.log</fileNamePattern>
          <!--归档日志文件保留的最大数量-->
          <maxHistory>15</maxHistory>
      </rollingPolicy>
      

    • SizeAndTimeBasedRollingPolicy：按日期归档文件，并同时限制每个日志文件的大小

      SizeAndTimeBasedRollingPolicy 是 TimeBasedRollingPolicy 的一个子类，实现了基于时间和日志文件大小的翻滚策略。

      常用子节点：

      • <totalSizeCap>：压缩归档的日志归档的总大小，当超过该阈值时，将删除备份
      • <maxFileSize>：最大日志文件大小，达到该上限后，会自动切分。默认值是10MB

      示例：

      <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
          <!-- 日志文件的名字会根据fileNamePattern的值，每隔一段时间改变一次 -->
          <!-- 注意：SizeAndTimeBasedRollingPolicy中 ％i和％d令牌都是强制性的，必须存在，否则报错 -->
          <fileNamePattern>logs/project_info.%d.%i.log</fileNamePattern>
          <!-- 每产生一个日志文件，该日志文件的保存期限为30天 -->
          <maxHistory>30</maxHistory>
          <!-- 每个日志文件到10mb的时候开始切分，最多保留30天，但最大到20GB，哪怕没到30天也要删除多余的日志 -->
          <totalSizeCap>20GB</totalSizeCap>
          <!-- maxFileSize:这是活动文件的大小，默认值是10MB -->
          <maxFileSize>10MB</maxFileSize>
      </rollingPolicy>
      

• 注：

  • 在 logback 中，输出目标称为 appender，addAppender 方法将 appender 添加到给定的记录器 logger。给定记录器的每个启用的日志记录请求都将转发到该记录器中的所有 appender 以及层次结构中较高的 appender。

    换句话说，appender 是从记录器层次结构中附加地继承的。

    例如，如果将控制台 appender 添加到根记录器，则所有启用的日志记录请求将至少在控制台上打印。如果另外将文件追加器添加到记录器（例如 L），则对 L 和 L 的子项启用的记录请求将打印在文件和控制台上。

    通过将记录器的 additivity 标志设置为 false，可以覆盖此默认行为，以便不再添加 appender 累积。

  • 如果不加 additivity=“false” 则此 logger 会将输出转发到自身以及祖先的 logger 中，就会出现日志文件中 sql 重复打印

    additivity=false 代表禁止默认累计的行为，即日志只会记录到自身 logger 的 appender 中，不会输出层次级别更高的任何 appender

encoder 节点和 filter 节点

encoder 节点：

• <encoder> 元素：设置日志输出的格式和编码

• 可以包含一个 <pattern > 元素，一个 <charset> 元素

  • <pattern> 元素：设置日志输出的格式
  • <charset> 元素：设置日志输出的编码，常用 UTF-8

• 示例：

  <!-- 控制台日志 -->
  <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
      <encoder>
          <pattern>${CONSOLE_LOG_PATTERN}</pattern>
          <charset>UTF-8</charset>
      </encoder>
  </appender>
  

• 自定义占位变量：

  输出格式 %X{requestId}] 表示请求id，可以用来追踪日志的调用链

  需要在代码中使用指定：MDC.put(“requestId”, requestId);

  如果内部涉及到多线程，可以通过参数传递方式将 requestId 传入子线程代码中，并重新设置：MDC.put(“requestId”, requestId);

  方法调用结束后需要手动移除：MDC.remove(“requestId”);

filter 节点：

• <filter> 元素：设置日志过滤规则

• 最重要的两个过滤器为：LevelFilter、ThresholdFilter。

  • ThresholdFilter ：过滤低于指定阈值的事件。

    对于等于或高于阈值的事件，ThresholdFilter 将在调用其 decision() 方法时响应 NEUTRAL。 但是，将拒绝级别低于阈值的事件。

    例如下面的配置将拒绝所有低于 INFO 级别的日志，只输出 INFO 以及以上级别的日志：

    <configuration>
      <appender name="CONSOLE"
        class="ch.qos.logback.core.ConsoleAppender">
        <!-- deny all events with a level below INFO, that is TRACE and DEBUG -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
          <level>INFO</level>
        </filter>
        <encoder>
          <pattern>
            %-4relative [%thread] %-5level %logger{30} - %msg%n
          </pattern>
        </encoder>
      </appender>
      <root level="DEBUG">
        <appender-ref ref="CONSOLE" />
      </root>
    </configuration>
    

  • LevelFilter ：根据精确的级别匹配过滤事件。

    如果事件的级别等于配置的级别，则筛选器接受或拒绝该事件，具体取决于 onMatch 和 onMismatch 属性的配置。

    • ACCEPT：接收
    • DENY：禁止

    例如：下面配置将只打印 INFO 级别的日志，其余的全部禁止打印输出：

    <configuration>
      <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
          <level>INFO</level>
          <onMatch>ACCEPT</onMatch> <!-- 命中就打印日志 -->
          <onMismatch>DENY</onMismatch> <!-- 没有命中禁止打印日志 -->
        </filter>
        <encoder>
          <pattern>
            %-4relative [%thread] %-5level %logger{30} - %msg%n
          </pattern>
        </encoder>
      </appender>
      <root level="DEBUG">
        <appender-ref ref="CONSOLE" />
      </root>
    </configuration>
    

springProfile 节点

• 在一个基于Spring boot 开发的项目里，常常需要有多套环境的配置：开发，测试以及生产。使用 springProfile 可以分别配置开发（dev），测试（test）以及生产（prod）等不同的环境

• 示例：

  <!-- 开发环境和测试环境 -->
  <springProfile name="dev,test">
      <logger name="com.pl" level="INFO">
          <appender-ref ref="CONSOLE" />
      </logger>
  </springProfile>
  <!-- 生产环境 -->
  <springProfile name="prod">
      <logger name="com.pl" level="ERROR">
          <appender-ref ref="CONSOLE" />
          <appender-ref ref="FILE" />
      </logger>
  </springProfile>
  

  
  

完整的日志配置文件 案例详解

实现了基于日期和大小翻滚的策略，以及经 INFO 和 ERROR 日志区分输出，还有规范日志输出格式等

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="true">
 
    <!-- appender是configuration的子节点，是负责写日志的组件。 -->
    <!-- ConsoleAppender：把日志输出到控制台 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!-- 默认情况下，每个日志事件都会立即刷新到基础输出流。 这种默认方法更安全，因为如果应用程序在没有正确关闭appender的情况下退出，则日志事件不会丢失。但是，为了显着增加日志记录吞吐量，可以将immediateFlush属性设置为false -->
        <!--<immediateFlush>true</immediateFlush>-->
        <encoder>
            <!-- %37():如果字符没有37个字符长度,则左侧用空格补齐 -->
            <!-- %-37():如果字符没有37个字符长度,则右侧用空格补齐 -->
            <!-- %15.15():如果记录的线程字符长度小于15(第一个)则用空格在左侧补齐,如果字符长度大于15(第二个),则从开头开始截断多余的字符 -->
            <!-- %-40.40():如果记录的logger字符长度小于40(第一个)则用空格在右侧补齐,如果字符长度大于40(第二个),则从开头开始截断多余的字符 -->
            <!-- %msg：日志打印详情 -->
            <!-- %n:换行符 -->
            <!-- %highlight():转换说明符以粗体红色显示其级别为ERROR的事件，红色为WARN，BLUE为INFO，以及其他级别的默认颜色。 -->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %highlight(%-5level) --- [%15.15(%thread)] %cyan(%-40.40(%logger{40})) : %msg%n</pattern>
            <!-- 控制台也要使用UTF-8，不要使用GBK，否则会中文乱码 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>
 
    <!-- info 日志文件-->
    <!-- RollingFileAppender：滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 -->
    <!-- 以下的大概意思是：
		1.先按日期存日志，日期变了，将前一天的日志文件名重命名为XXX%日期%索引，新的日志仍然是project_info.log
    	2.如果日期没有发生变化，但是当前日志的文件大小超过10MB时，对当前日志进行分割 重命名-->
    <appender name="info_log" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--日志文件路径和名称-->
        <File>logs/project_info.log</File>
        <!--是否追加到文件末尾,默认为true-->
        <append>true</append>
        <!-- 打印除了ERROR的日志 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>DENY</onMatch> <!-- 如果命中ERROR就禁止这条日志 -->
            <onMismatch>ACCEPT</onMismatch> <!-- 如果没有命中就使用这条规则 -->
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!-- 日志文件的名字会根据fileNamePattern的值，每隔一段时间改变一次 -->
            <!-- 文件名示例：logs/project_info.2017-12-05.0.log -->
            <!-- 注意：SizeAndTimeBasedRollingPolicy中 ％i和％d令牌都是强制性的，必须存在，否则报错 -->
            <fileNamePattern>logs/project_info.%d.%i.log</fileNamePattern>
            <!-- 每产生一个日志文件，该日志文件的保存期限为30天 -->
			<!-- 注：maxHistory的单位是根据fileNamePattern中的翻转策略自动推算出来的，例如上面选用了yyyy-MM-dd，则单位为天，如果上面选用了yyyy-MM，则单位为月。另外上面的单位默认为yyyy-MM-dd-->
            <maxHistory>30</maxHistory>
            <!-- 每个日志文件到10mb的时候开始切分，最多保留30天，但最大到20GB，哪怕没到30天也要删除多余的日志 -->
            <totalSizeCap>20GB</totalSizeCap>
            <!-- maxFileSize:这是活动文件的大小，默认值是10MB，测试时可改成5KB看效果 -->
            <maxFileSize>10MB</maxFileSize>
        </rollingPolicy>
        <!--编码器-->
        <encoder>
            <!-- pattern节点，用来设置日志的输入格式 ps:日志文件中不要设置颜色,否则颜色部分会有ESC[0:39em等乱码-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level --- [%15.15(%thread)] %-40.40(%logger{40}) : %msg%n</pattern>
            <!-- 记录日志的编码:此处设置字符集 - -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>
 
    <!-- error 日志文件-->
    <appender name="error_log" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--日志文件路径和名称-->
        <File>logs/project_error.log</File>
        <!--是否追加到文件末尾,默认为true-->
        <append>true</append>
        <!-- ThresholdFilter过滤低于指定阈值的事件。 对于等于或高于阈值的事件，ThresholdFilter将在调用其decision（）方法时响应NEUTRAL。 但是，将拒绝级别低于阈值的事件 -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <!-- 低于ERROR级别的日志（debug,info）将被拒绝，等于或者高于ERROR的级别将相应NEUTRAL -->
            <level>ERROR</level>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!-- 活动文件的名字会根据fileNamePattern的值，每隔一段时间改变一次 -->
            <!-- 文件名示例：logs/project_error.2017-12-05.0.log -->
            <!-- 注意：SizeAndTimeBasedRollingPolicy中 ％i和％d令牌都是强制性的，必须存在，要不会报错 -->
            <fileNamePattern>logs/project_error.%d.%i.log</fileNamePattern>
            <!-- 每产生一个日志文件，该日志文件的保存期限为30天 -->
            <maxHistory>30</maxHistory>
            <!-- 每个日志文件到10mb的时候开始切分，最多保留30天，但最大到20GB，哪怕没到30天也要删除多余的日志 -->
            <totalSizeCap>20GB</totalSizeCap>
            <!-- maxFileSize:这是活动文件的大小，默认值是10MB，测试时可改成5KB看效果 -->
            <maxFileSize>10MB</maxFileSize>
        </rollingPolicy>
        <!--编码器-->
        <encoder>
            <!-- pattern节点，用来设置日志的输入格式-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level --- [%15.15(%thread)] %-40.40(%logger{40}) : %msg%n</pattern>
            <!-- 记录日志的编码:此处设置字符集 - -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>
 
    <!-- configuration中最多允许一个root，别的logger如果没有设置级别则从父级别root继承 -->
    <root level="INFO">
        <appender-ref ref="STDOUT" />
    </root>
 
    <!-- name属性指定项目中某个包，当有日志操作行为时的日志记录级别 -->
    <logger name="com.sailing.springbootmybatis" level="INFO">
        <appender-ref ref="info_log" />
        <appender-ref ref="error_log" />
    </logger>
 
    <!-- 利用logback输入mybatis的sql日志，
    注意：如果不加 additivity="false" 则此logger会将输出转发到自身以及祖先的logger中，就会出现日志文件中sql重复打印-->
    <logger name="com.sailing.springbootmybatis.mapper" level="DEBUG" additivity="false">
        <appender-ref ref="info_log" />
        <appender-ref ref="error_log" />
    </logger>
 
    <!-- additivity=false代表禁止默认累计的行为，即com.atomikos中的日志只会记录到日志文件中，不会输出层次级别更高的任何appender-->
    <logger name="com.atomikos" level="INFO" additivity="false">
        <appender-ref ref="info_log" />
        <appender-ref ref="error_log" />
    </logger>
 
</configuration>