对于最新的稳定版本,请使用 Spring Boot 3.5.5! |
开发者工具
Spring Boot 包括一组额外的工具,可以使应用程序开发体验更加愉快。
这spring-boot-devtools
模块可以包含在任何项目中,以提供额外的开发时功能。
要包含 devtools 支持,请将模块依赖项添加到您的构建中,如以下 Maven 和 Gradle 列表所示:
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
dependencies {
developmentOnly("org.springframework.boot:spring-boot-devtools")
}
Devtools 可能会导致类加载问题,尤其是在多模块项目中。诊断类加载问题 解释了如何诊断和解决这些问题。 |
运行完全打包的应用程序时,开发人员工具会自动禁用。
如果您的应用程序是从java -jar 或者,如果它是从特殊的类加载器启动的,则它被视为“生产应用程序”。
您可以使用spring.devtools.restart.enabled 系统属性。
要启用 devtools,无论用于启动应用程序的类加载器如何,请将-Dspring.devtools.restart.enabled=true 系统属性。
在运行 devtools 存在安全风险的生产环境中,不得执行此作。
若要禁用 devtools,请排除依赖项或将-Dspring.devtools.restart.enabled=false 系统属性。 |
在 Maven 中将依赖项标记为可选或使用developmentOnly Gradle 中的配置(如上所示)可防止 devtools 可传递地应用于使用您项目的其他模块。 |
默认情况下,重新打包的存档不包含 devtools。如果要使用某个远程 devtools 功能,则需要包含它。使用 Maven 插件时,将excludeDevtools 属性设置为false . 使用 Gradle 插件时,配置任务的类路径以包含developmentOnly 配置. |
诊断类加载问题
如重新启动与重新加载部分所述,重新启动功能是通过使用两个类加载器实现的。对于大多数应用程序,这种方法效果很好。但是,它有时会导致类加载问题,特别是在多模块项目中。
要诊断类加载问题是否确实是由 devtools 及其两个类加载器引起的,请尝试禁用 restart。 如果这解决了您的问题,请自定义 restart 类加载器以包含您的整个项目。
属性默认值
Spring Boot 支持的几个库使用缓存来提高性能。 例如,模板引擎会缓存编译的模板,以避免重复解析模板文件。 此外,Spring MVC 可以在提供静态资源时将 HTTP 缓存标头添加到响应中。
虽然缓存在生产中非常有益,但它在开发过程中可能会适得其反,使您无法看到刚刚在应用程序中所做的更改。 因此,spring-boot-devtools 默认禁用缓存选项。
缓存选项通常由application.properties
文件。
例如,Thymeleaf 提供spring.thymeleaf.cache
财产。
无需手动设置这些属性,而是spring-boot-devtools
模块自动应用合理的开发时配置。
下表列出了应用的所有属性:
名称 | 默认值 |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
如果您不希望应用属性默认值,您可以将spring.devtools.add-properties 自false 在你的application.properties . |
因为在开发 Spring MVC 和 Spring WebFlux 应用程序时需要有关 Web 请求的更多信息,所以开发人员工具建议您启用DEBUG
日志记录web
logging 组。
这将为您提供有关传入请求、哪个处理程序正在处理它、响应结果和其他详细信息的信息。
如果您希望记录所有请求详细信息(包括潜在的敏感信息),您可以打开spring.mvc.log-request-details
或spring.codec.log-request-details
配置属性。
自动重启
使用spring-boot-devtools
每当类路径上的文件发生更改时,就会自动重新启动。
在 IDE 中工作时,这可能是一个有用的功能,因为它为代码更改提供了非常快速的反馈循环。
默认情况下,将监视类路径上指向目录的任何条目是否发生更改。
请注意,某些资源(例如静态资产和视图模板)不需要重新启动应用程序。
如果您使用构建插件重新启动 Maven 或 Gradle,则必须将forking 设置为enabled .
如果禁用分支,则不会创建 devtools 使用的隔离应用程序类加载器,并且重启将无法正常运行。 |
与 LiveReload 一起使用时,自动重启效果非常好。 有关详细信息,请参阅LiveReload部分。 如果您使用 JRebel,则禁用自动重启,以支持动态类重新加载。 其他开发工具功能(如LiveReload和属性覆盖)仍然可以使用。 |
DevTools 依赖于应用程序上下文的关闭挂钩在重启期间将其关闭。
如果您禁用了关机挂钩(SpringApplication.setRegisterShutdownHook(false) ). |
DevTools 需要自定义ResourceLoader 由ApplicationContext .
如果您的应用程序已经提供了一个,它将被包装。
直接覆盖getResource 方法ApplicationContext 不支持。 |
使用 AspectJ 编织时不支持自动重启。 |
记录条件评估中的更改
默认情况下,每次应用程序重新启动时,都会记录显示条件评估增量的报告。 该报告显示在您进行更改(例如添加或删除 Bean 以及设置配置属性)时对应用程序自动配置所做的更改。
要禁用报告的日志记录,请设置以下属性:
-
Properties
-
YAML
spring.devtools.restart.log-condition-evaluation-delta=false
spring:
devtools:
restart:
log-condition-evaluation-delta: false
排除资源
某些资源在更改时不一定需要触发重启。
例如,可以就地编辑胸腺叶模板。
默认情况下,在/META-INF/maven
,/META-INF/resources
,/resources
,/static
,/public
或/templates
不会触发重启,但会触发实时重新加载。
如果要自定义这些排除项,可以使用spring.devtools.restart.exclude
财产。
例如,要仅排除/static
和/public
您可以设置以下属性:
-
Properties
-
YAML
spring.devtools.restart.exclude=static/**,public/**
spring:
devtools:
restart:
exclude: "static/**,public/**"
如果要保留这些默认值并添加其他排除项,请使用spring.devtools.restart.additional-exclude 属性。 |
禁用重启
如果不想使用重启功能,可以使用spring.devtools.restart.enabled
财产。
在大多数情况下,您可以在application.properties
(这样做仍会初始化 restart 类加载器,但它不会监视文件更改)。
如果您需要完全禁用重启支持(例如,因为它不适用于特定库),则需要将spring.devtools.restart.enabled
System
属性设置为false
在调用之前SpringApplication.run(…)
,如以下示例所示:
-
Java
-
Kotlin
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class MyApplication {
public static void main(String[] args) {
System.setProperty("spring.devtools.restart.enabled", "false");
SpringApplication.run(MyApplication.class, args);
}
}
import org.springframework.boot.SpringApplication
import org.springframework.boot.autoconfigure.SpringBootApplication
@SpringBootApplication
object MyApplication {
@JvmStatic
fun main(args: Array<String>) {
System.setProperty("spring.devtools.restart.enabled", "false")
SpringApplication.run(MyApplication::class.java, *args)
}
}
使用触发器文件
如果您使用的 IDE 会持续编译更改的文件,则可能更愿意仅在特定时间触发重启。 为此,您可以使用“触发器文件”,这是一个特殊文件,当您想要实际触发重启检查时必须修改该文件。
对文件的任何更新都会触发检查,但只有在 Devtools 检测到它有事情要做时才会真正重启。 |
要使用触发器文件,请将spring.devtools.restart.trigger-file
属性设置为触发器文件的名称(不包括任何路径)。
触发器文件必须出现在类路径上的某个位置。
例如,如果您有一个具有以下结构的项目:
src
+- main
+- resources
+- .reloadtrigger
那么你的trigger-file
属性将是:
-
Properties
-
YAML
spring.devtools.restart.trigger-file=.reloadtrigger
spring:
devtools:
restart:
trigger-file: ".reloadtrigger"
现在,只有当src/main/resources/.reloadtrigger
已更新。
您可能想要将spring.devtools.restart.trigger-file 作为全局设置,以便所有项目都以相同的方式运行。 |
某些 IDE 具有无需手动更新触发器文件的功能。Spring Tools for Eclipse 和 IntelliJ IDEA(终极版)都有这样的支持。
使用 Spring Tools,您可以使用控制台视图中的“重新加载”按钮(只要您的trigger-file
被命名为.reloadtrigger
).
对于 IntelliJ IDEA,您可以按照其文档中的说明进行作。
自定义 Restart 类加载器
如前面的“重启与重新加载”部分所述,重启功能是通过使用两个类加载器实现的。
如果这导致问题,可以使用spring.devtools.restart.enabled
system 属性,如果应用在关闭 Restart 的情况下工作,您可能需要自定义由哪个类加载器加载的内容。
默认情况下,IDE 中任何打开的项目都加载“restart”类加载器,以及任何常规.jar
文件使用“基本”类加载器加载。
如果您使用mvn spring-boot:run
或gradle bootRun
:包含您的@SpringBootApplication
加载了“restart”类加载程序,其他所有内容都加载了“基本”类加载程序。
启动应用程序时,类路径会打印在控制台上,这有助于识别任何有问题的条目。
反射使用的类,尤其是注释,可以在启动时先于使用它们的应用程序类加载到父(固定)类加载器中,这可能导致 Spring 在应用程序中无法检测到它们。
您可以通过创建META-INF/spring-devtools.properties
文件。 这spring-devtools.properties
文件可以包含以restart.exclude
和restart.include
. 这include
元素是应该拉入“restart”类加载器的项,并且exclude
元素是应该向下推送到“基本”类加载器的项。该属性的值是一个正则表达式模式,应用于启动时传递给 JVM 的类路径。这是一个示例,其中排除了一些本地类文件,并在重新启动类加载器中包含了一些额外的库:
restart:
exclude:
companycommonlibs: "/mycorp-common-[\\w\\d-\\.]/(build|bin|out|target)/"
include:
projectcommon: "/mycorp-myproj-[\\w\\d-\\.]+\\.jar"
所有属性键必须是唯一的。只要属性以restart.include. 或restart.exclude. 它被认为是。 |
都META-INF/spring-devtools.properties 从类路径加载。您可以将文件打包到项目内部,也可以打包在项目使用的库中。不能使用系统属性,只能使用属性文件。 |
已知限制
重启功能不适用于使用标准反序列化的对象ObjectInputStream
. 如果需要反序列化数据,可能需要使用 Spring 的ConfigurableObjectInputStream
结合使用Thread.currentThread().getContextClassLoader()
.
不幸的是,一些第三方库在不考虑上下文类加载器的情况下反序列化。如果您发现这样的问题,您需要向原始作者请求修复。
LiveReload(实时重载)
这spring-boot-devtools
模块包括一个嵌入式 LiveReload 服务器,可用于在资源更改时触发浏览器刷新。
LiveReload 浏览器扩展可免费用于 Chrome、Firefox 和 Safari。
您可以通过在所选浏览器的市场或商店中搜索“LiveReload”来找到这些扩展。
如果不想在应用程序运行时启动 LiveReload 服务器,可以将spring.devtools.livereload.enabled
属性设置为false
.
一次只能运行一个 LiveReload 服务器。在启动应用程序之前,请确保没有其他 LiveReload 服务器正在运行。如果从 IDE 启动多个应用程序,则只有第一个应用程序支持 LiveReload。 |
要在文件更改时触发 LiveReload,必须启用 自动重启 。 |
全局设置
可以通过将以下任何文件添加到$HOME/.config/spring-boot
目录:
-
spring-boot-devtools.properties
-
spring-boot-devtools.yaml
-
spring-boot-devtools.yml
添加到这些文件的任何属性都适用于计算机上使用 devtools 的所有 Spring Boot 应用程序。例如,要将 restart 配置为始终使用触发器文件,您需要将以下属性添加到spring-boot-devtools
文件:
-
Properties
-
YAML
spring.devtools.restart.trigger-file=.reloadtrigger
spring:
devtools:
restart:
trigger-file: ".reloadtrigger"
默认情况下,$HOME
是用户的主目录。
要自定义此位置,请将SPRING_DEVTOOLS_HOME
环境变量或spring.devtools.home
系统属性。
如果在$HOME/.config/spring-boot ,的根$HOME 目录中是否存在.spring-boot-devtools.properties 文件。
这允许您与旧版本 Spring Boot 上的应用程序共享 devtools 全局配置,这些应用程序不支持$HOME/.config/spring-boot 位置。 |
devtools 属性/yaml 文件不支持配置文件。 在 |
配置文件系统观察程序
FileSystemWatcher
通过轮询具有一定时间间隔的类更改,然后等待预定义的静默期以确保没有更多更改来工作。
由于 Spring Boot 完全依赖于 IDE 将文件编译并复制到 Spring Boot 可以读取它们的位置,因此您可能会发现,当 devtools 重新启动应用程序时,有时某些更改不会反映出来。
如果您经常观察到此类问题,请尝试增加spring.devtools.restart.poll-interval
和spring.devtools.restart.quiet-period
参数设置为适合您的开发环境的值:
-
Properties
-
YAML
spring.devtools.restart.poll-interval=2s
spring.devtools.restart.quiet-period=1s
spring:
devtools:
restart:
poll-interval: "2s"
quiet-period: "1s"
现在,每 2 秒轮询一次受监视的类路径目录以进行更改,并保持 1 秒的静默期以确保没有额外的类更改。
远程应用
Spring Boot 开发人员工具不限于本地开发。远程运行应用程序时,还可以使用多个功能。远程支持是选择加入的,因为启用它可能会带来安全风险。只有在受信任的网络上运行或使用 SSL 保护时才应启用它。如果这两个选项都不可用,则不应使用 DevTools 的远程支持。永远不应在生产部署上启用支持。
要启用它,您需要确保devtools
包含在重新打包的存档中,如以下列表所示:
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<excludeDevtools>false</excludeDevtools>
</configuration>
</plugin>
</plugins>
</build>
然后你需要将spring.devtools.remote.secret
财产。 与任何重要的密码或密钥一样,该值应该是唯一且强大的,以便无法被猜测或暴力破解。
远程开发工具支持分为两部分:接受连接的服务器端端点和在 IDE 中运行的客户端应用程序。当spring.devtools.remote.secret
属性已设置。客户端组件必须手动启动。
Spring WebFlux 应用程序不支持远程开发工具。 |
运行远程客户端应用程序
远程客户端应用程序设计为在 IDE 中运行。您需要运行RemoteSpringApplication
与您连接到的远程项目具有相同的类路径。应用程序的唯一必需参数是它所连接的远程 URL。
例如,如果您使用的是 Eclipse 或 Spring Tools,并且您有一个名为my-app
,则执行以下作:
-
选择
Run Configurations…
从Run
菜单。 -
创建一个新的
Java Application
“启动配置”。 -
浏览
my-app
项目。 -
用
RemoteSpringApplication
作为主要类别。 -
加
https://myapp.cfapps.io
到Program arguments
(或无论您的远程 URL 是什么)。
正在运行的远程客户端可能类似于以下列表:
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ ___ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | | _ \___ _ __ ___| |_ ___ \ \ \ \
\\/ ___)| |_)| | | | | || (_| []::::::[] / -_) ' \/ _ \ _/ -_) ) ) ) )
' |____| .__|_| |_|_| |_\__, | |_|_\___|_|_|_\___/\__\___|/ / / /
=========|_|==============|___/===================================/_/_/_/
:: Spring Boot Remote :: (v3.4.9)
2025-08-21T06:48:53.021Z INFO 133501 --- [ main] o.s.b.devtools.RemoteSpringApplication : Starting RemoteSpringApplication v3.4.9 using Java 17.0.16 with PID 133501 (/Users/myuser/.m2/repository/org/springframework/boot/spring-boot-devtools/3.4.9/spring-boot-devtools-3.4.9.jar started by myuser in /opt/apps/)
2025-08-21T06:48:53.040Z INFO 133501 --- [ main] o.s.b.devtools.RemoteSpringApplication : No active profile set, falling back to 1 default profile: "default"
2025-08-21T06:48:54.191Z INFO 133501 --- [ main] o.s.b.d.a.OptionalLiveReloadServer : LiveReload server is running on port 35729
2025-08-21T06:48:54.348Z INFO 133501 --- [ main] o.s.b.devtools.RemoteSpringApplication : Started RemoteSpringApplication in 3.625 seconds (process running for 4.538)
因为远程客户端使用与真实应用程序相同的类路径,所以它可以直接读取应用程序属性。这就是spring.devtools.remote.secret 属性被读取并传递给服务器进行身份验证。 |
始终建议使用https:// 作为连接协议,使流量被加密,密码无法被拦截。 |
如果您需要使用代理访问远程应用程序,请配置spring.devtools.remote.proxy.host 和spring.devtools.remote.proxy.port 性能。 |
远程更新
远程客户端以与本地重新启动相同的方式监视应用程序类路径的更改。 任何更新的资源都会推送到远程应用程序,并(如果需要)触发重启。 如果循环访问使用本地没有的云服务的功能,这会很有帮助。 通常,远程更新和重启比完整的重建和部署周期快得多。
在较慢的开发环境中,可能会出现静默期不够的情况,类中的更改可能会被拆分为批次。 上传第一批类更改后,服务器将重新启动。 无法将下一批发送到应用程序,因为服务器正在重启。
这通常表现为RemoteSpringApplication
有关上传某些类失败的日志,以及随之而来的重试。
但也可能导致应用代码不一致,上传第一批更改后无法重启。
如果您经常观察到此类问题,请尝试增加spring.devtools.restart.poll-interval
和spring.devtools.restart.quiet-period
参数设置为适合您的开发环境的值。
有关配置这些属性,请参阅配置文件系统观察程序部分。
仅在远程客户端运行时监视文件。 如果在启动远程客户机之前更改文件,则不会将其推送到远程服务器。 |