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