springboot热部署之spring-boot-devtools

1 场景

基于springboot进行开发，开发过程中，如果每次修改代码都将项目重启，将耗费大量的时间成本。

目前java虚拟机只能识别方法体内的内容更改，如果修改整个类或者更改配置文件，仍然需要重启java虚拟机。

使用spring-boot-devtools，可以实现指定目录（默认为classpath路径）下的文件进行更改后，项目自动重启，更改后的代码自动生效。

2 开发环境

springboot版本：2.2.9.RELEASE

开发工具：IDEA

3 原理

spring-boot-devtools使用了两个类加载器ClassLoader，一个ClassLoader加载不会发生更改的类（第三方jar包），另一个ClassLoader（restart ClassLoader）加载会更改的类（自定义的类）。

后台启动一个文件监听线程（File Watcher），监测的目录中的文件发生变动时，原来的restart ClassLoader被丢弃，将会重新加载新的restart ClassLoader。

因为文件变动后，第三方jar包不再重新加载，只加载自定义的类，加载的类比较少，所以重启比较快。

这也是为什么，同样是重启应用，为什么不手动重启，建议使用spring-boot-devtools进行热部署重启。

4 步骤

4.1 maven配置

需要进行热部署的项目中，pom文件增加对应的maven依赖。

开启maven打包插件中的钩子配置fork（devtools基于打包的钩子配置）。

<dependencies>
    <!-- devtools热部署依赖 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <!-- 防止将依赖传递到其他模块中 -->
        <optional>true</optional>
        <!-- 只在运行时起作用，打包时不打进去（防止线上执行打包后的程序，启动文件监听线程File Watcher，耗费大量的内存资源） -->
        <scope>runtime</scope>
    </dependency>
</dependencies>

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
                <!-- devtools依赖此配置（否则，devtools不生效）。 -->
                <fork>true</fork>
            </configuration>
        </plugin>
    </plugins>
</build>

4.2 devtools配置

默认devtools的exclude内容如下（设置exclude属性后，默认的配置将被覆盖）：

META-INF/maven/**,META-INF/resources/**,resources/**,static/**,public/**,templates/**
,**/*Test.class,**/*Tests.class,git.properties,META-INF/build-info.properties

yml配置如下：

spring:
  devtools:
    restart:
      # 开启热部署（更改文件后，自动重启）
      enabled: true
      ## 设置哪些资源变动后不触发热部署，会覆盖默认的exclude内容（资源不会触发重启，但会触发实时重新加载）
      # exclude: WEB-INF/**,static/**
      ## 监控额外的路径（优先于exclude）
      # additional-paths: src/main/java

4.3 IDEA配置

IDEA需开启运行时编译

设置1：

File->Setting->Build,Execution,Deployment->Compile

勾选：Make project automatically

设置2：

快捷键：ctrl+alt+shift+/

选择：Registry

勾选：compiler.automake.allow.when.app.running

5 注意事项

• 默认监听classpath路径下的文件更改
• devtools只适用于开发环境。线上环境不可开启，可通过设置maven依赖中的scope属性为runtime来实现，打包时不将devtools打包到jar包中。
• devtools需配置在需要进行热部署的模块的pom中，且不能向上传递，不可配置在基础依赖模块中。