SpringBoot日志配置

application.yaml配置方式

• 文件名与文件路径

logging.file.path	logging.file.name	示例	描述
无	无		只在控制台输出
无	配置文件名	my.log或/var/log/my.log	输出到特定的文件中
配置路径	无	/var/log	输出到文件夹中，文件名为spring.log

Logback独有的日志配置，无法在application.yaml中配置。这里只能配置一些基础内容。name与path不能同时使用，就算同时使用也只会有logging.file.path生效

• 其它文件属性配置参数

  • 日志文件的最大大小：默认为10M,可通过logging.file.max-size配置。

  • 日志文件存储的时间：默认存储最近7天，可通过logging.file.max-history配置。

  • 日志文档的总大小：当日志文档总大小超过该阈值会删除备份，可通过logging.file.total-size-cap。

  • 强制启动时清理日志：logging.file.clean-history-on-start。

  • 控制台日志输出过滤：logging.pattern.console。

  • 日志的日期格式：logging.pattern.dateformat

  • 过滤日志等级：logging.pattern.level

  • 日志滚动的名字：logging.pattern.rolling-file-name，默认的名字为${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz

• 日志的等级

  • 配置全局的日志等级：logging.level.root
  • 配置包的日志等级：logging.level.包名(eg:logging.level.org.hibernate）

• 日志分组

  • 解释：通过日志分组，可以同时修改多个包的日志输出等级
  • 分组：logging.group.分组名（eg : logging.group.tomcat=org.apache.catalina, org.apache.coyote, org.apache.tomcat）
  • 修改输出等级：logging.level.分组名（eg : logging.level.tomcat）

日志的xml配置方式

1. Spring Boot加载xml

• 修改配置，指定xml位置:logging.config可以配置加载xml路径

• 默认加载配置

日志系统	配置方式
Logback	logback-spring.xml, logback-spring.groovy, logback.xml, 或logback.groovy
Log4j2	log4j2-spring.xml 或 log4j2.xml
JDK (Java Util Logging)	logging.properties

2. Spring Boot中配置logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <substitutionProperty name="log.base" value="F:\\TestImage" />

    <!--控制台输出-->
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>%date [%thread][IP:%X{ip}|USER:%X{user}][%-5level %logger{80}] %msg%n</pattern>
        </encoder>
    </appender>

    <!--滚动日志：其中包括日志输出名字、滚动的规则-->
    <appender name="rollingFile" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.base}/stdout.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>${log.base}/stdout.%d{yyyy-MM-dd}.%i.log</FileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- or whenever the file size reaches 100MB -->
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>%date [%thread][IP:%X{ip}|USER:%X{user}][%-5level %logger{80}] %msg%n</pattern>
        </encoder>
    </appender>

    <!--异常日志输出：其中包括日志输出名、滚动规则-->
    <appender name="ExceptionLoggerFileOut" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.base}/exception.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>${log.base}/exception.%d{yyyy-MM-dd}.%i.log</FileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- or whenever the file size reaches 100MB -->
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>%date [%thread][IP:%X{ip}|USER:%X{user}][%-5level %logger{80}] %msg%n</pattern>
        </encoder>
    </appender>

    <logger name="com.shangde.common.sys.log.SysLogInterceptor" level="DEBUG" additivity="true" >
        <appender-ref ref="ExceptionLoggerFileOut" />
    </logger>

    <!--各个包的日志输出等级-->
    <logger name="com.cff" level="DEBUG" />
    <logger name="com" level="INFO" />
    <logger name="ch.qos.logback" level="INFO" />
    <logger name="org.mybatis" level="INFO" />
    <logger name="org" level="INFO" />
    <logger name="springfox" level="INFO" />

    <!--总的输出等级-->
    <root>
        <level value="DEBUG" />
        <appender-ref ref="stdout" />
        <appender-ref ref="rollingFile" />
    </root>
</configuration>

3. Spring Boot中配置log4j2-spring.xml

• 使用log4j2作为Spring Boot的日志系统，需要先将”Starts”中的Logback排除，增加Log4j2的Spring Boot包。日志接口仍然采用SLF4J！

<dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-web</artifactId>
           <exclusions>
               <exclusion>
                   <groupId>org.springframework.boot</groupId>
                   <artifactId>spring-boot-starter-logging</artifactId>
               </exclusion>
           </exclusions>
       </dependency>
  
       <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-log4j2</artifactId>
       </dependency>

• xml配置文件内容

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="OFF" monitorInterval="1800">
    <properties>
        <property name="LOG_HOME">D:/test</property>
        <property name="FILE_NAME">stdout</property>
    </properties>
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
        </Console>

        <RollingFile name="running-log" fileName="${LOG_HOME}/${FILE_NAME}.log"
            filePattern="${LOG_HOME}/$${date:yyyy-MM}/${FILE_NAME}-%d{yyyy-MM-dd}-%i.log.gz"
            immediateFlush="true">
            <PatternLayout
                pattern="%date{yyyy-MM-dd HH:mm:ss.SSS} %level [%thread][%file:%line] - %msg%n" />
            <Policies>
                <TimeBasedTriggeringPolicy />
                <SizeBasedTriggeringPolicy size="10 MB" />
            </Policies>
            <DefaultRolloverStrategy max="20" />
        </RollingFile>
    </Appenders>
    <Loggers>
        <Logger name="com.cff" level="debug" additivity="true">
            <AppenderRef ref="running-log" />
            <AppenderRef ref="Console" />
        </Logger>
        <Root level="info">
            <!-- 这里是输入到文件，很重要 -->
            <AppenderRef ref="running-log" />
            <!-- 这里是输入到控制台 -->
            <AppenderRef ref="Console" />
        </Root>
    </Loggers>
</Configuration>

4. 关于log4j的特殊说明

• log4j日志系统具有重大缺陷，因而建议将日志系统切换为log4j2或logback。
  Spring Boot日志文件系统的依赖关系

• Logback是”Start”中默认引入的日志系统

• Log4J2需要单独引入，引入时需要排除Logback

<dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-web</artifactId>
           <exclusions>
               <exclusion>
                   <groupId>org.springframework.boot</groupId>
                   <artifactId>spring-boot-starter-logging</artifactId>
               </exclusion>
           </exclusions>
       </dependency>
  
       <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-log4j2</artifactId>
       </dependency>

日志接口与日志实现对Spring Boot日志输出的影响

• 在Spring Boot中使用Commons Logging或SLF4J，那么实现可以随意使用Logback或Log4J,影响日志输出的将只与它们的配置方式有关。其中关于Log4J的使用可参考上文。关于Logback或Log4J对于Spring Boot日志输出的影响，可看下表：

日志系统	yaml配置	xml配置	解释与结论
Logback	不配置	log4j2-spring.xml	由于引入的Logback日志系统，配置将以YAML中的配置为准，即只输出到控制台
Logback	不配置	logback-spring.xml	由于引入Logback日志系统，配置将以logback.xml中的配置为准
Log4J	不配置	logback-spring.xml	由于引入的Log4J日志系统，配置将以YAML中的配置为准，即只输出到控制台
Log4J	不配置	log4j2-spring.xml	由于引入Log4J日志系统，配置将以log4j2.xml中的配置为准
Logback	配置xml文件为log4j2.xml	log4j2-spring.xml	将以yaml中配置的xml文件路径为准，日志输出以xml中内容为准
Log4J	配置xml文件为logback.xml	logback-spring.xml	将以yaml中配置的xml文件路径为准，日志输出以xml中内容为准

tips : 日志接口Commons Logging或SLF4J可以同时使用

• 在Spring Boot程序运行过程中，通过使用@log4j2、@log等这种具体的日志系统而不是日志系统接口

• 注：这种情况下，只要在maven中引入了对应的日志系统实现包就可以在Spring Boot中使用，并且任然可以打印到控制台，只是可能存在无法输出到文件中。具体原因是你Spring Boot使用的是Logback日志系统，你单独使用的是Log4j2，那么将无法输出到文件中。