spring boot配置logback日志

ゝ一纸荒年。 2023-10-02 16:49 58阅读 0赞

## **spring boot配置logback日志** ##

--------------------

#### **在上一篇spring boot入门里提过，Spring Boot默认的日志打印是logback,所以配置logback日志会很简单，但是也有注意的地方。** ####

### 本次配置日志的需求 ###

1.  日志需要控制台打印和文件打印两种。
2.  其中文件打印按照日志级别分别保存到各自的文件里。
3.  文件日志每天一个日志，并且保存30天。
4.  文件日志可以自由指定保存路径、打印格式等。
5.  控制台打印可指定打印格式，并且自由增加删除某些日志。

**通过上一篇的介绍，知道，Spring boot默认日志为logback，所以只要引入如下依赖，就会自动引入logback日志的jar包。**

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

##### **单独spring 项目使用 logback日志需要的jar包如下：** #####

<dependency>
    	<groupId>ch.qos.logback</groupId>
    	<artifactId>logback-classic</artifactId>
    	<version>1.1.9</version>
    </dependency>
    
    <dependency>
    	<groupId>ch.qos.logback</groupId>
    	<artifactId>logback-core</artifactId>
    	<version>1.1.9</version>
    </dependency>
    
    <dependency>
    	<groupId>org.slf4j</groupId>
    	<artifactId>slf4j-api</artifactId>
    	<version>1.7.22</version>
    </dependency>1234567891011121314151617

##### **再说一遍，spring boot项目不需要引入上边的三个jar包，已经自动引入了。** #####

#### **以下是配置步骤：** ####

*  **logback日志的在spring boot里的配置需要在src/main/resources下，application.properties同级，放一个logback的xml文件，一般起名字为logback-spring.xml，网上很多人建议起名字为这个，我没看出有什么区别，所以我就按照他们讲的配置了，以免出现不必要的错误。**
 *  **logback-spring.xml按照我的需求配置成控制台打印和文件打印，直接将以下内容复制，并命名成该名字，放到上边说的位置中，具体的内容如下：**

<?xml version="1.0" encoding="UTF-8"?>  
    <configuration scan="true" scanPeriod="60 seconds">  
        
        
          
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">  
            <encoder>  
                <pattern>${CONSOLE_LOG_PATTERN}</pattern>  
            </encoder>  
        </appender>  
          
        <appender name="infoAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">  
              
            <file>${LOG_PATH}/info/info.log</file>  
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">  
                  
                <fileNamePattern>info/info-%d{yyyy-MM-dd}.log  
                </fileNamePattern>  
                  
                <MaxHistory>30</MaxHistory>  
            </rollingPolicy>  
            <encoder>  
                <pattern>${FILE_LOG_PATTERN}</pattern>  
            </encoder>  
            <filter class="ch.qos.logback.classic.filter.LevelFilter">  
                <level>INFO</level>  
                <onMatch>ACCEPT</onMatch>    
                <onMismatch>DENY</onMismatch>    
            </filter>  
        </appender>
    
          
        <appender name="debugAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">  
              
            <file>${LOG_PATH}/debug/debug.log</file>  
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">  
                  
                <fileNamePattern>debug/debug-%d{yyyy-MM-dd}.log</fileNamePattern>  
                  
                <MaxHistory>30</MaxHistory>  
            </rollingPolicy>  
            <encoder>  
                <pattern>${FILE_LOG_PATTERN}</pattern>  
            </encoder>  
            <filter class="ch.qos.logback.classic.filter.LevelFilter">  
                <level>DEBUG</level>  
                <onMatch>ACCEPT</onMatch>    
                <onMismatch>DENY</onMismatch>    
            </filter>  
        </appender> 
           
        <appender name="warnAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">  
               
            <file>${LOG_PATH}/warn/warn.log</file>  
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">  
                  
                <fileNamePattern>warn/warn-%d{yyyy-MM-dd}.log  
                </fileNamePattern>  
                  
                <MaxHistory>30</MaxHistory>  
            </rollingPolicy>  
            <encoder>  
                <pattern>${FILE_LOG_PATTERN}</pattern>  
            </encoder>  
            <filter class="ch.qos.logback.classic.filter.LevelFilter">  
                <level>WARN</level>  
                <onMatch>ACCEPT</onMatch>    
                <onMismatch>DENY</onMismatch>    
            </filter>  
        </appender> 
    
          
        <appender name="errorAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">  
              
            <file>${LOG_PATH}/error/error.log</file>  
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">  
                  
                <fileNamePattern>error/error-%d{yyyy-MM-dd}.log  
                </fileNamePattern>  
                  
                <MaxHistory>30</MaxHistory>  
            </rollingPolicy>  
            <encoder>  
                <pattern>${FILE_LOG_PATTERN}</pattern>  
            </encoder>  
            <filter class="ch.qos.logback.classic.filter.LevelFilter">  
                <level>ERROR</level>  
                <onMatch>ACCEPT</onMatch>    
                <onMismatch>DENY</onMismatch>    
            </filter>  
        </appender>
          <logger name="org.springframework" additivity="false">
            <level value="ERROR" />
            <appender-ref ref="STDOUT" />
            <appender-ref ref="errorAppender" />
        </logger>
    
        
        <logger name="org.apache.tomcat.util" additivity="false">
            <level value="ERROR"/>
            <appender-ref ref="STDOUT"/>
            <appender-ref ref="errorAppender"/>
        </logger>
    
        
        <logger name="org.hibernate.validator" additivity="false">
            <level value="ERROR"/>
            <appender-ref ref="STDOUT"/>
            <appender-ref ref="errorAppender"/>
        </logger>
        <root level="DEBUG">
             <appender-ref ref="STDOUT"/>  
             <appender-ref ref="infoAppender"/>
             <appender-ref ref="debugAppender"/>
              <appender-ref ref="warnAppender"/>
             <appender-ref ref="errorAppender"/>
        </root> 
    </configuration>

**其中,你们应该注意到里边有很多的“`${}`”形式的变量这其实是logback日志的默认名称，比如**`${LOG_PATH},${CONSOLE_LOG_PATTERN},${FILE_LOG_PATTERN}` **等，这些变量只需要在spring boot的默认配置文件，application.properties里添加如下配置即可：**

**1）以下是日志输出的位置，注意在logback-spring.xml里用LOG\_PATH才能获取到值**

logging.path=d:/logs/springBoot

**2）以下是指向日志配置文件的位置**

logging.config=classpath:logback-spring.xml

**3）以下是控制台打印日志格式设置，注意在logback-spring.xml里用CONSOLE\_LOG\_PATTERN才能获取**

logging.pattern.console=[%d{yyyy-MM-dd HH:mm:ss}] -- [%-5p]: [%c] -- %m%n

**4）以下是文件打印日志格式设置，注意在logback-spring.xml里用FILE\_LOG\_PATTERN才能获取到**

logging.pattern.file=[%d{yyyy-MM-dd HH:mm:ss}] -- [%-5p]: [%c] -- %m%n

**添加上边四个配置就对日志配置完了。多说一句，为什么在application.properties文件里的日志配置名字和**`${}` **里不同呢，这就需要看logback-spring.xml里最上边的base.xml引入，找到这个文件就明白了。它的位置在以下jar包里：**

spring-boot-1.5.1.RELEASE.jar

**找到如下位置：**

org.springframework.boot.logging.logback

**就会看到里边有base.xml、console-appender.xml等等四个xml文件，打开file.appender.xml如下：**

![注意图中红色标注][SouthEast]

##### **也就是说spring boot里的日志配置文件已经将其写死，但是在application.properties里又要按照其要求写，所以我感觉这也是spring boot的缺点，太多隐藏的配置了，如果知道，那很简单了，但是不知道，就会浪费很多的时间，多配置很多的无用东西。** #####

##### **通过这四个spring boot的日志xml文件，也应该知道为什么在上一篇入门spring boot里没有配置日志，却打印日志的原因，其内在自己的日志应该就是这个。** #####

**另外说一下日志的打印控制，比如有一些打印日志我不想要，就可以通过配置logback-spring.xml文件，添加一个logger标签即可。比如如下：**

[2021-06-05 19:14:23] -- [INFO ]: [org.I0Itec.zkclient.ZkClient] -- zookeeper state changed (SyncConnected)
    [2021-06-05 19:14:23] -- [DEBUG]: [org.I0Itec.zkclient.ZkClient] -- Leaving process event
    [2021-06-05 19:14:23] -- [DEBUG]: [org.I0Itec.zkclient.ZkClient] -- State is SyncConnected123

**以上三条日志我现在不需要让它打印了，那就需要额外配置了，因为它们来自于**`org.I0Itec.zkclient.ZkClient` **类，并且打印的内容分别是DEBUG和INFO级别，日志打印只要将该类的日志打印级别调高（日志从低到高为 TRACE、DEBUG、INFO、WARN、ERROR），因此只要将该类的日志级别配置为WARN以上，就不会打印上边的内容了。配置方法如下：**

**其中：**

**name表示日志的打印位置，从上边可以看出是来自该类**。  
**additivity设置为false表示该日志打印设置（控制台打印还是文件打印等具体设置）不会向根root标签传递，也就是说该logger里怎么设置的那就会怎么打印，跟root无关**。  
**level value=’error’表示将该类日志级别设置为error级才会打印。**  
**最后两行表示error级时会打印控制台和error文件同时打印日志。**

#### **配置logback日志的注意点：** ####

1.  logback和log4j最好不要放在一起，会冲突，最主要的jar包是`slf4j-log4j12.jar` 和 `logback-classic.jar` 这两个jar包的设计简直是反人类，有一个类，这两个都会有，只要这两个jar包同时引入，就会看到启动spring boot会有一串冲突的红字，因此，只要用logback日志，就需要特别注意除了排除log4j主要jar包，别忘了排除`slf4j-log4j12.jar` ，具体的排除方法，可以选择maven项目的pom.xml，在右边找到Dependency Hierarchy，然后找到要排除的jar包，右击选择Exclude Maven Artifact，然后保存即可。
2.  logback的logback-spring.xml文件如果你没有按照我这么写，在application.properties文件里就不需要配置全部的4行内容，如果直接复制的我的，那就需要配置上了。
3.  logback貌似没有log4j常用，很多的第三方jar包都使用的log4j，比如aliba的dubbo和zookeeper都是默认的log4j，所以你在引入第三方的jar时，又使用的是logback，就特别注意是不是它们默认使用的log4j，如果是的话，有`slf4j-log4j12.jar` 就排除即可。后边说spring boot+dubbo时会再说。

[SouthEast]: https://img-blog.csdn.net/20170605184904924?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQvd29oYXFpeWk=/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast