springboot六：logback日志功能的实现

 在开发中，我们需要对一些信息进行日志记录，方便我们后期查找问题。springboot已经集合了一些日志的基本功能，所以我们也不需要额外增加新的依赖，我们启动的时候控制台都可以看到一堆日志文件。日志的常用级别是TRACE<DEBUG<INFO<WARN<ERROR。

接下来我们用一个测试类来测试Springboot的日志功能。

@ActiveProfiles("dev")
@SpringBootTest(classes = Application.class)
@RunWith(SpringRunner.class)
@Slf4j
public class LogTest {

    @Test
    public void logger(){
        log.debug("this is debug msg 1");
        log.info("this is info msg 1");
        log.warn("this is warn msg 1");
        log.error("this is error msg 1");
    }
}

 我们在控制台打印出来的结果是

Springboot默认的日志级别是info，即只会打印info及其级别以上的消息。

我们如果想要把日志记录到文件，就需要使用配置了。在resource目录下新建一个logback-spring.xml的文件（logback.xml也可以，不过带spring后缀我们可以使用springProfile这个节点）。

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

    <!--可以被调用的定义变量，用${}调用-->
    <property name="LOG_HOME" value="/logs"/>
    <property name="APP_NAME" value="spring-compete"/>

    <!-- appender是configuration的子节点，是负责写日志的组件。 -->
    <!-- ConsoleAppender：把日志输出到控制台 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--设置日志格式,%d时间，%thread线程，%-5level日志级别，%logger{50}日志所在的类，%msg日志信息，%n换行-->
            <pattern>
                %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
            </pattern>
        </encoder>
    </appender>

    <!--滚动记录文件 info级别-->
    <!-- RollingFileAppender：滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 -->
    <appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 日志记录器的滚动策略，按日期，按大小记录，会根据日期和大小生成1个或多个文件 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_HOME}/${APP_NAME}.%d{yyyy-MM-dd}.info.%i.log</fileNamePattern>
            <!-- 日志保留天数 -->
            <maxHistory>30</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy  class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:这是活动文件的大小，默认值是10MB，测试时可以改为10KB看看分割 -->
                <maxFileSize>1MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>
                %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
            </pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!--设置记录的日志级别-->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!--滚动记录文件 warn级别-->
    <appender name="WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_HOME}/${APP_NAME}.%d{yyyy-MM-dd}.warn.%i.log</fileNamePattern>
            <!-- 每产生一个日志文件，该日志文件的保存期限为30天 -->
            <maxHistory>30</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy  class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:这是活动文件的大小，默认值是10MB -->
                <maxFileSize>1MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>
                %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
            </pattern>
            <charset>UTF-8</charset>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>WARN</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!--滚动记录文件 error级别-->
    <appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_HOME}/${APP_NAME}.%d{yyyy-MM-dd}.error.%i.log</fileNamePattern>
            <!-- 每产生一个日志文件，该日志文件的保存期限为30天 -->
            <maxHistory>30</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy  class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- maxFileSize:这是活动文件的大小，默认值是10MB -->
                <maxFileSize>1MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>
                %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
            </pattern>
            <charset>UTF-8</charset>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <root level="INFO">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="INFO" />
        <appender-ref ref="WARN" />
        <appender-ref ref="ERROR" />
    </root>

    <!--springProfile用于切换环境-->
    <!--开发环境  -->
    <springProfile name="dev">
        <logger name="com.demo" level="debug" additivity="false">
            <appender-ref ref="CONSOLE" />
            <appender-ref ref="INFO" />
            <appender-ref ref="WARN" />
            <appender-ref ref="ERROR" />
        </logger>
    </springProfile>
</configuration>

启动测试类生产的文件，下面的测试的时候做了50kb分割，多次测试日志加起来大于50KB。

我们对不同环境的日志配置可能有不同的需求，我们可以对上面的做一下修改，首先在配置文件application-dev.yml增加配置

log:
  rootPath: /data/logs/compete

    <!--可以取到yml文件中的值-->
    <springProperty name="LOG_HOME" source="log.rootPath" scope="context"/>

    <!--springProfile用于切换环境-->
    <!--开发环境  -->
    <springProfile name="dev">
        <logger name="com.demo" level="debug" additivity="false">
            <appender-ref ref="CONSOLE" />
            <appender-ref ref="INFO" />
            <appender-ref ref="WARN" />
            <appender-ref ref="ERROR" />
        </logger>
        <!--root节点可以放在外面或者每个环境下面-->
        <root level="INFO">
            <appender-ref ref="CONSOLE" />
            <appender-ref ref="INFO" />
            <appender-ref ref="WARN" />
            <appender-ref ref="ERROR" />
        </root>
    </springProfile>

可以看到日志文件的位置已经换了，和配置结果里一样