logback日志配置详解

最近，公司的项目突然要做日志配置的修改，所以，这里对 logback 的日志配置文件做了一下总结。logback 整体的运行机制是非常复杂而庞大的，这里只对 配置文件的一些节点，做简单的介绍，希望能对大家 ，有所帮助！

1.根节点 包含的属性：

• scan

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

• scanPeriod

  设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟

• debug

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

configuration>

2.根节点 的子节点

1.logger

• logger

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

  • name 用来指定受此 loger 约束的某一个包或者具体的某一个类

  • level 用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特殊值 INHERITED 或者同义词 NULL ，代表强制执行上级的级别。

    如果未设置此属性，那么当前 logger 将会继承上级的日志级别

  • addtivity 是否向上级 logger 传递打印信息。默认是true

	
<logger name="org.mybatis" level="INFO"/>

---

2.appender

• appender

  是 的子节点，是负责写日志的组件。该标签负责以适当的格式将日志记录事件输出到适当的输出设备

  • name 指定appender名称

  • class 指定appender的全限定名

<appender name="ERROR-LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
    
appender>

常用的 appender 类型

RollingFileAppender

滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件

---

appender 的子标签

• encoder 对日志进行格式化

• target

• rollingPolicy 当发生滚动时，决定RollingFileAppender 的行为，涉及文件移动和重命名(设置滚动策略)

  • class ：

    为 rollingPolicy 的属性，设置 日志的滚动策略，最常用的滚动策略为

    TimeBasedRollingPolicy ：它根据时间来制定滚动策略，既负责滚动也负责出发滚动

  rollingPolicy 的 子节点

  ​ : 为一个必要的子节点，设置日志文件的名称 。一般包含文件名及“%d”转换符，“%d”可以包含一个java.text.SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}。如果直接使用 %d，默认格式是 yyyy-MM-dd。

  ​ : 可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。

<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    
    <fileNamePattern>${log.home}/%d{yyyy-MM,aux}/soi-%d{yyyy-MM-dd}.error.logfileNamePattern>
    
    <maxHistory>30maxHistory>
rollingPolicy>

• filter :

  为日志过滤器。执行一个过滤器会有返回一个枚举值，即 DENY，NEUTRAL，ACCEPT 其中之一。

  • class ：为 filter 设置指定的过滤器 ，下面列举几个常见的 过滤器

  几个常见的日志过滤器

  LevelFilter ：级别过滤器，根据日志级别进行过滤。如果日志级别等于配置级别，过滤器会根据onMath 和 onMismatch接收或拒绝日志

  例如，下面这个例子，将 所有 degug 级别的日志交给 他的 父节点 appender 去处理

  
  <filter class="ch.qos.logback.classic.filter.LevelFilter">
      
      <level>DEBUGlevel>
       
      <onMatch>ACCEPTonMatch>
      
      <onMismatch>DENYonMismatch>
  filter>
  

  ThresholdFilter ：临界值过滤器，过滤掉低于指定临界值的日志。当日志级别等于或高于临界值时，过滤器返回NEUTRAL；当日志级别低于临界值时，日志会被拒绝。

  例如，下面这个例子，将 所有 低于 WARN 级别的日志过滤掉

   <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
       <level>WARNlevel>
  filter>
  

  EvaluatorFilter ：求值过滤器，评估、鉴别日志是否符合指定条件。需要额外的两个JAR包，commons-compiler.jar和janino.jar。用的比较少，这里不详细展开

  ---

3.root

• root 为根元素，只有一个level属性。 可以包含零个或多个 元素
  • level 设置日志级别。

<root level="INFO">
    <appender-ref ref="ASYNC-INFO"/>
root>

---

3.springBoot如何整合 logback

springBoot已经帮我们引入了，使用logback的相关 jar 包，所以我们不需要 再去引用

• 查找 日志 依赖所在位置

  • springboot的pom文件都会引一个parent

    <parent>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-parentartifactId>
        <version>2.0.0.RELEASEversion>
    parent>
    

  • 点进去这个parent，会有一个这个dependency

    <parent>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-dependenciesartifactId>
        <version>2.0.0.RELEASEversion>
        <relativePath>../../spring-boot-dependenciesrelativePath>
    parent>
    

  • 再点进去就是2.0版本，所谓的它给你集成的各种包依赖，而且规定了版本号，其中有一个包如下

     <dependency>
         <groupId>org.springframework.bootgroupId>
         <artifactId>spring-boot-starterartifactId>
         <version>2.0.0.RELEASEversion>
    dependency>
    

  • 再点进去

    <dependency>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-loggingartifactId>
        <version>2.0.0.RELEASEversion>
        <scope>compilescope>
    dependency>
    

  • 再点，这些都是原有的日志包，所以，不必再引依赖了，直接用就ok了，用法如下：

    <dependencies>
        <dependency>
            <groupId>ch.qos.logbackgroupId>
            <artifactId>logback-classicartifactId>
            <version>1.2.3version>
            <scope>compilescope>
        dependency>
        <dependency>
            <groupId>org.apache.logging.log4jgroupId>
            <artifactId>log4j-to-slf4jartifactId>
            <version>2.11.1version>
            <scope>compilescope>
        dependency>
        <dependency>
            <groupId>org.slf4jgroupId>
            <artifactId>jul-to-slf4jartifactId>
            <version>1.7.25version>
            <scope>compilescope>
        dependency>
    dependencies>
    

• 在项目 资源文件夹 resources 下 创建 logback-spring.xml 文件。logback 将会自动读取该配置文件文件，下面给出 配置文件 样例。

<configuration scan="true" scanPeriod="60 seconds">
  

  <appender name="CONSOLE-LOG" class="ch.qos.logback.core.ConsoleAppender">
    <layout class="ch.qos.logback.classic.PatternLayout">
      <pattern>${CONSOLE_LOG_PATTERN}pattern>
    layout>
  appender>
  
  <appender name="INFO-LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
      <level>DEBUGlevel>
      <onMatch>DENYonMatch>
      <onMismatch>ACCEPTonMismatch>
    filter>
    <encoder>
      <pattern>${CONSOLE_LOG_PATTERN}pattern>
    encoder>

    
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      
      <fileNamePattern>${log.home}/%d{yyyy-MM,aux}/soi-%d{yyyy-MM-dd}.info.logfileNamePattern>
      <maxHistory>30maxHistory>
    rollingPolicy>
  appender>

  <appender name="ERROR-LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
      <level>ERRORlevel>
    filter>
    <encoder>
      <pattern>${CONSOLE_LOG_PATTERN}pattern>
    encoder>
    
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      
      <fileNamePattern>${log.home}/%d{yyyy-MM,aux}/soi-%d{yyyy-MM-dd}.error.logfileNamePattern>
      <maxHistory>30maxHistory>
    rollingPolicy>
  appender>
  
  <appender name="ASYNC-ERROR" class="ch.qos.logback.classic.AsyncAppender">
    
    <discardingThreshold>0discardingThreshold>
    
    <queueSize>256queueSize>
    
    <appender-ref ref="ERROR-LOG"/>
  appender>

  
  <springProfile name="dev,loc">
    <root level="DEBUG">
      <appender-ref ref="CONSOLE-LOG"/>
    root>
  springProfile>

  <springProfile name="test,uat">
    <root level="INFO">
      <appender-ref ref="ASYNC-INFO"/>
    root>
  springProfile>

  
  <logger name="org.mybatis" level="INFO"/>

configuration>

常用地址

logback官网地址：https://logback.qos.ch/manual/

logback中文手册：https://www.docs4dev.com/docs/zh/logback/1.3.0-alpha4/reference/