springboot 日志配置（logback）（一）

概述

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>

1. 引入 spring-boot-starter-log4j2

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

自定义日志配置

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

• 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
• 1

• 虽然一般并不需要改变配置文件的名字，但是如果想针对不同运行时 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：日志清理策略。通常是指日志保留的时间。

其他概念：

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