Spring Boot 日志打印配置详解

日志是软件系统运行过程中重要的调试工具之一，在 Spring Boot 中，日志的配置和管理相对简便且灵活。本文将详细介绍如何在 Spring Boot 项目中进行日志配置。

1. Spring Boot 日志框架概述

Spring Boot 内置了多种日志框架的支持，默认使用的是 SLF4J（Simple Logging Facade for Java）结合 Logback 作为日志实现。SLF4J 是一个日志的抽象层，它使得开发人员可以选择不同的日志实现，而 Logback 是一个非常高效的日志实现。Spring Boot 也支持其他常见的日志框架，如 Log4j2、Java Util Logging (JUL) 等。

默认情况下，Spring Boot 项目会在控制台输出日志，开发者可以通过修改配置文件进行自定义设置，例如将日志输出到文件、调整日志级别等。

---

2. 日志级别及配置

2.1 日志级别

Spring Boot 支持以下常见的日志级别，按优先级由高到低排列：

• ERROR: 严重错误，一般需要立即修复的问题。
• WARN: 警告，可能导致问题的事件。
• INFO: 系统运行中的重要信息，通常是系统状态变化的信息。
• DEBUG: 详细的调试信息，用于开发和诊断。
• TRACE: 更加细粒度的调试信息，比 DEBUG 更加详细。

每个日志级别会包含优先级比它高的日志。例如，如果将日志级别设为 WARN，则会打印 WARN 和 ERROR 级别的日志。

2.2 日志级别配置

我们可以在 application.properties 或 application.yml 中配置日志级别。以下是配置日志级别的示例：

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

# 设置特定包的日志级别为DEBUG
logging.level.com.example.orderservice=DEBUG

如果你使用 YAML 格式，可以这样配置：

logging:
  level:
    root: INFO
    com.example.orderservice: DEBUG

---

3. 日志文件输出与滚动配置

在生产环境中，将日志输出到文件中是很常见的做法。Spring Boot 提供了非常灵活的日志文件配置选项，包括配置日志文件的路径、日志文件的滚动策略等。

3.1 日志文件输出

要将日志输出到文件，只需在配置文件中设置 logging.file.name 或 logging.file.path 参数：

# 将日志输出到指定的文件
logging.file.name=logs/app.log

或者只指定日志目录，Spring Boot 会自动生成文件：

# 将日志输出到指定目录
logging.file.path=logs

3.2 日志文件滚动

日志文件滚动是指当日志文件达到指定大小或时间时，系统会将旧日志文件重命名归档并生成新的日志文件。这可以防止日志文件过大影响系统性能。Logback 允许通过配置文件定义滚动策略。

下面是一个简单的 Logback 配置示例 (logback-spring.xml)，可以用来实现日志文件的大小滚动：

<configuration>
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>logs/app.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <maxFileSize>10MB</maxFileSize>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

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

该配置表示当日志文件达到 10MB 时，系统会生成新的日志文件，并保留旧日志文件。

---

4. 电商交易系统中的应用示例

在电商交易系统中，日志记录可以帮助我们追踪订单处理流程、支付状态、库存更新等重要操作的执行情况。假设我们有一个订单服务，它负责处理订单的创建和更新操作。在这些关键步骤中，我们需要记录操作的开始、结束，以及可能出现的错误。

4.1 实现指定类的日志打印

在实际开发中，我们可能只想对某些关键类或包进行日志记录，以避免生成大量无关的日志，影响调试效率。通过 Spring Boot 的日志配置，可以为特定的类或包设置不同的日志级别。

示例：我们希望为 com.example.orderservice 包下的所有类设置 DEBUG 级别的日志，以便详细记录订单处理过程。

在 application.properties 中，可以这样配置：

# 为指定包设置 DEBUG 日志级别
logging.level.com.example.orderservice=DEBUG

或者在 application.yml 中：

logging:
  level:
    com.example.orderservice: DEBUG

这种配置方式非常灵活，适用于我们只想调试特定模块的场景。对于电商系统中的订单处理模块，我们可以通过这种方式为其开启详细日志。

4.2 实现指定类不打印日志

如果我们希望忽略某些类或包的日志输出，比如不希望记录某些第三方库的日志，可以将其日志级别设置为 OFF。例如，如果我们不希望 com.example.paymentservice 包下的类输出任何日志，可以这样配置：

# 禁止指定包的日志输出
logging.level.com.example.paymentservice=OFF

在 application.yml 中同样可以通过这种方式实现：

logging:
  level:
    com.example.paymentservice: OFF

这种配置方式通常适用于那些日志冗余且不影响系统运行的类或包，能够有效减少日志量。

4.3 打印 MyBatis 的 SQL 日志

在电商系统中，订单处理、库存更新等业务场景常常会涉及到数据库操作，而记录 SQL 日志对于调试这些操作至关重要。Spring Boot 集成了 MyBatis，通过配置可以很方便地启用 SQL 日志输出。

要启用 MyBatis 的 SQL 日志，只需在 application.properties 或 application.yml 中为 MyBatis 的日志组件（通常是 org.mybatis）设置日志级别：

# 启用 MyBatis 的 SQL 日志
logging.level.org.mybatis=DEBUG
logging.level.jdbc.sql=DEBUG

或者在 application.yml 中：

logging:
  level:
    org.mybatis: DEBUG
    jdbc.sql: DEBUG

这将会在日志中输出所有执行的 SQL 语句及其参数，这对于我们在调试时查看数据库交互过程非常有用。

4.4 关闭 MyBatis 的 SQL 日志

如果我们不希望打印 MyBatis 的 SQL 日志（例如在生产环境中，为了减少日志量），可以将其日志级别设置为 OFF：

# 关闭 MyBatis 的 SQL 日志
logging.level.org.mybatis=OFF
logging.level.jdbc.sql=OFF

或者：

logging:
  level:
    org.mybatis: OFF
    jdbc.sql: OFF

通过这种方式，我们可以根据环境需求灵活调整日志输出。在开发环境中开启 SQL 日志，在生产环境中关闭，这可以有效减少不必要的日志信息。

---

4.5 电商交易系统日志配置的完整示例

以下是一个完整的日志配置示例，它展示了如何为特定类启用/禁用日志、如何打印 MyBatis 的 SQL 日志以及关闭日志输出：

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

# 为订单服务启用 DEBUG 级别日志
logging.level.com.example.orderservice=DEBUG

# 禁止支付服务的日志输出
logging.level.com.example.paymentservice=OFF

# 启用 MyBatis 的 SQL 日志
logging.level.org.mybatis=DEBUG
logging.level.jdbc.sql=DEBUG

这个配置能够有效管理电商系统中的日志输出，帮助开发者集中精力调试核心业务模块，同时避免日志冗余。

4.6 记录日志案例示范

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/orders")
public class OrderController {

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

    @PostMapping("/create")
    public String createOrder(@RequestBody Order order) {
        logger.info("Creating order with ID: {}", order.getId());
        
        // 模拟订单处理逻辑
        try {
            // 订单处理成功
            logger.info("Order created successfully: {}", order.getId());
            return "Order created";
        } catch (Exception e) {
            // 订单处理失败
            logger.error("Failed to create order: {}", order.getId(), e);
            return "Order creation failed";
        }
    }
}

在这个示例中，我们使用了 SLF4J 的 Logger 来记录订单的创建过程。在关键步骤中记录了信息级别的日志（INFO），而在发生异常时记录了错误级别的日志（ERROR）。

---

5. 常见日志问题及解决方案

5.1 问题 1：日志文件过大

问题描述: 日志文件无限增长，最终占满磁盘。

解决方案: 配置日志滚动策略，限制单个日志文件的大小。参考上文中 logback-spring.xml 的配置，可以设置 maxFileSize 来限制日志文件的大小。

5.2 问题 2：日志级别配置不当

问题描述: 日志级别设置不正确，导致开发环境中输出过多的调试信息，影响调试效率，或者生产环境中缺少必要的日志信息。

解决方案: 在开发环境和生产环境中使用不同的日志级别。可以在 application-dev.yml 中配置 DEBUG 级别日志，而在 application-prod.yml 中配置 INFO 级别日志。

# application-dev.yml
logging:
  level:
    root: DEBUG

# application-prod.yml
logging:
  level:
    root: INFO

5.3 问题 3：多线程日志打印不完整

问题描述: 在多线程环境中，日志内容可能被并发线程打乱，导致日志不完整。

解决方案: 可以使用 Logback 的异步日志功能，通过异步日志来缓冲并发输出。添加以下配置到 logback-spring.xml 中：

<configuration>
    <appender name="ASYNC_FILE" class="ch.qos.logback.classic.AsyncAppender">
        <appender-ref ref="FILE" />
    </appender>

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

---

原文地址：https://blog.csdn.net/weixin_39996520/article/details/142862931

免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！