Spring Boot 指定日志配置文件

本文导读

• 本文承接《Spring 日志关系 与 slf4j 默认配置及其修改》
• 已经知道可以在 Spring Boot 的全局配置文件 application.properties 或者 application.yml 中修改 slf4j 的默认配置，那么能不能直接使用slf4j实现框架的自己的配置文件呢？显然是可以的
• 方式很简单：直接在类路径下放置slf4j的实现日志框架自己的配置文件即可，这样 Spring Boot 就不使用自己的默认配置了
• 官网参考链接，根据日志记录系统，加载以下文件：

Logging System	Customization
Logback	logback-spring.xml , logback-spring.groovy , logback.xml or logback.groovy
Log4j2	log4j2-spring.xml or log4j2.xml
JDK (Java Util Logging)	logging.properties

指定日志配置

logback. xml

• 现在以 logback 的 logback.xml 为例，将配置为文件放入到类路径下去。对于其它的日志框架实现也是同理

<?xml version="1.0" encoding="UTF-8"?>
<!--
    scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
    scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒；当scan为true时，此属性生效。默认的时间间隔为1分钟。
    debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false">
    <!-- 定义日志的根目录 -->
    <property name="LOG_HOME" value="logs"/>
    <!-- 定义日志文件名称 -->
    <property name="appName" value="coco"></property>
    <!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 -->
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <!--
        日志输出格式：
			%d表示日期时间，
			%thread表示线程名，
			%-5level：级别从左显示5个字符宽度
			%logger{50} 表示logger名字最长50个字符，否则按照句点分割。 
			%msg：日志消息，
			%n是换行符
        -->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==> [%thread] ==> %-5level %logger{50} - %msg%n</pattern>
        </layout>
    </appender>

    <!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 -->
    <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 指定日志文件的名称 -->
        <file>${LOG_HOME}/${appName}.log</file>
        <!--
        当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名
        TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。
        -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--
            滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}：按天进行日志滚动 
            %i：当文件大小超过maxFileSize时，按照i进行文件滚动
            -->
            <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!-- 
            可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每天滚动，
            且maxHistory是365，则只保存最近365天的文件，删除之前的旧文件。注意，删除旧文件是，
            那些为了归档而创建的目录也会被删除。
            -->
            <MaxHistory>365</MaxHistory>
            <!-- 
            当日志文件超过maxFileSize指定的大小时，根据上面提到的%i进行日志文件滚动
            注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的，必须配置timeBasedFileNamingAndTriggeringPolicy
            -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 日志输出格式： -->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
        </layout>
    </appender>

    <!-- 
		logger主要用于存放日志对象，也可以定义日志类型、级别
		name：表示匹配的logger类型前缀，也就是包的前半部分
		level：要记录的日志级别，包括 TRACE < DEBUG < INFO < WARN < ERROR
		additivity：作用在于children-logger是否使用 rootLogger配置的appender进行输出，
		false：表示只用当前logger的appender-ref，true：
		表示当前logger的appender-ref和rootLogger的appender-ref都有效
    -->
    <!-- app logger -->
    <logger name="com.atguigu" level="debug"/>
    <!-- Spring framework logger -->
    <logger name="org.springframework" level="debug" additivity="false"></logger>

    <!--
    root与logger是父子关系，没有特别定义则默认为root，任何一个类只会和一个logger对应，
    要么是定义的logger，要么是root，判断的关键在于找到这个logger，然后判断这个logger的appender和level。 
    -->
    <root level="info">
        <appender-ref ref="stdout"/>
        <appender-ref ref="appLogAppender"/>
    </root>
</configuration> 

测试运行

package com.lct;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import java.util.Date;

@RunWith(SpringRunner.class)
@SpringBootTest
public class CocoApplicationTests {
    /**
     * 获取日志记录器
     */
    private static Logger logger = LoggerFactory.getLogger(CocoApplicationTests.class);

    @Test
    public void contextLoads() {
        System.out.println(new Date());
        /**
         * 日志的级别 由低到高 trace(跟踪) < debug(调试) < info(信息) < warn(警告) < error(错误)
         * 可以在配置文件中调整输出的日志级别,日志就只会在这个级别及以后的高级别生效
         * Spring Boot 默认使用info级别
         */
        logger.trace("这是 trace 日志...");
        logger.debug("这是 debug 日志...");
        logger.info("这是 info 日志...");
        logger.warn("这是 warn 日志...");
        logger.error("这是 error 日志...");
    }
}

• 控制台输出：

2018-07-14 16:11:45.405 ==> [main] ==> INFO  com.lct.CocoApplicationTests - No active profile set, falling back to default profiles: default
2018-07-14 16:11:48.144 ==> [main] ==> INFO  com.lct.CocoApplicationTests - Started CocoApplicationTests in 3.257 seconds (JVM running for 4.565)
Sat Jul 14 16:11:48 CST 2018
2018-07-14 16:11:48.308 ==> [main] ==> INFO  com.lct.CocoApplicationTests - 这是 info 日志...
2018-07-14 16:11:48.309 ==> [main] ==> WARN  com.lct.CocoApplicationTests - 这是 warn 日志...
2018-07-14 16:11:48.309 ==> [main] ==> ERROR com.lct.CocoApplicationTests - 这是 error 日志...

Process finished with exit code 0

Profile 高级功能

• Spring Boot 官方建议使用 logback-spring.xml 
• logback.xml：应用启动时会直接被日志框架logback识别而被使用，不经过Spring Boot
• logback-spring.xml：logback日志框架就不能直接识别到，而会由 Spring Boot 解析此日志配置文件，从而可以使用Spring Boot 的 Profile 高级功能，即文档块功能，可以参考《Profiles 多环境配置》

• 改了名字之后，logback 框架就识别不到了，Spring Boot 就会解析使用它，同时也可以使用Spring Boot 的Prifile功能

        <!--
        日志输出格式：
			%d表示日期时间，
			%thread表示线程名，
			%-5level：级别从左显示5个字符宽度
			%logger{50} 表示logger名字最长50个字符，否则按照句点分割。 
			%msg：日志消息，
			%n是换行符
        -->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <!-- 当指定 spring.profiles.active=dev 时，采用第一种格式
            <springProfileb 标签的包含的范围可大可小，自己确定即可
            否则采用第二种格式-->
            <springProfile name="dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n</pattern>
            </springProfile>
            <springProfile name="!dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n</pattern>
            </springProfile>
        </layout>
    </appender>

• 此时控制台输出格式为：

2018-07-14 16:22:54.903 ----> [main] ---> INFO  com.lct.CocoApplicationTests - Starting CocoApplicationTests on SC-201707281232 with PID 10640 (started by Administrator in E:\IdeaProjects\coco)
2018-07-14 16:22:54.905 ----> [main] ---> INFO  com.lct.CocoApplicationTests - The following profiles are active: dev
2018-07-14 16:22:56.816 ----> [main] ---> INFO  com.lct.CocoApplicationTests - Started CocoApplicationTests in 2.52 seconds (JVM running for 3.85)
Sat Jul 14 16:22:56 CST 2018
2018-07-14 16:22:56.964 ----> [main] ---> INFO  com.lct.CocoApplicationTests - 这是 info 日志...
2018-07-14 16:22:56.965 ----> [main] ---> WARN  com.lct.CocoApplicationTests - 这是 warn 日志...
2018-07-14 16:22:56.966 ----> [main] ---> ERROR com.lct.CocoApplicationTests - 这是 error 日志...

Process finished with exit code 0