SpringBoot日志框架使用详解

向右看齐 2024-03-26 11:43 62阅读 0赞

几种常见的日志级别由低到高分为：TRACE < DEBUG < INFO < WARN < ERROR < FATAL 。如何理解这个日志级别呢？很简单，如果项目中的日志级别设置为INFO ，那么比它更低级别的日志信息 就看不到了，即是TRACE 、DEBUG日志将会不显示。

> 常见的日志框架有 log4j 、 logback 、 log4j2 。

*  `log4j` 这个日志框架显示是耳熟能详了，在Spring开发中是经常使用，但是据说log4j官方已经不再更新了，而且在性能上比logback 、log4j2差了很多。
 *  `logback` 是由log4j创始人设计的另外一个开源日志框架，logback相比之于log4j性能提升了10以上， 初始化内存加载也更小了。作为的Spring Boot默认的日志框架肯定是有着不小的优势。
 *  `log4j2` 晚于 logback 推出，官网介绍性能比 logback 高，坊间流传，log4j2在很多思想理念上都是照抄logback，因此即便log4j2是Apache官方项目，Spring等许多框架项目没有将它纳入主流。

原则上需要使用logback，需要添加以下依赖，但是既然是默认的日志框架，当然不用重新引入依赖了。

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

### 使用方式 ###

private final Logger logger = LoggerFactory.getLogger(DemoApplicationTests.class);

上面是基本的使用方式，lombok简化了输出日志的操作。

@Slf4j
    class DemoApplicationTests {
        
        @Test
        public void test(){
        
            log.debug("输出DEBUG日志.......");
        }
    }

### 如何定制日志级别？ ###

Spring Boot中默认的日志级别是INFO，但是可以自己定制日志级别，还支持 package 级别的日志级别调整，配置如下：

logging.level.root=DEBUG
    logging.level.com.example.demo=INFO

### 日志如何输出到文件？ ###

注意：官方文档说这两个属性不能同时配置，否则不生效，因此只需要配置一个即可。

1.  `logging.file.path`：指定日志文件的路径
2.  `logging.file.name`：日志的文件名，默认为spring.log

指定输出的文件为当前项目路径的 logs 文件下，默认生成的日志文件为 spring.log ，如下：

logging.file.path=./logs

### 如何定制日志格式？ ###

1.  logging.pattern.console ：控制台的输出格式
2.  logging.pattern.file ：日志文件的输出格式

例如配置如下：

logging.pattern.console==%d{yyyy/MM/dd-HH:mm:ss} [%thread] %-5level %logger- %msg%n
    logging.pattern.file=%d{yyyy/MM/dd-HH:mm} [%thread] %-5level %logger- %msg%n

上面的配置编码的含义如下：

%d{HH:mm:ss.SSS} —— 日志输出时间
    %thread   ——   输出日志的进程名字，这在Web应用以及异步任务处理中很有用
    %-5level  ——   日志级别，并且使用5个字符靠左对齐
    %logger   ——   日志输出者的名字
    %msg      ——   日志消息
    %n        ——   平台的换行符

#### 如何自定义日志配置？ ####

Spring Boot官方文档指出，根据不同的日志系统，可以按照如下的日志配置文件名就能够被正确加 载，如下：

1.  Logback ：logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
2.  Log4j ：log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
3.  Log4j2 ：log4j2-spring.xml, log4j2.xml
4.  JDK (Java Util Logging) ：logging.properties

SpringBoot官方推荐优先使用带有`-spring`的文件名作为你的日志配置。因此只需要在 src/resources 文件夹下创建 logback-spring.xml 即可，配置文件如下：

<?xml version="1.0" encoding="UTF-8"?>
    <configuration scan="true" scanPeriod="60 seconds" debug="false">
        
        <property name="logPath" value="logs"/>
        
        <property name="PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t-%L] %-5level %logger{36} %L %M - %msg%xEx%n"/>
        <contextName>logback</contextName>
        
        <appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender">
            
            <layout class="ch.qos.logback.classic.PatternLayout">
                <pattern>${PATTERN}</pattern>
            </layout>
            
            
            
            
        </appender>
        
        <appender name="fileDEBUGLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                
                <level>Error</level>
                
                <onMatch>DENY</onMatch>
                
                <onMismatch>ACCEPT</onMismatch>
            </filter>
            
            <File>${logPath}/log_demo.log</File>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <FileNamePattern>${logPath}/log_demo_%d{yyyy-MM-dd}.log</FileNamePattern>
                
                <maxHistory>90</maxHistory>
                
                
            </rollingPolicy>
            
            <encoder>
                <charset>UTF-8</charset>
                <pattern>${PATTERN}</pattern>
            </encoder>
        </appender>
        
        <appender name="fileErrorLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                <level>Error</level>
            </filter>
            
            <File>${logPath}/error.log</File>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <FileNamePattern>${logPath}/error_%d{yyyy-MM-dd}.log</FileNamePattern>
                
                <maxHistory>90</maxHistory>
                
                
            </rollingPolicy>
            
            <encoder>
                <charset>UTF-8</charset>
                <pattern>${PATTERN}</pattern>
            </encoder>
        </appender>
        
        <root level="DEBUG">
            
            <appender-ref ref="consoleLog"/>
            <appender-ref ref="fileDEBUGLog"/>
            <appender-ref ref="fileErrorLog"/>
        </root>
        
        <logger name="org.springframework" level="DEBUG"></logger>
        <logger name="org.mybatis" level="DEBUG"></logger>
        <logger name="java.sql.Connection" level="DEBUG"></logger>
        <logger name="java.sql.Statement" level="DEBUG"></logger>
        <logger name="java.sql.PreparedStatement" level="DEBUG"></logger>
        <logger name="io.lettuce.*" level="INFO"></logger>
        <logger name="io.netty.*" level="ERROR"></logger>
        <logger name="com.rabbitmq.*" level="DEBUG"></logger>
        <logger name="org.springframework.amqp.*" level="DEBUG"></logger>
        <logger name="org.springframework.scheduling.*" level="DEBUG"></logger>
        
        <logger name="com.xxx.xxx.xx" additivity="false" level="DEBUG">
            <appender-ref ref="fileDEBUGLog"/>
            <appender-ref ref="fileErrorLog"/>
        </logger>
    </configuration>

当然，如果就不想用Spring Boot推荐的名字，想自己定制也行，只需要在配置文件中指定配置文件名 即可，如下：

logging.config=classpath:logging-config.xml