SpringBoot热部署插件原理分析及实战演练

目录

1、关于热部署（Hot Deploy）产生的背景

1）热部署出现前

2）热部署出现后

2、spring-boot-devtools插件原理

1）解决变更文件自动加载到JVM中

2）spring-boot-devtools重启速度比手动重启快

3、关于LiveLoad工具

4、application.yml配置devtools

5、IDEA中设置自动编译（扩展内容）

6、实战演练

1）pom.xml配置

2） application.yml配置

---

SpringBoot热部署工具devtools官方文档地址：https://docs.spring.io/spring-boot/docs/current/reference/html/using.html#using.devtools。

以下内容建议在本地开发调试时使用，生产环境勿用，避免出现网路安全隐患，只有在严格受信任的网络环境下才可启用。热部署工具本身的目的是用于提升开发效率，所以我们优先考虑本地开发这种场景。

1、关于热部署（Hot Deploy）产生的背景

1）热部署出现前

在没有使用热部署的情况下，一个稍微大点的项目启动就要七八秒甚至十几秒的启动时间，当然这取决于你的机器性能，不过毫无疑问，不管你的机器性能如何强大，也耗不过日益增长的项目体量，所以迫切需要无需重新启动项目也能将代码的增加修改同步到服务器的手段。

在实际开发中，我们修改某些代码逻辑功能或页面都需要重启应用，这无形中降低了开发效率。如果当我们修改代码后，服务能自动重启加载新修改的内容，而不需要重启应用，这样是不是就能大幅提高我们开发的效率呢？

这时，就出现了热部署模式。

2）热部署出现后

众所周知，热部署是在服务运行时会重新部署项目，它所针对的是容器或者整个应用，这种方式会释放内存，比热加载更加干净彻底，但同时也更费时间。若部署了新的资源或者修改了一些代码，需要在不停机的情况下的重新加载整个应用。

其原理是加载整个应用程序，包括运行需要使用到的各种文件，比如 Jar 包，JS 或者 CSS 或者 html 等静态文件或者一些配置文件等。以 Tomcat 为例，它首先校验是否开启了热部署，并且发生了修改，它有一个后台线程，定期进行 reload 检测，如果检测需要重新部署，即热部署，则先停止，然后启动，这期间会清理 session，清空内存。

那在今天我们要聊的主角spring-boot-devtools作为一款知名的热部署插件，它是如何优化的热部署方式的呢？请继续往下看。

2、spring-boot-devtools插件原理

虽然devtool工具配置简单且容易上手，但是很少有人理解其底层实现原理；为什么这么说呢？这就像我们使用每一个技术，一定有选择这个技术的理由，那就是它的诸多优点吸引了你，所以你才选择了它。

所以，在我们使用这个工具前，需要做到知其然知其所以然。否则可能仅仅是知道它能做热部署而已。

我们可以先来设想下，如果让你设计热插拔插件，你会怎么做？大致需要满足的几个要求如下，

1）代码修改完后，无需手动重启，立即（或很快）能看到修改后的效果。

2）如果是Java语言，如何将源码转换为Java中的字节码，并将其加载到JVM中？需要有具体技术实现方案。

3）还要保证自动部署比手动重启快，否则热部署就毫无意义可言了。

那在spring-boot-devtools中，是如何满足以上3个特点的呢？

1）解决变更文件自动加载到JVM中

当我们使用编译器启动项目后，在编译器上修改了代码后，编译器会将最新的代码编译成新的.class文件放到classpath下;而引入的spring-boot-devtools插件,插件会监控classpath下的资源，当classpath下的资源改变后，插件会触发重启；spring-boot-devtools使用了两个类加载器ClassLoader，一个ClassLoader加载不会发生更改的类（第三方jar包），另一个ClassLoader（restart ClassLoader）加载会更改的类（自定义的类）。后台启动一个文件监听线程（File Watcher），监测的目录中的文件发生变动时， 原来的restart ClassLoader被丢弃，将会重新加载新的restart ClassLoader。

2）spring-boot-devtools重启速度比手动重启快

我们自己启动的时候，是加载项目中所有的文件（自己编写的文件 + 所有项目依赖的jar）；而加入了spring-boot-devtools插件依赖后，我们自己编写的文件的类加载器为org.springframework.boot.devtools.restart.classloader.RestartClassLoader,是这个工具包自定义的类加载器, 项目依赖的jar使用的是JDK中的类加载器(AppClassLoader\ExtClassLoader\引导类加载器)、在插件触发的重启中，只会使用RestartClassLoader来进行加载(即：只加载我们自己编写的文件部分)。从1）可知，文件变动后，第三方jar包不再重新加载，只加载自定义的类，加载的类比较少，所以重启比较快。这也是为什么，同样是重启应用，为什么不手动重启，建议使用spring-boot-devtools进行热部署重启。

3、关于LiveLoad工具

在spring-boot-devtols包中，我们发现有这样一个包: livereload。那这个包是干什么的呢？

在查阅一些资料后发现，LiveLoad是提供浏览器客户端自动加载更新的一种工具，它分为LiveLoad服务器和Liveload浏览器插件两部分；而在spring-boot-devtools中已经集成了LiveLoad服务器，所以如果我们开发的是web应用，并且期望浏览器自动刷新， 这时候可以考虑LiveLoad。

需要注意的是， 同一时间只能运行一个LiveReload服务器。开始应用程序之前，请确保没有其他LiveReload服务器正在运行。如果从IDE启动多个应用程序，则只有第一个应用程序将支持LiveReload。

4、application.yml配置devtools

spring:devtools:restart:enabled: true  #设置开启热部署additional-paths: src/main/java #重启目录exclude: WEB-INF/**thymeleaf:cache: false #使用Thymeleaf模板引擎，关闭缓存

5、IDEA中设置自动编译（扩展内容）

如果使用的是IDEA开发，需开启IDEA运行时编译，然后自动重启更新；

配置路径：File->Setting->Build,Execution,Deployment->Compile

勾选选项：Make project automatically。

6、实战演练

该热部署插件在实际使用中会有一些小问题，明明已经重启，但没有生效，这种情况下，手动重启一下程序;特别是分布式开发，比如dubbo开发框架，有点问题，需要手动重启，修改完毕后，需要选中项目，在Build选项中选择Build Module。

1）pom.xml配置

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><!--引入SpringBoot Parent依赖--><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.7.7</version><relativePath/> <!-- lookup parent from repository --></parent><!--当前项目的GAV坐标--><groupId>com.xintu.demo</groupId><artifactId>springboot</artifactId><version>0.0.1-SNAPSHOT</version><!--maven项目名称，可以删除--><name>SpringBootCase</name><!--maven项目描述，可以删除--><description>Demo project for Spring Boot</description><!--maven属性配置，可以在其它地方通过${}方式进行引用--><properties><java.version>11</java.version></properties><dependencies><!--引入mybatis jar--><dependency><groupId>org.mybatis.spring.boot</groupId><artifactId>mybatis-spring-boot-starter</artifactId><version>2.1.4</version></dependency><!--引入mysql jar--><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>8.0.25</version></dependency><!--SpringBoot框架web项目起步依赖，通过该依赖自动关联其它依赖，不需要我们一个一个去添加了--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><!--SpringBoot框架的测试起步依赖，例如：junit测试，如果不需要的话可以删除--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency><!-- SpringBoot 热部署插件--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-devtools</artifactId><optional>true</optional> <!-- 可以防止将devtools依赖传递到其他模块中 --></dependency></dependencies><build><plugins><!--SpringBoot提供的打包编译等插件--><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId></plugin><!--==========mybatis代码生成插件配置==========--><plugin><!--插件坐标--><groupId>org.mybatis.generator</groupId><artifactId>mybatis-generator-maven-plugin</artifactId><version>1.3.5</version><!--插件依赖--><dependencies><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>8.0.25</version></dependency></dependencies><!--插件配置--><configuration><!--指定配置文件位置--><configurationFile>src/main/resources/generatorConfig.xml</configurationFile><verbose>true</verbose><overwrite>true</overwrite></configuration></plugin></plugins></build></project>

2） application.yml配置

#spring:
#  profiles:
#      active: test #激活对应环境配置，以测试环境为例
server:port: 8888 # 设置内嵌Tomcat端口号servlet:context-path: /springbootcase # 设置项目上下文根路径，这个在请求访问的时候需要用到test:site: 35xintu.com #测试站点user: xintu #测试用户spring:datasource: # mysql相关配置url: jdbc:mysql://localhost:3306/xintu?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghaiusername: rootpassword: 123456devtools:restart:enabled: true  #设置开启热部署additional-paths: src/main/java #重启目录exclude: WEB-INF/** #排除一些不需要自动重启的资源log-condition-evaluation-delta: false #关闭在什么情况下重启的日志记录，需要时可以打开thymeleaf:cache: false #使用Thymeleaf模板引擎，关闭缓存#在application.yml配置文件中指定映射文件的位置，这个配置只有接口和映射文件不在同一个包的情况下，才需要指定:
mybatis:mapper-locations: classpath:mapper/*.xml

3）修改内容，查看允许效果。

时间对比，

总结：当然spring-boot-devtools除了前面提到的修改日志关闭、关闭thymeleaf缓存、排除加载目录外，还可以自定义重启类加载器、远程调试等特性，大家感兴趣可以自行研究。