Spring Boot日志控制详解

简介

在应用程序中，日志是非常重要的组成部分。通过日志，我们可以了解应用程序中所发生的事件及其执行状态。Spring Boot提供了非常方便的日志控制功能，使得应用程序中的日志记录变得更加简单、可读且易于管理。

Spring Boot默认日志记录器

Spring Boot默认使用的是Logback日志框架，它拥有极高的性能和可靠性，并且支持多种输出格式和输出目标。

在默认情况下，所有Spring自己的日志都输出到控制台，且日志级别为INFO。同时，所有的“ERROR”级别的日志都会被记录到一个名为“spring-boot-logs”文件中。这种默认的行为可以通过以下属性来修改：

# 修改日志级别
logging.level.root=WARN

# 修改日志输出位置和文件名
logging.file.name=myapp.log
logging.path=/var/log/myapp

在以上配置中，我们配置了根日志记录器的级别为WARN级别，同时将日志输出到/var/log/myapp目录下的名为“myapp.log”的文件中。

自定义日志记录器

在Spring Boot中，根据具体需求，可以很容易地添加自定义的日志记录器。以下是一个最简单的日志记录器的配置：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

@Component
public class MyLogger {

    private static final Logger logger = LoggerFactory.getLogger(MyLogger.class);

    public void logSomething() {
        logger.info("this is my log");
    }
}

在上面的示例中，我们使用Spring Boot提供的LoggerFactory创建了一个Logger对象，并使用@Component注解声明了它是一个组件，在其他类中可以通过@Autowired将其注入到需要的位置中。在MyLogger类中，我们编写了一个打印日志的方法logSomething()，输出了一行日志。

使用Log4j2作为日志框架

除了默认的Logback之外，Spring Boot还支持其他日志框架，例如Log4j2等。以下是一个配置示例：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="INFO">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n" />
        </Console>
    </Appenders>
    <Loggers>
        <Root level="INFO">
            <AppenderRef ref="Console" />
        </Root>
    </Loggers>
</Configuration>

在以上配置中，我们指定了日志输出的目标为控制台，同时配置了输出格式。注意，在使用Log4j2作为日志框架时，需要在项目的classpath中添加log4j2.xml文件，并在pom.xml中引入相关依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

小结

本文介绍了Spring Boot的日志控制功能，包括默认的日志记录器、自定义日志记录器和使用Log4j2作为日志框架的配置方法。通过学习本文，读者可以更好地了解Spring Boot的日志记录特性，提高应用程序的可读性和管理性。

示例1： Logback输出到文件

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <appender name="fileAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>/var/log/myapp.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>/var/log/myapp.%d{yyyy-MM-dd}.log</fileNamePattern>
        </rollingPolicy>
        <encoder>
            <pattern>%d %p [%c] - %m%n</pattern>
        </encoder>
    </appender>

    <root level="INFO">
        <appender-ref ref="fileAppender" />
    </root>
</configuration>

在以上的示例中，我们将日志输出到/var/log/myapp.log文件中，并使用TimeBasedRollingPolicy配置了日志的滚动，即按天输出到特定的文件中。同时，在输出格式中输出了时间、日志级别、源类和日志内容四个信息。

示例2：使用Log4j2作为日志框架

以下是一个简单的Log4j2配置，将日志输出到控制台：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="OFF">
    <Appenders>
        <Console name="console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %highlight{[%-5level]} %cyan{%-10logger{36}} - %msg%n" />
        </Console>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="console" />
        </Root>
    </Loggers>
</Configuration>

在以上示例中，我们定义了一个名为console的Appender，将日志输出到控制台。在输出格式中使用了highlight和cyan两个颜色工具类，改变了日志级别和源类的颜色，增加了可读性。并使用status="OFF"关闭了Log4j2中默认输出的debug信息。