Spring Boot 应用热部署

发表于 分类于

SpringBoot通过配置DevTools工具来达到热部署效果。在原理上是使用了两个ClassLoader，一个ClassLoader加载那些不会改变的类（如第三方包），另一个ClassLoader加载会改变的类，称为Reset ClassLoader，这样在有代码改变的时候，原来的ResetClassLoader被丢弃，重新创建一个ResetClassLoader，由于需要加载的类比较少，所以实现了较快的重启时间。

配置DevTools环境

引入 DevTools 依赖包，注意配置 optional>true</optional>

pom.xml
1
2
3
4
5
6
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-devtools</artifactId>
  <!-- 当前项目被继承之后，这个不向下传递 -->
  <optional>true</optional>
</dependency>

plugin中添加devtools生效标志

pom.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
<build>
  <finalName>spring-boot-quickstart</finalName>
  <plugins>
    <plugin>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-maven-plugin</artifactId>
      <version>2.6.6</version>
      <configuration>
        <!-- 如果没有该配置，热部署的devtools不生效 -->
        <fork>true</fork>
      </configuration>
    </plugin>
  </plugins>
</build>

devtools 可以实现页面热部署（即页面修改后会立即生效，这个可以直接在 application.properties 文件中配置 spring.thymeleaf.cache=fales 来实现）,实现类文件热部署（类文件修改后不会立即生效），实现对属性文件的热部署。即devtools会监听 classpath 下的文件变动，并且会立即重启应用（发生在保存文件时候），注意：因为其采用的虚拟机机制，该项重启是很快的。配置了后在修改java文件后也就支持了热启动，不过这种方式是属于项目重启（速度比较快的项目重启），会清空session中的值，也就是如果有用户登录的话，项目重启后需要重新登录。

默认情况下，/META-INF/maven，/META-INF/resources，/resources，/statuc，/templates，/public 这些文件夹下的文件修改不会使应用重启，但是会重新加载（devtools内嵌了一个LiveReload Server，当资源发生改变时，浏览器刷新）。

全局配置文件配置

在 application.yml 中配置 spring.devtools.restart.enabled = false，此时 restart 类加载器还会初始化，但不会监视文件更新。

application.yml
1
2
3
4
5
6
7
8
9
10
spring:
  ## 热部署配置
  devtools:
    restart:
      enabled: true
      ## 设置重启的目录，添加目录的文件需要restart
      additional-paths: src/main/java
      ## 解决项目自动重新编译后接口报404的问题
      poll-interval: 3000
      quiet-period: 1000

Idea 配置

当我们修改了java类后，Idea默认是不自动编译的，而 spring-boot-devtools又是监测 classpath 下的文件发生变化才会重启应用，所以需要设置 idea 的自动编译。

  • 自动编译配置
    settings–>compiler–>Build project automatically
  • Registry 属性修改

Ctrl + Shift + alt + / ，macos是 command + option + shift + / 选择 Registry，勾上 `Compiler.automark.allow.when.app.running

如果此选项在 idea 中没有找到，那有可能是idea版本比较高，配置选项移到下图位置了。

测试

Ctrl + F9 重新编译