Spring Boot 使用logback生成日志文件

日志是一个系统非常重要的一部分，我们经常需要通过查看日志来定位问题，今天我们一起来学习一下Spring Boot的日志系统。有很多同学习惯性的在生产代码中使用System.out来输出日志，这是不推荐的一种做法，因为System.out是一个同步操作，会在一定程度上影响系统性能，而Logger是一个异步操作。

Spring Boot默认的日志系统是logback，当然我们并不需要去引用logback的依赖，因为在spring-boot-starter中已经应用了logback的依赖。

一、控制台日志信息介绍

1.1 日志级别

日志级别从高到低为：TRACE < DEBUG < INFO < WARN < ERROR < ALL < OFF。

如果日志设置为ERROR，那么低于ERROR级别的日志将不会输出。

如果我们想要设置某个包的日志级别，则在pom文件中加入下面这行配置：

logging:
  level:
    # 包名
    com.javatrip: warn

如果想修改Spring Boot默认级别，则将包名改为root。

logging:
  level:
    root: warn

1.2 控制台日志介绍

默认情况下，Spring Boot会将INFO级别的日志输出到控制台。控制台输出信息如下：

日志输出内容具体含义如下：

• 时间日期：精确到毫秒
• 日志级别：ERROR, WARN, INFO, DEBUG or TRACE
• 进程ID
• 分隔符：--- 标识实际日志的开始
• 线程名：方括号括起来（可能会截断控制台输出）
• Logger名：通常使用源代码的类名
• 日志内容

二、日志文件输出

在实际项目中，我们需要将日志输出为文件，以便快速定位问题。Spring Boot关于日志文件的信息可以参考官网https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#boot-features-logging。

Because the standard logback.xml configuration file is loaded too early, you cannot use extensions in it. You need to either use logback-spring.xml or define a logging.config property.

这句话的意思大概就是：由于标准的logback.xml配置文件加载得太早，因此您不能在其中使用扩展名。您需要使用logback-spring.xml或定义logging.config属性。

因此我们来定义一个logback-spring.xml的文件来进行日志信息的配置。

logback-spring.xml文件定义及注释：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 日志文件名 -->
    <property name="LOG_FILE" value="myLog" />
    <!-- 日志文件路径 -->
    <property name="LOG_PATH" value="D://log//dev" />
    <!-- 控制台日志输出格式 -->
    <property name="LOG_PATTERN_CONSOLE" value="%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} --> %msg%n" />
    <!-- 文件日志输出格式 -->
    <property name="LOG_PATTERN_FILE" value="%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{50} --> %msg%n" />
    <!--- 设置控制台日志 -->
    <appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>{LOG_PATTERN_CONSOLE}</pattern>
        </encoder>
    </appender>
    <!-- 设置日志文件 -->
    <appender name="fileLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <encoder>
            <pattern>{LOG_PATTERN_FILE}</pattern>
        </encoder>
        <!-- 总文件日志 -->
        <file>{LOG_PATH}/{LOG_FILE}.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 每天的文件日志 -->
            <fileNamePattern>{LOG_PATH}/{LOG_FILE}-%d{yyyy-MM-dd}.log</fileNamePattern>
            <!-- 日志文件保存7天，超过7天的自动删除 -->
            <maxHistory>7</maxHistory>
        </rollingPolicy>
    </appender>

    <!-- 设置日志级别，及需要记录日志的类 -->
    <root level="INFO">
        <appender-ref ref="consoleLog" />
        <appender-ref ref="fileLog" />
    </root>
</configuration>

启动项目后，在D:\log\dev中会生产我们的日志文件myLog.log，加入我们系统一直运行，则在我们的文件目录下会生成一个myLog.log文件和7个最近日志的文件myLog-某年-某月-某日.log。

代码示例

本文的相关代码已上传至github：

• Github：https://github.com/binzh303/spring-boot-route/

如果您觉得本文不错，欢迎 Star 支持！