SpringBoot、SpringMVC集成logback日志

水深无声 2022-01-20 15:09 365阅读 0赞

日志主要分为：trace<debug<info<warn<error五种，级别为由低到高

*  trace：主要为程序的追踪，判断程序执行到哪步
 *  debug：调试使用的日志输出
 *  info：输出一些信息帮助了解程序运行状态
 *  warn：程序发出一些警告信息
 *  error：程序出错时发出的信息

常用的日志主要分为两种：logback和log4j，都是基于sl4j开发演变而来的，logback更方便使用的人更多，配置里面会有很多坑（生成日志路径…）帮大家避免一下。

## 前言 ##

项目中我引用`lombok`包的`@Slf4j`注解，所以需要输入日志类中不需要再加

Logger log= LoggerFactory.getLogger(getClass());

如果我们没有使用`lombok`包需要添加代码为：

public class SpringbootApplicationTests { 
    
        Logger log= LoggerFactory.getLogger(getClass());
        
        public void loggerInfo() { 
        	log.trace("这是trace");
        	log.debug("这是debug");
            log.info("这是info");
            log.warn("这是warn");
            log.error("这是error");
        }
    }

logback.xml内容

<?xml version="1.0" encoding="UTF-8"?>
    
    
    
    
    <configuration scan="true" scanPeriod="60 seconds" debug="false">
        <contextName>logback</contextName>
    
        
        <property name="log.path" value="logs"/>
    
        
        
        <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
        <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/>
        <conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter"/>
        
        <property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%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${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
    
        
        <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
            
            <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                <level>debug</level>
            </filter>
            <encoder>
                <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
                
                <charset>UTF-8</charset>
            </encoder>
        </appender>
    
        
        
        <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${log.path}/debug.log</file>
            
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
                <charset>UTF-8</charset>
            </encoder>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <fileNamePattern>${log.path}/debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>debug</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        
        <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${log.path}/info.log</file>
            
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
                <charset>UTF-8</charset>
            </encoder>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <fileNamePattern>${log.path}/info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>info</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        
        <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${log.path}/warn.log</file>
            
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
                <charset>UTF-8</charset>
            </encoder>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${log.path}/warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>warn</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        
        <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${log.path}/error.log</file>
            
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
                <charset>UTF-8</charset>
            </encoder>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${log.path}/error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>ERROR</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        
        
        
    
        
    
        
    
        
    
        
        
        <springProfile name="dev">
            <logger name="com" level="debug"/>
        </springProfile>
    
        <root level="info">
            <appender-ref ref="CONSOLE"/>
            <appender-ref ref="DEBUG_FILE"/>
            <appender-ref ref="INFO_FILE"/>
            <appender-ref ref="WARN_FILE"/>
            <appender-ref ref="ERROR_FILE"/>
        </root>
    
        
    
    </configuration>

## SpringBoot ##

*  引用pom依赖

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

*  通过配置文件使用日志文件

# 日志配置
    # 不指定路径在当前项目下生成日志，值为：G:/springboot.log在G盘下生成
    logging.file=springboot.log
    # 当前磁盘的根路径创建spring/log文件夹，使用spring.log作为默认文件
    #logging.path=/spring/log
    #logging.file和logging.path不能同时使用，否则不起作用，一般使用logging.file
    
    # 控制台输出日志格式 日期时间，线程名 级别 全类名50个字符 消息和换行
    logging.pattern.console=%d{ yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{ 50} - %msg%n
    # 指定文件中输出日志格式
    logging.pattern.file=%d{ yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{ 50} - %msg%n

*  使用logback.xml  
    把logback.xml放到resources目录下即可  
    如果logback.xml位置或名称有变量需要加：

logging:
      config: classpath:文件名称.xml

日志文件相对保存路径设置可分以下三种：

*  value="log"输入在项目文件夹下
 *  value="/log"输入在项目文件夹下
 *  value="。。/log"输入在项目上一次文件夹下

## SpringMVC ##

*  引用pom依赖

<dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>1.2.17</version>
            </dependency>
            <dependency>
                <groupId>ch.qos.logback</groupId>
                <artifactId>logback-core</artifactId>
                <version>1.2.3</version>
            </dependency>
            <dependency>
                <groupId>ch.qos.logback</groupId>
                <artifactId>logback-classic</artifactId>
                <version>1.2.3</version>
            </dependency>

*  使用logback.xml  
    把logback.xml放到resources目录下即可

日志文件相对保存路径设置可分以下三种：

*  value="log"表示保存到程序运行目录，在tomcat中为bin目录
 *  value="/log"表示保存到系统目录，比如你的项目运行在D盘，这个就在D盘的根目录下。
 *  value="。。/log"表示保存到程序运行目录的父目录，tomacat运行时，有一个logs的目录，最好配置时，加上自己应用名称，以做区分。

## 关于logback.xml的命名问题 ##

在我们启动tomacat后，会看到日志中有一段内容，如下 ：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gyNzM5Nzk1ODY_size_16_color_FFFFFF_t_70]  
可以看到，logback在加载配置时，会先去找名为logback-test.xml，然后找logback.groovy,最后找logback.xml，如果找到就会应用我们的配置。如果未找到，就默认配置。  
如果我们不想用logback.xml这个名称，例如使用logback-spring.xml，我们可以在项目的web.xml里面配置  
pom文件引用

<dependency>
                <groupId>org.logback-extensions</groupId>
                <artifactId>logback-ext-spring</artifactId>
                <version>0.1.4</version>
            </dependency>

web.xml

<context-param>
            <param-name>logbackConfigLocation</param-name>
            <param-value>classpath:logback-spring.xml</param-value>
        </context-param>
        <listener>
            <listener-class>ch.qos.logback.ext.spring.web.LogbackConfigListener</listener-class>
        </listener>

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2gyNzM5Nzk1ODY_size_16_color_FFFFFF_t_70]: /images/20220120/3c3be92c2afb4dacb2649e8700e8f21e.png