在Spring Boot开发调试中,如果我们每修改一行代码都需要重启调试,可能会比较耗时。
Spring Boot团队针对这个问题提供了spring-boot-devtools(简称:Devtools)插件,试图提高开发和调试的效率。
什么是热部署和热加载
热部署和热加载可以在应用程序运行时自动更新(重新加载或替换类等)应用程序。
注:提供的解决方案spring-boot-devtools也需要重启,但可以自动加载,无需手动重启。
严格来说,我们需要区分热部署和热加载。对于 Java 项目:
1. 热部署
- 在服务器运行时重新部署项目。
- 它直接重新加载整个应用程序,释放内存,比热加载更干净、更彻底,但需要更多时间。
2. 热加载
- 在运行时重新加载类以升级应用程序。
- 热加载的实现原理主要依赖于java的类加载机制。实现方法可以概括为在容器启动时启动一个后台线程,定期检测class文件时间戳的变化。如果类的时间戳发生更改,则类将重新加载。
- 与反射机制相比,反射在运行时获取类信息,通过动态调用改变程序行为;热加载是在运行时通过重新加载来改变类
配置devtools热部署
1.POM配置
添加 spring-boot-devtools的依赖项
xml
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
2.IDEA配置
如果使用IDEA开发工具,通常有两种方式:
方法一:无配置时,手动触发重启更新(Ctrl+F9)。
可以使用mvn编译来触发重新启动更新。
方法二:IDEA需要开启运行时编译并自动重启更新。
首先选择File -> Setting -> Build,Execution,Deployment -> Compile.
然后,检查Make project automatically.
新版本的IDEA可以设置File -> Setting -> Advanced Settings.
application.yml配置
yaml
spring:
devtools:
restart:
enabled: true # 设置启用热部署
extra-paths: src/main/java # 重启目录
except: WEB-INF/**
thymeleaf:
cache: false # 使用 Thymeleaf 模板引擎,关闭缓存
Devtool的原理?为什么会自动重启?
spring-boot-devtools使用两种类加载器:一种ClassLoader加载不会改变的类(第三方jar包),另一种ClassLoader(restart ClassLoader)加载会改变的类(自定义类)。
文件监视线程在后台启动。当监控目录中的文件发生变化时,原来的文件Restart ClassLoader会被丢弃,新的文件Restart ClassLoader会被重新加载。
因为文件改变后,不会重新加载第三方jar包,只加载自定义的类,而且加载的类比较少,所以重启比较快。
这就是为什么同样是重新启动应用程序。推荐用于spring-boot-devtools热部署重启。
自动重启过程中需要注意以下几点:
- 将记录自动重启
可以通过以下配置将其关闭。
yaml
spring:
devtools:
restart:
log-condition-evaluation-delta: false
- 排除一些不需要自动重启的资源
某些资源发生变化时不一定需要触发重新启动。 默认情况下,更改 /META-INF/maven、/META-INF/resources、/resources、/static、/public 或 /templates 中的资源不会触发重新启动,但会触发实时重新加载。
如果要自定义这些排除项,可以使用
spring.devtools.restart.exclude 属性。 例如,仅排除 /static、/public,您可以设置以下属性:
yaml
spring:
devtools:
restart:
exclude: "static/**,public/**"
如果您想保留这些默认值并添加其他排除项,请改用
spring.devtools.restart.additional-exclude 属性。
- 自定义重启类加载器
重启功能是通过两个类加载器来实现的。对于大多数应用程序来说,这种方法效果很好。但是,它有时会导致类加载问题。
默认情况下,IDE 中任何打开的项目都会使用"重新启动"类加载器进行加载,任何常规 .jar 文件都会使用"基本"类加载器进行加载。
如果您处理多模块项目并且并非每个模块都导入到您的 IDE 中,您可能需要自定义一些内容。为此,您可以创建一个
meta-inf/spring-devtools.properties文件。
该
spring-devtools.properties文件可以包含前缀为restart.exclude和restart.include 的属性包含的元素是应该上拉到"重新启动"类加载器的项目,排除的元素是应该下推到"基础"类加载器的项目。
此属性的值是应用于类路径的正则表达式模式,如以下示例所示:
yaml
restart:
exclude:
companycommonlibs: "/mycorp-common-[\w\d-\.]+\.jar"
include:
projectcommon: "/mycorp-myproj-[\w\d-\.]+\.jar"
Devtool会打包成jar吗?
默认情况下,不会打包成JAR。
运行打包应用程序时,开发人员工具会自动禁用。如果通过或者其他特殊的类加载器启动java-jar,它将被视为生产环境应用程序。
如果我们希望远程调试应用程序,在这种情况下,Devtool 还能够进行远程调试:远程客户端应用程序设计为从 IDE 内运行。
需要
org.springframework.boot.devtool.RemoteSpringApplication使用与要连接的远程项目相同的类路径来运行。
应用程序唯一需要的参数是它连接的远程 URL。
例如,如果使用 Eclipse 或 Spring Tools,并且您有一个名为 且my-app已部署到 Cloud Foundry 的项目,请执行以下操作:
- 从"运行"菜单中选择"运行配置..."。
- 创建一个新的 Java 应用程序"启动配置"。
- 浏览my-app项目。
- org.springframework.boot.devtools.RemoteSpringApplication作为主类使用。
- 添加myapp.cfapps.io到程序参数(或任何远程 URL)。
为什么 Devtool 默认禁用缓存选项?
Spring Boot 支持的一些库使用缓存来提高性能。例如,模板引擎会缓存编译后的模板,以避免重复解析模板文件。此外,Spring MVC 可以在提供静态资源时向响应添加 HTTP 缓存标头。
虽然缓存在生产中非常有益,但在开发过程中可能会适得其反,无法看到刚刚在应用程序中所做的更改。因此,spring-boot-devtools默认情况下禁用缓存选项。
例如,Thymeleaf提供了spring.thymeleaf.cache设置模板引擎的缓存。使用spring-boot-devtools模块时,不需要手动设置这些属性,因为spring-boot-devtools会自动设置它们。
那么会自动设置什么配置呢?可以在
DevToolsPropertyDefaultsPostProcessor类中找到对应的默认配置。
vbnet
public class DevToolsPropertyDefaultsPostProcessor implements EnvironmentPostProcessor {
static {
Map<String, Object>properties = new HashMap<>();
property.put("spring.thymeleaf.cache", "false");
property.put("spring.freemarker.cache", "false");
property.put("spring.groovy.template.cache", "false");
property.put("spring.mustache.cache", "false");
property.put("server.servlet.session.persistent", "true");
property.put("spring.h2.console.enabled", "true");
property.put("spring.web.resources.cache.period", "0");
property.put("spring.web.resources.chain.cache", "false");
property.put("spring.template.provider.cache", "false");
property.put("spring.mvc.log-resolved-exception", "true");
property.put("server.error.include-binding-errors", "ALWAYS");
property.put("server.error.include-message", "ALWAYS");
property.put("server.error.include-stacktrace", "ALWAYS");
property.put("server.servlet.jsp.init-parameters.development", "true");
property.put("spring.reactor.debug", "true");
属性 = Collections.unmodifyingMap(属性);
}
Devtools可以对所有Spring Boot应用程序进行全局配置吗?
可以通过将 spring-boot-devtools.yml 文件添加到 $HOME/.confg/spring-boot 目录来配置全局 Devtools 设置。
添加到这些文件中的任何属性都将应用于您计算机上使用 Devtools 的所有 Spring Boot 应用程序。例如,要将重新启动配置为始终使用触发器文件,您需要将以下属性添加到 spring-boot-devtools 文件中:
yaml
spring:
devtools:
restart:
trigger-file: ".reloadtrigger"