spring boot 配置日志输出到文件

原创

mob64ca12e4d52e 2024-10-27 05:37:14 ©著作权

文章标签 日志输出 spring 代码注释 文章分类 spring boot 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12e4d52e的原创作品，请联系作者获取转载授权，否则将追究法律责任

Spring Boot 配置日志输出到文件

在开发过程中，日志记录是我们调试和分析问题的重要手段。Spring Boot 提供了强大的日志功能，可以轻松地将日志输出到文件中。下面将为你详细介绍如何实现这一功能。

流程步骤

我们将按照以下步骤完成配置日志输出到文件的任务：

步骤	说明
1	添加依赖
2	配置日志文件路径
3	配置日志输出格式
4	测试日志输出

接下来，我们逐步详细讲解每一个步骤。

步骤 1：添加依赖

首先，确保你的项目中有 Spring Boot Starter 依赖。Spring Boot 默认使用 SLF4J 和 Logback，所以不需要额外添加日志相关的依赖。以下是在 pom.xml 文件中的引入：

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

步骤 2：配置日志文件路径

在 src/main/resources 目录下创建或编辑 application.yml（如果是 application.properties，也可以使用）文件，以指定日志文件的输出路径。以下是 YAML 格式的配置示例：

logging:
  file:
    name: logs/app.log  # 设置日志文件名称及路径

代码注释：

logging.file.name：用于指定日志文件的完整路径。我们这里将日志输出到 logs/app.log 文件中。

步骤 3：配置日志输出格式

你还可以在同一个配置文件中设置日志输出的格式。如下所示：

logging:
  pattern:
    console: "%d{yyyy-MM-dd HH:mm:ss} - %msg%n"  # 控制台输出日志格式
    file: "%d{yyyy-MM-dd HH:mm:ss} - %msg%n"     # 文件输出日志格式，可以不同

代码注释：

logging.pattern.console：设置控制台输出的日志格式。
logging.pattern.file：设置文件输出的日志格式。这里可以自定义日期格式及日志内容格式。

步骤 4：测试日志输出

最后，我们需要在代码中输出一些日志以测试配置。你可以在 Spring Boot 的主类或任何你的业务逻辑中添加以下代码：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application {
    private static final Logger logger = LoggerFactory.getLogger(Application.class);  // 创建日志记录器

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);  // 启动 Spring Boot 应用

        logger.info("应用启动成功！");  // 输出日志信息
        logger.error("这是一个错误日志示例");  // 输出错误日志
    }
}

代码注释：