Spring Boot 日志框架实践

V2EX = way to explore

V2EX 是一个关于分享和探索的地方

现在注册

已注册用户请登录

这是一个创建于 2431 天前的主题，其中的信息可能已经有所发展或是发生改变。

CASIO G-SHOCK

概述

Java 应用中，日志一般分为以下 5 个级别：

ERROR 错误信息
WARN 警告信息
INFO 一般信息
DEBUG 调试信息
TRACE 跟踪信息

Spring Boot 使用 Apache 的 Commons Logging 作为内部的日志框架，其仅仅是一个日志接口，在实际应用中需要为该接口来指定相应的日志实现。

SpringBt 默认的日志实现是 Java Util Logging，是 JDK 自带的日志包，此外 SpringBt 当然也支持 Log4J、Logback 这类很流行的日志实现。

统一将上面这些日志实现统称为日志框架

下面我们来实践一下！

使用 Spring Boot Logging 插件

首先 application.properties 文件中加配置：

logging.level.root=INFO

控制器部分代码如下：

package com.hansonwang99.controller;

import com.hansonwang99.K8sresctrlApplication;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/testlogging")
public class LoggingTestController {
    private static Logger logger = LoggerFactory.getLogger(K8sresctrlApplication.class);
    @GetMapping("/hello")
    public String hello() {
        logger.info("test logging...");
        return "hello";
    }
}

运行结果

运行结果

由于将日志等级设置为 INFO，因此包含 INFO 及以上级别的日志信息都会打印出来

这里可以看出，很多大部分的 INFO 日志均来自于 SpringBt 框架本身，如果我们想屏蔽它们，可以将日志级别统一先全部设置为 ERROR，这样框架自身的 INFO 信息不会被打印。然后再将应用中特定的包设置为 DEBUG 级别的日志，这样就可以只看到所关心的包中的 DEBUG 及以上级别的日志了。

控制特定包的日志级别

application.yml 中改配置

logging:
  level:
    root: error
    com.hansonwang99.controller: debug

很明显，将 root 日志级别设置为 ERROR，然后再将com.hansonwang99.controller包的日志级别设为 DEBUG，此即：即先禁止所有再允许个别的设置方法

控制器代码

package com.hansonwang99.controller;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/testlogging")
public class LoggingTestController {
    private Logger logger = LoggerFactory.getLogger(this.getClass());
    @GetMapping("/hello")
    public String hello() {
        logger.info("test logging...");
        return "hello";
    }
}

运行结果

运行结果

可见框架自身的 INFO 级别日志全部藏匿，而指定包中的日志按级别顺利地打印出来

将日志输出到某个文件中

logging:
  level:
    root: error
    com.hansonwang99.controller: debug
  file: ${user.home}/logs/hello.log

运行结果

运行结果

使用 Spring Boot Logging，我们发现虽然日志已输出到文件中，但控制台中依然会打印一份，发现用org.slf4j.Logger是无法解决这个问题的

v 运行结果

集成 Log4J 日志框架

pom.xml 中添加依赖

       <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>

在 resources 目录下添加log4j2.xml文件，内容如下：

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

    <appenders>
        <File name="file" fileName="${sys:user.home}/logs/hello2.log">
            <PatternLayout pattern="%d{HH:mm:ss,SSS} %p %c (%L) - %m%n"/>
        </File>
    </appenders>

    <loggers>

        <root level="ERROR">
            <appender-ref ref="file"/>
        </root>
        <logger name="com.hansonwang99.controller" level="DEBUG" />
    </loggers>

</configuration>

其他代码都保持不变

运行程序发现控制台没有日志输出，而 hello2.log 文件中有内容，这符合我们的预期：

运行结果

而且日志格式和pattern="%d{HH:mm:ss,SSS} %p %c (%L) - %m%n"格式中定义的相匹配

Log4J 更进一步实践

pom.xml 配置：

		<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>

log4j2.xml 配置

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

        <Property name="app_name">springboot-web</Property>
        <Property name="log_path">logs/${app_name}</Property>

    </properties>
    <appenders>
        <console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="[%d][%t][%p][%l] %m%n" />
        </console>

        <RollingFile name="RollingFileInfo" fileName="${log_path}/info.log"
                     filePattern="${log_path}/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log.gz">
            <Filters>
                <ThresholdFilter level="INFO" />
                <ThresholdFilter level="WARN" onMatch="DENY"
                                 onMismatch="NEUTRAL" />
            </Filters>
            <PatternLayout pattern="[%d][%t][%p][%c:%L] %m%n" />
            <Policies>
                <!-- 归档每天的文件 -->
                <TimeBasedTriggeringPolicy interval="1" modulate="true" />
                <!-- 限制单个文件大小 -->
                <SizeBasedTriggeringPolicy size="2 MB" />
            </Policies>
            <!-- 限制每天文件个数 -->
            <DefaultRolloverStrategy compressionLevel="0" max="10"/>
        </RollingFile>

        <RollingFile name="RollingFileWarn" fileName="${log_path}/warn.log"
                     filePattern="${log_path}/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log.gz">
            <Filters>
                <ThresholdFilter level="WARN" />
                <ThresholdFilter level="ERROR" onMatch="DENY"
                                 onMismatch="NEUTRAL" />
            </Filters>
            <PatternLayout pattern="[%d][%t][%p][%c:%L] %m%n" />
            <Policies>
                <!-- 归档每天的文件 -->
                <TimeBasedTriggeringPolicy interval="1" modulate="true" />
                <!-- 限制单个文件大小 -->
                <SizeBasedTriggeringPolicy size="2 MB" />
            </Policies>
            <!-- 限制每天文件个数 -->
            <DefaultRolloverStrategy compressionLevel="0" max="10"/>
        </RollingFile>

        <RollingFile name="RollingFileError" fileName="${log_path}/error.log"
                     filePattern="${log_path}/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log.gz">
            <ThresholdFilter level="ERROR" />
            <PatternLayout pattern="[%d][%t][%p][%c:%L] %m%n" />
            <Policies>
                <!-- 归档每天的文件 -->
                <TimeBasedTriggeringPolicy interval="1" modulate="true" />
                <!-- 限制单个文件大小 -->
                <SizeBasedTriggeringPolicy size="2 MB" />
            </Policies>
            <!-- 限制每天文件个数 -->
            <DefaultRolloverStrategy compressionLevel="0" max="10"/>
        </RollingFile>

    </appenders>

    <loggers>


        <root level="info">
            <appender-ref ref="Console" />
            <appender-ref ref="RollingFileInfo" />
            <appender-ref ref="RollingFileWarn" />
            <appender-ref ref="RollingFileError" />
        </root>

    </loggers>

</configuration>

控制器代码：

package com.hansonwang99.controller;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/testlogging")
public class LoggingTestController {
    private final Logger logger = LogManager.getLogger(this.getClass());
    @GetMapping("/hello")
    public String hello() {
        for(int i=0;i<10_0000;i++){
            logger.info("info execute index method");
            logger.warn("warn execute index method");
            logger.error("error execute index method");
        }
        return "My First SpringBoot Application";
    }
}

运行结果

运行结果

日志会根据不同的级别存储在不同的文件，当日志文件大小超过 2M 以后会分多个文件压缩存储，生产环境的日志文件大小建议调整为 20-50MB。

后记

作者更多的 SpringBt 实践文章在此：

作者更多的原创文章在此

CodeSheep

日志

import

artifactid

logger

17 条回复 • 2018-07-11 18:52:46 +08:00

mineqiqi

2018-03-29 09:12:17 +08:00

mark 看下，谢谢楼主

FenGuWu

2018-03-29 09:20:36 +08:00 via Android

mark2

guojxx

2018-03-29 09:26:46 +08:00

mark3

mynameisny

2018-03-29 09:27:33 +08:00

呃……那个表……那个 G Shock ……有链接嘛

starmoon1994

2018-03-29 09:55:39 +08:00

兄弟这文章 csdn 上一搜一大堆啊

xcc880

2018-03-29 09:58:17 +08:00

@mynameisny 角度刁钻

danielmiao

2018-03-29 10:21:59 +08:00

有这么复杂？？
Spring Boot 的默认日志是 SLF4j+Logback
所以只需要配置 logback 就可以了
* application.properties

>logging.config=classpath:logback.xml

* logback.xml

```xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
<property name="LOG_HOME" value="${log.dir:-logs}/"/>
<property name="ENCODER_PATTERN"
value="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%10.10thread] %logger{20} - %msg%n"/>
<contextName>${APP_NAME}</contextName>

<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<Pattern>${ENCODER_PATTERN}</Pattern>
</encoder>
</appender>

<appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_HOME}/info.%d{yyyy-MM-dd}.log</fileNamePattern>
<maxHistory>30</maxHistory>
</rollingPolicy>
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>${ENCODER_PATTERN}</pattern>
</encoder>
</appender>

<root>
<level value="INFO"/>

<appender-ref ref="INFO"/>
</root>
</configuration>
```

hansonwang99

2018-03-29 10:26:43 +08:00

@danielmiao 大佬勿喷，向大佬致敬，学习了

nita22

2018-03-29 10:34:38 +08:00

支持支持

ixx

2018-03-29 10:38:51 +08:00

默认可以在 application.yml 里配置 log 的级别及输出目录很方便，如果有特殊需求（比如按级别输出指定文件）可以加一个 logback.xml 但加了 logback.xml 后原 application.yml 的配置将失效

wulaoban666

2018-03-29 10:57:17 +08:00

作为一名新人，表示看的有点吃力

canbingzt

2018-03-29 11:21:09 +08:00

Spring Boot 默认是 logback 组件，需要关闭控制台的话这样就可以
application.properties

logging.config=classpath:logback.xml

logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<include resource="org/springframework/boot/logging/logback/base.xml"/>

<property name="root.level.console" value="OFF"/>
</configuration>