SpringMVC集成Logback

雨点打透心脏的1/2处 2022-05-13 04:26 296阅读 0赞

# SpringMVC集成Logback日志管理 #

*  SpringMVC集成Logback日志管理
    
     *  前言
     *  一、maven依赖相关jar包
     *  二、创建logback.xml配置文件
     *  三、配置中遇到问题详解

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

## 前言 ##

原来使用springboot配置logback非常的简单。今天使用springMVC配置了一下，坑挺多的，包括路径配置。看了很多博客，都是有坑的，这里记录一下，以免以后再踩坑。

## 一、maven依赖相关jar包 ##

在项目的pom.xml文件里添加如下配置，在很多博客上看到还有添加logback-ext-spring，这里没必要添加这个包。

<dependency>
                <groupId>ch.qos.logback</groupId>
                <artifactId>logback-classic</artifactId>
                <version>1.2.3</version>
            </dependency>
            <dependency>
                <groupId>ch.qos.logback</groupId>
                <artifactId>logback-access</artifactId>
                <version>1.2.3</version>
            </dependency>

## 二、创建logback.xml配置文件 ##

在我们项目的resource目录下，创建一个名为logback.xml的配置文件。注意这个名字，如果不想在web.xml里面配置context-param，请用这个名字。具体后面详解。  
logback.xml文件内容如下

<?xml version="1.0" encoding="UTF-8"?>
    <configuration>
        <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
        <property name="LOG_FILE" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/spring.log}"/>
        <include resource="org/springframework/boot/logging/logback/console-appender.xml"/>
    
        
        <property name="PATH" value="../logs/test"/>
    
        
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
            <Encoding>UTF-8</Encoding>
            <layout class="ch.qos.logback.classic.PatternLayout">
                <pattern>[%date{yyyy-MM-dd HH:mm:ss}] [%-5level] [%logger:%line] --%mdc{client} %msg%n</pattern>
            </layout>
        </appender>
    
        
        <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${PATH}/spring.log</file>
            <append>true</append>
            <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
                <fileNamePattern>${PATH}/spring.log.%d{yyyy-MM-dd}.%i.gz</fileNamePattern>
                <maxFileSize>100MB</maxFileSize>
                <maxHistory>30</maxHistory>
                <totalSizeCap>3GB</totalSizeCap>
            </rollingPolicy>
            <encoder>
                <pattern>[%date{yyyy-MM-dd HH:mm:ss}] [%-5level] [%logger:%line] --%mdc{client} %msg%n</pattern>
            </encoder>
        </appender>
        <logger name="org.springframework.web" level="DEBUG"></logger>
    
        
        <root level="INFO">
            <appender-ref ref="FILE"/>
            <appender-ref ref="CONSOLE"/>
        </root>
    
    </configuration>

到这里就配置好了，我们启动tomacat，就可以在tomacat的logs/test下看到我们的日志文件了。

## 三、配置中遇到问题详解 ##

1、关于logback.xml的命名问题  
在我们启动tomacat后，会看到日志中有一段内容，如下  
![这里写图片描述][70]

可以看到，logback在加载配置时，会先去找名为logback-test.xml，然后找logback.groovy,最后找logback.xml，如果找到就会应用我们的配置。如果未找到，就默认配置。  
如果我们不想用logback.xml这个名称，例如使用logback-spring.xml，我们可以在项目的web.xml里面配置

<context-param>
        <param-name>logbackConfigLocation</param-name>
        <param-value>classpath:logback-spring.xml</param-value>
      </context-param>

2、关于路径输出日志的问题。  
由于个人喜欢用相对路径，也比较好管理。所以在logback.xml里面，配置基本路径为value=”../logs/test”

<property name="PATH" value="../logs/test"/>
    
        <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${PATH}/spring.log</file>
            <append>true</append>
            <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
                <fileNamePattern>${PATH}/spring.log.%d{yyyy-MM-dd}.%i.gz</fileNamePattern>
                <maxFileSize>100MB</maxFileSize>
                <maxHistory>30</maxHistory>
                <totalSizeCap>3GB</totalSizeCap>
            </rollingPolicy>
            <encoder>
                <pattern>[%date{yyyy-MM-dd HH:mm:ss}] [%-5level] [%logger:%line] --%mdc{client} %msg%n</pattern>
            </encoder>
        </appender>

关于路径的介绍：  
文件相对保存路径设置可分以下三种：  
1. value=“logs” – 表示保存到程序运行目录，在tomcat中为bin目录  
2. value=“/logs” – 表示保存到系统目录，比如你的项目运行在D盘，这个就在D盘的根目录下。  
3. value=“../logs” – 表示保存到程序运行目录的父目录，tomacat运行时，有一个logs的目录，最好配置时，加上自己应用名称，以做区分。

好了到这里就结束了，也算记录一下吧。很多博客的配置都是有问题的，希望这里能帮到大家。

[70]: /images/20220513/d697382244c245188bb82279c7d49cc6.png