Spring Boot + devtools 輕松搞定熱部署!
01、背景介紹
在軟件項(xiàng)目的開發(fā)過(guò)程中,不可避免的會(huì)經(jīng)常修改代碼,每次修改代碼,都需要手動(dòng)停止然后再啟動(dòng)服務(wù),最后驗(yàn)證代碼的正確性。即使一個(gè)簡(jiǎn)單的靜態(tài)資源文件的修改,也需要重啟,整個(gè)過(guò)程其實(shí)非常耗時(shí)。
Spring 團(tuán)隊(duì)也注意到了這一點(diǎn),為了加快項(xiàng)目的重啟速度,Spring Boot 提供了一個(gè)開發(fā)者工具,它可以監(jiān)控 classpath 路徑上的文件,只要源碼或者配置文件修改,Spring Boot 應(yīng)用可以自動(dòng)重啟,更改后的代碼自動(dòng)生效,無(wú)需人工干預(yù)。
可以說(shuō),在開發(fā)階段,這個(gè)功能非常實(shí)用。
今天通過(guò)這篇文章,我們一起來(lái)學(xué)習(xí)一下如何在 Spring Boot 中使用開發(fā)者工具。
02、啟用開發(fā)者工具
下面,我們以Thymeleaf頁(yè)面模板引擎為例,簡(jiǎn)單介紹靜態(tài)資源文件和源代碼的修改,Spring Boot 實(shí)現(xiàn)應(yīng)用自動(dòng)重啟的方式。
2.1、添加相關(guān)依賴包
要使用開發(fā)者工具,首先需要在pom.xml中添加如下依賴包。
<!-- devtools熱部署依賴 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<!-- 防止將依賴傳遞到其他模塊中 -->
<optional>true</optional>
</dependency>
2.2、添加相關(guān)配置參數(shù)
當(dāng)項(xiàng)目添加devtools工具包之后,Spring Boot devtools 默認(rèn)已經(jīng)幫我們開啟了應(yīng)用自動(dòng)重啟特性,也開啟禁止靜態(tài)資源在瀏覽器緩存的屬性,同時(shí)排除了特定的資源文件被修改時(shí)自動(dòng)重啟的操作。
例如,默認(rèn)情況下,Spring Boot devtools 對(duì)如下的資源目錄文件變更,不會(huì)觸發(fā)自動(dòng)重啟。
META-INF/maven/**,META-INF/resources/**,resources/**,static/**,public/**,templates/**,**/*Test.class,**/*Tests.class,git.properties,META-INF/build-info.properties
這些目錄通常用于存放靜態(tài)資源,由于 spring-boot-devtools 工具默認(rèn)開啟了禁用緩存的操作,當(dāng)文件發(fā)生修改時(shí)可以實(shí)時(shí)更新,無(wú)需重啟應(yīng)用。
當(dāng)然,我們也可以在application.properties全局文件中指定配置,比如只排除/static、/public和/templates 目錄中的文件修改重啟操作,額外監(jiān)控src/main/java目錄下的文件修改時(shí)自動(dòng)重啟應(yīng)用。
示例如下:
# 開啟熱部署(更改文件后,自動(dòng)重啟)
spring.devtools.restart.enabled=true
# 設(shè)置哪些資源變動(dòng)后不觸發(fā)自動(dòng)重啟,會(huì)覆蓋默認(rèn)的exclude內(nèi)容(資源不會(huì)觸發(fā)重啟,但會(huì)觸發(fā)實(shí)時(shí)重新加載)
spring.devtools.restart.exclude=static/**,public/**,templates/**
# 設(shè)置需要監(jiān)控額外的路徑,當(dāng)內(nèi)容發(fā)生變化會(huì)出發(fā)自動(dòng)重啟(優(yōu)先于exclude)
spring.devtools.restart.additional-paths=src/main/java
2.3、IDEA 配置
完成以上的配置之后,當(dāng)修改代碼時(shí),可能服務(wù)還是無(wú)法實(shí)現(xiàn)自動(dòng)重啟的效果。
如果你采用的是 IDEA 開發(fā)工具,此時(shí)還需要配合 IDEA 相關(guān)設(shè)置,開啟運(yùn)行時(shí)編譯。
實(shí)現(xiàn)步驟如下!
2.3.1、設(shè)置1
在File->Setting->Build,Execution,Deployment->Compile操作路徑下,勾選Make project automatically。
圖片
2.3.2、設(shè)置2
同時(shí)按住ctrl+alt+shift+/,選擇Registry,找到compiler.automake.allow.when.app.running配置,并將其勾選上。
圖片
圖片
2.4、開啟 fork 配置(選)
通過(guò)以上的設(shè)置之后,如果熱部署服務(wù)依然不能生效,可以在spring-boot-maven-plugin插件中,增加<fork>true</fork>參數(shù)配置,明確啟用熱部署功能。
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<!-- 啟用熱部署功能(如果devtools不生效) -->
<fork>true</fork>
</configuration>
</plugin>
</plugins>
</build>
大部分情況下,經(jīng)過(guò)實(shí)測(cè),沒(méi)有這個(gè)配置也可以實(shí)現(xiàn)自動(dòng)重啟服務(wù),具體以實(shí)際情況而定。
2.5、觀察熱部署效果
完成以上的操作之后,下面我們編寫一個(gè)用例,驗(yàn)證一下服務(wù)自動(dòng)重啟效果。
首先,在templates目錄下創(chuàng)建一個(gè)index.html靜態(tài)頁(yè)面,內(nèi)容如下:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
<p th:text="${content}">內(nèi)容替換</p>
</body>
</html>
接著,創(chuàng)建一個(gè)視圖接口,內(nèi)容如下:
@Controller
public class HelloController {
@GetMapping("/")
public String index(ModelMap map) {
// 綁定元素
map.addAttribute("content", "Hello World");
return "index";
}
}
最后,啟動(dòng)服務(wù),在瀏覽器中訪問(wèn)http://localhost:8080/。
修改接口返回的數(shù)據(jù)為Hello World gogo,服務(wù)會(huì)自動(dòng)重啟,重新訪問(wèn)頁(yè)面后的效果。
圖片
在index.html靜態(tài)頁(yè)面中增加<h1>修改靜態(tài)頁(yè)面代碼</h1>,此時(shí)服務(wù)不會(huì)自動(dòng)重啟,重新訪問(wèn)頁(yè)面后的效果。
圖片
03、關(guān)閉開發(fā)者工具
devtools 只適用于開發(fā)環(huán)境,線上環(huán)境不可開啟。在上生產(chǎn)的時(shí)候,我們希望將其關(guān)閉,如何處理呢?
最簡(jiǎn)單粗暴的方法,就是將其引用排除,可以根治很多問(wèn)題!
當(dāng)然也有另一種辦法,可以在application.properties配置文件中禁止自動(dòng)重啟服務(wù),比如添加如下參數(shù)配置。
spring.devtools.restart.enabled=false
也可以在啟動(dòng)命令中增加-Dspring.devtools.restart.enabled=false參數(shù)來(lái)進(jìn)行關(guān)閉。
自動(dòng)重啟將不再被觸發(fā),但是仍將使用自動(dòng)重啟類加載器。如果你想完全禁用類加載器,可以在啟動(dòng)應(yīng)用程序之前強(qiáng)制設(shè)置,示例如下。
public static void main(String[] args) {
System.setProperty("spring.devtools.restart.enabled", "false");
SpringApplication.run(Application.class, args);
}
04、小結(jié)
最后總結(jié)一下,采用 Spring Boot devtools 開發(fā)者工具,當(dāng)修改代碼時(shí),無(wú)需手動(dòng)重啟服務(wù),即可實(shí)現(xiàn)代碼實(shí)時(shí)更新,并且應(yīng)用自動(dòng)重啟速度也很快,對(duì)于開發(fā)者非常友好。
之所以能實(shí)現(xiàn)這樣的效果,Spring Boot devtools 使用了兩個(gè)類加載來(lái)處理自動(dòng)重啟的問(wèn)題。
對(duì)于不會(huì)變化的類,例如 Spring 本身的引用包和第三方引用的 jar 包,使用一個(gè) base classloader 加載器來(lái)加載;對(duì)于正在開發(fā)中的類,則使用 restart classloader 加載器來(lái)進(jìn)行加載。
同時(shí),后臺(tái)啟動(dòng)一個(gè)文件監(jiān)聽線程(File Watcher),監(jiān)測(cè)目錄中的類發(fā)生變動(dòng)時(shí),原來(lái)的 restart ClassLoader 將被丟棄,并產(chǎn)生一個(gè)新的 restart ClassLoader 來(lái)進(jìn)行加載。因此,這種模式下自動(dòng)重啟會(huì)比冷啟動(dòng)快一些,因?yàn)?base classloader 已經(jīng)準(zhǔn)備好了無(wú)需重啟。