Spring Boot与日志管理：你的日志，Spring Boot都能帮你搞定？

🏆本文收录于「滚雪球学SpringBoot」专栏，手把手带你零基础入门Spring Boot，从入门到就业，助你早日登顶实现财富自由🚀；同时，欢迎大家关注&&收藏&&订阅！持续更新中，up！up！up！！

环境说明：Windows 10 + IntelliJ IDEA 2021.3.2 + Jdk 1.8

前言

  在开发应用时，日志管理是不可忽视的环节。它帮助开发者监控应用运行状态、排查问题，并为系统运维提供支持。对于Spring Boot来说，日志管理不仅是一个基础功能，还是帮助你调试、维护系统的强大工具。📈

  在这篇文章中，我们将详细探讨Spring Boot的日志管理，包括默认日志框架、日志级别的配置、如何与其他日志框架集成、日志格式化以及文件管理等方面。确保你能在开发中轻松掌控日志的“魔法”。🧙‍♀️

一、日志框架的选择：Logback是默认的好伴侣 🛠️

  在Spring Boot中，Logback是默认的日志框架。为什么是Logback？它有什么优势？让我们详细分析一下。

Logback的优势：

1. 性能高效：Logback是继Log4j之后的新一代日志框架。相比Log4j，Logback提供了更高效的性能，尤其是在高并发环境下，能够处理更多的日志请求。
2. 灵活配置：Logback支持通过XML或Groovy配置文件进行灵活的日志设置。Spring Boot集成Logback后，你可以通过配置文件轻松修改日志的行为。
3. 与SLF4J兼容：SLF4J是一个统一的日志API，它与Logback的兼容性使得开发者能够更方便地切换不同的日志实现框架。

  Spring Boot默认集成了SLF4J和Logback，因此开发者可以通过SLF4J的API进行日志记录，而不需要关心具体的日志实现。

如何启用Logback

  如果你没有做任何特殊配置，Spring Boot会默认使用Logback。你可以开始直接记录日志，不需要任何额外设置。例如：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class MyService {
    private static final Logger logger = LoggerFactory.getLogger(MyService.class);

    public void performTask() {
        logger.info("Task started");
        try {
            // 模拟一些任务
            logger.debug("Processing task...");
            if (true) {
                throw new RuntimeException("Something went wrong");
            }
        } catch (Exception e) {
            logger.error("Error occurred: {}", e.getMessage());
        }
        logger.info("Task finished");
    }
}

  在这个例子中，使用了SLF4J的Logger进行日志记录，通过不同级别（INFO、DEBUG、ERROR）的日志消息记录了程序的执行流程。

二、配置日志级别和日志文件：更精准的日志管理 🎯

  Spring Boot允许你通过配置文件轻松管理日志的级别、输出位置和格式。你可以根据不同的场景需求，调整日志记录的详细程度和存储方式。

1. 配置日志级别

  日志级别控制着应用输出日志的详细程度，常见的日志级别包括：

• TRACE：最详细的日志级别，适用于非常细粒度的调试。
• DEBUG：调试级别，通常用于开发过程中输出调试信息。
• INFO：普通信息日志，记录正常业务操作。
• WARN：警告日志，记录一些可能不正常但不会导致系统崩溃的情况。
• ERROR：错误日志，记录严重错误，通常伴随堆栈跟踪。

  Spring Boot支持在application.properties或application.yml中配置日志级别。默认情况下，Spring Boot的日志级别为INFO，即只输出INFO及以上级别的日志。

在application.properties中配置日志级别：

# 设置全局日志级别
logging.level.root=INFO

# 设置特定包的日志级别
logging.level.org.springframework.web=DEBUG
logging.level.com.example.demo=DEBUG

  上面的配置表示，所有日志级别为INFO及以上的日志都会输出，而org.springframework.web和com.example.demo包的日志则会以DEBUG级别输出，记录更多的细节。

在application.yml中配置日志级别：

logging:
  level:
    root: INFO
    org.springframework.web: DEBUG
    com.example.demo: DEBUG

2. 配置日志文件

  除了控制日志的输出级别，Spring Boot还允许你配置日志输出到文件。你可以指定日志文件的路径、文件名，甚至控制日志文件的大小、备份数量等。

在application.properties中配置日志文件：

# 指定日志文件名
logging.file.name=application.log

# 指定日志文件的保存路径
logging.file.path=/var/logs/myapp

# 控制日志文件大小，达到一定大小后进行文件滚动
logging.file.max-size=10MB

# 设置最大备份文件数
logging.file.max-history=30

  这段配置会把日志保存到/var/logs/myapp/application.log文件，并且当日志文件大小超过10MB时会进行滚动，最多保留30个备份文件。

配置日志文件的格式

  你还可以定制日志文件的输出格式，让日志更具可读性。例如，记录日志的时间、级别、类名等信息。

  在application.properties中，可以配置如下内容：

# 控制日志输出格式
logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss} - %msg%n
logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss} - %msg%n

  这段配置表示，控制台和日志文件的输出格式包括日期时间（%d）和日志消息（%msg），每条日志以换行符（%n）结尾。

三、集成SLF4J与Log4j2：让日志更炫！ 💥

  虽然Spring Boot默认使用Logback，但它也支持集成其他日志框架，如SLF4J和Log4j2。这意味着你可以轻松切换日志框架，以满足不同的需求。

1. 集成SLF4J

  SLF4J（Simple Logging Facade for Java）是一个为Java日志系统提供统一API的框架，它本身不提供具体的日志实现，而是为不同的日志框架提供一个通用接口。在Spring Boot中，SLF4J是默认的日志API。

  你可以通过SLF4J的Logger类记录日志，示例如下：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class MyService {
    private static final Logger logger = LoggerFactory.getLogger(MyService.class);

    public void executeTask() {
        logger.info("Task is starting...");
        try {
            // 模拟业务逻辑
            logger.debug("Processing data...");
            // 如果有错误
            throw new RuntimeException("Unexpected error!");
        } catch (Exception e) {
            logger.error("Error occurred: {}", e.getMessage());
        }
    }
}

  在这个例子中，LoggerFactory.getLogger()用于获取Logger对象，然后通过不同的日志级别（INFO、DEBUG、ERROR）记录日志信息。

2. 集成Log4j2

  如果你更喜欢使用Log4j2，可以轻松替换Spring Boot默认的Logback。首先，你需要添加Log4j2的依赖：

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

  接下来，创建一个log4j2.xml配置文件（通常位于src/main/resources目录下），配置文件内容如下：

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

  这段配置定义了日志输出到控制台和文件，并指定了输出的格式。日志级别默认为INFO，意味着日志记录将包含INFO及以上级别的日志。

3. 关闭默认日志

  如果你不希望使用Spring Boot默认的Logback，而是完全使用Log4j2，你可以在application.properties中关闭Logback：

logging.level.root=OFF

四、日志格式化与日志文件管理：日志的高级玩法 🔥

1. 格式化日志

  你可以通过格式化日志输出，确保每条日志包含必要的上下文信息，方便排查问题。在Spring Boot中，格式化日志可以通过自定义PatternLayout来完成。

  例如，你可以在log4j2.xml中设置如下日志格式：

<PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} [%t] %-5level %logger{36} - %msg%n"/>

  这个格式化设置将输出：

• 时间（%d）：记录日志的日期时间。
• 线程（%t）：记录当前日志输出所在的线程。
• 日志级别（%-5level）：日志级别，如INFO、ERROR等。
• 类名（%logger{36}）：记录日志输出所在的类。
• 日志消息（%msg）：实际的日志消息内容。

2. 文件滚动与归档

  在高负载应用中，日志文件大小可能会迅速增加，这时需要定期进行日志滚动。Spring Boot和Log4j2都支持通过文件滚动策略来管理日志文件。

  例如，在Log4j2中，你可以使用如下配置来设置日志滚动策略：

<Appender name="RollingFile" class="org.apache.logging.log4j.core.appender.RollingFileAppender">
    <FileName>logs/myapp.log</FileName>
    <RollingPolicy>
        <SizeBasedTriggeringPolicy size="10MB"/>
    </RollingPolicy>
    <Layout>
        <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} - %msg%n"/>
    </Layout>
</Appender>

  这段配置表示，当日志文件大小超过10MB时，Log4j2会自动滚动日志文件，确保日志文件不会过大。

五、总结：日志管理，轻松搞定！ 🏆

  日志管理不仅仅是为了调试，它是运维和开发中不可或缺的工具。Spring Boot提供了一个简洁且强大的日志管理系统，支持Logback、SLF4J、Log4j2等多个日志框架的集成。通过灵活配置，你可以精确控制日志级别、日志输出格式和文件滚动策略，从而实现更高效、更稳定的日志管理。

  掌握Spring Boot的日志管理，不仅让你在开发过程中更加得心应手，还能帮助你更快地定位问题，提高系统的可维护性和健壮性。📊

  是不是觉得日志管理也能像一个得力助手一样，帮你管理应用的健康和状态？那就赶快动手配置吧！🎉

🧧福利赠与你🧧

  无论你是计算机专业的学生，还是对编程有兴趣的小伙伴，都建议直接毫无顾忌的学习此专栏「滚雪球学SpringBoot」，bug菌郑重承诺，凡是学习此专栏的同学，均能获取到所需的知识和技能，全网最快速入门SpringBoot，就像滚雪球一样，越滚越大， 无边无际，指数级提升。

  最后，如果这篇文章对你有所帮助，帮忙给作者来个一键三连，关注、点赞、收藏，您的支持就是我坚持写作最大的动力。

  同时欢迎大家关注公众号:「猿圈奇妙屋」 ，以便学习更多同类型的技术文章，免费白嫖最新BAT互联网公司面试题、4000G pdf电子书籍、简历模板、技术文章Markdown文档等海量资料。

✨️ Who am I?

我是bug菌，CSDN | 掘金 | InfoQ | 51CTO | 华为云 | 阿里云 | 腾讯云 等社区博客专家，C站博客之星Top30，华为云多年度十佳博主/价值贡献奖，掘金多年度人气作者Top40，掘金等各大社区平台签约作者，51CTO年度博主Top12，掘金/InfoQ/51CTO等社区优质创作者；全网粉丝合计 30w+；更多精彩福利点击这里；硬核微信公众号「猿圈奇妙屋」，欢迎你的加入！免费白嫖最新BAT互联网公司面试真题、4000G PDF电子书籍、简历模板等海量资料，你想要的我都有，关键是你不来拿。

-End-