Spring boot 官網學習筆記 - Spring DevTools 介紹
-
想要使用devtools支援,只需使用dependencies將模組依賴關係新增到你的構建中
- 執行打包的應用程式時,開發人員工具會自動禁用。如果你通過
java -jar
或者其他特殊的類載入器進行啟動時,都會被認為是“生產環境的應用”。 - 功能
- 去除伺服器端快取、客戶端快取預設設定
-
Spring Boot 支援的一些庫中會使用快取來提高效能。例如模版引擎將快取編譯後的模板,以避免重複解析模板檔案。 此外,Spring MVC可以在服務靜態資源時向響應中新增HTTP快取頭。
雖然快取在生產中非常有益,但它在開發過程中可能會產生反效果,它會阻止你看到剛剛在應用程式中進行的更改。 因此,spring-boot-devtools將預設禁用這些快取選項
- 快取選項通常在
application.properties
檔案中配置。 例如,Thymeleaf提供了spring.thymeleaf.cache
屬性。spring-boot-devtools
模組不需要手動設定這些屬性,而是自動應用合理的開發時配置。
-
- 自動重啟
spring-boot-devtools
會在類路徑上的檔案發生更改時自動重啟。- 預設情況下會監視類路徑上的所有變動
- 當DevTools監視類路徑資源時,觸發重啟的唯一方法是更新類路徑。 導致類路徑更新的方式取決於你正在使用的IDE。在Eclipse中,儲存修改的檔案將導致類路徑被更新並觸發重啟。 在IntelliJ IDEA中,構建專案( Build -> Make Project )將具有相同的效果。
- Spring Boot提供的重新啟動技術使用了兩個類載入器。 不改變的類(例如,來自第三方jar的)被載入到 base 類載入器中。 你正在開發的類被載入到 restart 類載入器中。 當應用程式重啟時, restart載入器將被丟棄,並建立一個新的類載入器。 這種方法意味著應用程式重啟通常比“冷啟動”快得多,因為 base 載入器已經已載入並且可用。
- 排除資源
- 某些資源在更改時不一定需要觸發重啟。 例如,可以直接編輯Thymeleaf模板。 預設情況下,更改/META-INF/maven , /META-INF/resources , /resources , /static , /public或/templates中的資源不會觸發重啟,但會觸發實時重新載入。 如果要自定義這些排除項,可以使用spring.devtools.restart.exclude屬性。 例如,要僅排除/static和/public你將設定以下內容
- spring.devtools.restart.exclude = static / **,public / **
- 監控額外的路徑
- 當你對不在類路徑中的檔案進行更改時,可能需要重啟或重新載入應用程式。 為此,請使用spring.devtools.restart.additional-paths屬性來配置監視其他路徑的更改。 你可以使用上述的spring.devtools.restart.exclude屬性來控制附加路徑下的更改是否會觸發完全重啟或只是實時重新載入 。
- 禁用重啟
-
如果不想使用重啟功能,可以使用spring.devtools.restart.enabled屬性來禁用它。 在大多數情況下,你可以在application.properties中設定此項(這仍將初始化重啟類載入器,但不會監視檔案更改)。
例如,如果你需要完全禁用重啟支援,因為它不適用於特定庫,則需要在呼叫SpringApplication.run(…)之前設定System屬性。 例如
-
public static void main(String[] args) { System.setProperty("spring.devtools.restart.enabled", "false"); SpringApplication.run(MyApp.class, args); }
-
- 使用觸發檔案
-
如果你使用自動編譯已更改檔案的IDE,則可能希望僅在特定時間觸發重啟。 為此,你可以使用“觸發檔案”,這是一個特殊檔案,當你要實際觸發重啟檢查時,必須修改它。 更改檔案只會觸發檢查,只有在Devtools檢測到它必須執行某些操作時才會重啟。 觸發檔案可以手動更新,也可以通過IDE外掛更新。
要使用觸發器檔案,請使用spring.devtools.restart.trigger-file屬性。
-
- 自定義重啟類載入器
-
如上面重新啟動和重新載入部分所述,重啟功能是通過使用兩個類載入器實現的。 對於大多數應用程式,此方法執行良好,但有時可能會導致類載入問題。
預設情況下,IDE中的任何開啟的專案都會使用“restart”類載入器載入,任何常規.jar檔案將使用“base”類載入器載入。 如果你在多模組專案上工作,但不是每個模組都匯入到IDE中,則可能需要自定義配置。 為此,你可以建立一個META-INF/spring-devtools.properties檔案。
spring-devtools.properties檔案可以包含restart.exclude. 和restart.include. 字首的屬性。 include元素是應該被放入“restart”類載入器的專案, exclude元素是應該放入“base”類載入器的專案。 屬性的值是應用於類路徑下的正則表示式。
例如:
-
restart.exclude.companycommonlibs=/mycorp-common-[\\w-]+\.jar restart.include.projectcommon=/mycorp-myproj-[\\w-]+\.jar 針對通用Mapper,可以做如下配置: restart.include.mapper=/mapper-[\\w-\\.]+jar 所有屬性的鍵值(名字,companycommonlibs 部分)必須是唯一的,只有 restart.exclude. 和 restart.include. 開頭的屬性有效。 所有類路徑下面的 META-INF/spring-devtools.properties 配置檔案都會生效,所以你可以把該配置打包到每個模組中。 注:新版本的Mapper(3.4.1+)會預設增加該配置。
-
- 已知限制
-
重啟功能對使用標準ObjectInputStream物件序列化的物件不是很好 。如果需要反序列化資料,可能需要使用Spring的ConfigurableObjectInputStream配合Thread.currentThread().getContextClassLoader() 使用。
不幸的是,一些第三方庫都不考慮在使用上下文類載入器的情況下反序列化。 如果你發現這樣的問題,你需要向原作者請求修復。
-
- 實時載入
-
spring-boot-devtools模組包含嵌入式LiveReload伺服器,可以在資源更改時用於觸發瀏覽器重新整理。 LiveReload瀏覽器擴充套件程式支援Chrome,Firefox和Safari,你可以從livereload.com免費下載。
如果你不想在應用程式執行時啟動LiveReload伺服器,則可以將spring.devtools.livereload.enabled屬性設定為false 。
同一時間只能執行一個LiveReload伺服器。 開始應用程式之前,請確保沒有其他LiveReload伺服器正在執行。如果從IDE啟動多個應用程式,則只有第一個應用程式將支援LiveReload。
-
- 全域性設定
-
你可以通過向$HOME資料夾新增名為.spring-boot-devtools.properties的檔案來配置全域性devtools設定(請注意,檔名以“.”開頭)。 新增到此檔案的任何屬性將適用於你的計算機上使用devtools的所有 Spring Boot應用程式。 例如,要配置重啟始終使用觸發器檔案 ,你可以新增以下內容:
〜/ .spring-boot-devtools.properties。
spring.devtools.reload.trigger-file=.reloadtrigger
-
- 去除伺服器端快取、客戶端快取預設設定
- 新增依賴
- 將依賴標記為
optional
可選是一種最佳做法,可以防止將devtools依賴傳遞到其他模組中 -
<dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> <optional>true</optional> </dependency> </dependencies>
- 將依賴標記為