Spring Boot DevTools 自动重启问题分析与解决方案

秃头机车侠

已于 2025-03-27 19:31:32 修改

阅读量1.2k

点赞数 31

CC 4.0 BY-SA版权

文章标签： java 数据库 spring boot

于 2025-03-27 19:30:56 首次发布

本文链接：https://blog.youkuaiyun.com/huangjunyilucky/article/details/146568964

Spring Boot DevTools 自动重启问题分析与解决方案

问题现象

在使用 Spring Boot 应用程序时，当调用 mergePdfFiles 方法时，应用程序会在执行一次后不断自动重启，而不是按照定时任务设定的时间间隔（10分钟）执行。但当不调用该方法时，应用程序则正常运行，不会自动重启。

根本原因分析

通过分析日志和代码，问题的根本原因在于以下几点：

Spring Boot DevTools 的自动重启机制：
- Spring Boot DevTools 是一个开发工具，用于提高开发效率
- 它会监控类路径下的文件变化，当检测到变化时自动重启应用程序
- 在 pom.xml 中可以看到项目引入了 DevTools 依赖：
```
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-devtools</artifactId>
    <scope>runtime</scope>
    <optional>true</optional>
</dependency>
```
文件保存位置在类路径下：
- 在 TransNoServiceImpl 类的 mergePdfFiles 方法中，合并后的 PDF 文件被保存在以下路径：
```
String filePath = "....\\src\\main\\resources\\doc";
File targetFile = new File(filePath, mergedFileName);
```
- 这个路径是 src/main/resources/doc，属于应用程序的类路径
自动重启循环：
- 当方法被调用时，会在类路径下生成或修改 PDF 文件
- DevTools 监测到类路径文件变化，认为是源代码发生了变更
- 应用程序自动重启
- 重启后定时任务立即执行，再次调用方法
- 再次生成或修改 PDF 文件，触发新一轮重启
- 形成不断重启的循环

在日志中能够清晰地看到这个过程：

[File Watcher] INFO  o.s.b.d.a.LocalDevToolsAutoConfiguration$RestartingClassPathChangeChangedEventListener 211 - Restarting due to 1 class path change (0 additions, 0 deletions, 1 modification)

解决方案

针对这个问题，有三种主要的解决思路：

修改文件保存位置：

将 PDF 文件保存到非类路径目录，避免触发 DevTools 的自动重启

修改后的代码：

// 确保使用非类路径目录
String outputPath = System.getProperty("user.home") + "/pdf_output";
File outputDir = new File(outputPath);
if (!outputDir.exists()) {
    outputDir.mkdirs();
}

// 生成合并后的文件名
String mergedFileName = "merged_" + transNoList.get(0) + "_" + transNoList.size() + ".pdf";
File targetFile = new File(outputDir, mergedFileName);

配置 DevTools 排除特定资源：

在 application.properties 中添加配置，让 DevTools 忽略指定目录或文件类型

添加的配置：

# 配置需要排除监控的资源目录，避免在这些目录的文件变更时触发重启
spring.devtools.restart.exclude=src/main/resources/doc/**
# 如果需要额外添加排除的目录（在已有的基础上）
spring.devtools.restart.additional-exclude=**/*.pdf

完全禁用 DevTools 自动重启功能：
- 如果不需要开发环境的自动重启功能，可以完全禁用它
- 配置方式（已注释，可根据需要启用）：
```
# 设置为false可以完全禁用自动重启
# spring.devtools.restart.enabled=false
```

为什么这些方案有效

修改文件保存位置：
- Spring Boot DevTools 只监控类路径下的文件变化
- 将文件保存到用户主目录或其他非类路径位置，就不会触发自动重启
- 这是最直接、最彻底的解决方案
配置 DevTools 排除特定资源：
- 即使文件在类路径下，通过配置可以让 DevTools 忽略特定目录或文件类型
- 这适用于必须在类路径下生成文件的情况
禁用自动重启：
- 生产环境通常不需要自动重启功能
- 在开发环境中，如果自动重启带来的麻烦大于便利，可以考虑禁用