您好,登錄后才能下訂單哦!
使用Spring Boot DevTools實現(xiàn)優(yōu)化開發(fā)過程?很多新手對此不是很清楚,為了幫助大家解決這個難題,下面小編將為大家詳細講解,有這方面需求的人可以來學(xué)習(xí)下,希望你能有所收獲。
場景再現(xiàn)
某日少年收到前端同學(xué)發(fā)來的消息說聯(lián)調(diào)的接口響應(yīng)異常,少年表現(xiàn)的很平靜,因為這種事情太平常了。于是詢問詳情之后開始打開自己的代碼查找問題所在,沒過五分鐘就發(fā)現(xiàn)了問題。少年修改完代碼之后將本地啟動的項目停止然后再重新啟動。由于當前的服務(wù)端項目是一個巨大的單體應(yīng)用,啟動需要花三四分鐘時間,于是少年就拿出手機開始刷起朋友圈。刷著刷著(由于注意力分散不知不覺花了十幾分鐘)突然意識到項目已經(jīng)重新啟動,于是通知前端同學(xué)查看效果。
分析問題
上面的場景可能對很多開發(fā)者來說感同身受,在開發(fā)中修改項目是很平常且頻繁的一件事情。當我們修改完代碼或其他文件的時候,我們會重新啟動項目來驗證修改是否真的生效(這里忽略我們編寫的測試代碼),以供前端或者其他客戶端來使用我們的修改。但是不知不覺這樣的流程浪費了我們很多時間,甚至被迫分散我們的注意力(打開社交軟件、看新聞、和同事聊天),這些問題對我們的生產(chǎn)力是一個極大的威脅。
spring-boot-devtools
能否有一種方案可以讓我們對項目的修改快速生效,從而節(jié)省那些我們本該可以利用的時間呢?幸好有一種工具可以解決當前所存在的問題,這就是**Spring Boot Dev Tools**。
原理簡介
您可能會說,了解Spring Boot Dev Tools的工作原理并不重要,但是由于開發(fā)過程中存在很多復(fù)雜的情況,所以了解Spring Boot Dev Tools的工作原理是對我們有幫助的。
Spring Boot Dev Tools鉤接(hooks into)到Spring Boot的類加載器中,以提供一種方法來按需重新啟動應(yīng)用程序上下文或重新加載已更改的靜態(tài)文件而無需重新啟動整個應(yīng)用程序。
為此,Spring Boot Dev Tools將劃分應(yīng)用程序的類路徑并分配給兩個不同的類加載器:
重新啟動應(yīng)用程序后,現(xiàn)有的重新啟動類加載器將被丟棄,新的重新啟動類加載器將被啟動。這種方法意味著應(yīng)用程序的重啟通常比“冷啟動”要快得多,因為基本類加載器沒有受到影響并且一直存在著。
引入依賴
當我們使用intellij IDEA的Spring Initializr創(chuàng)建項目時,Spring Initializr提供了內(nèi)置的Spring Boot Dev Tools依賴選項,我們只需選擇它即可。
Spring Initializr中引入Spring Boot Dev Tools
Maven項目中引入Spring Boot Dev Tools
在項目的pom.xml文件中引入Spring Boot Dev Tools依賴即可
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> <scope>runtime</scope> <optional>true</optional> </dependency>
在項目中添加一個簡單的Controller
@SpringBootApplication public class DevToolApplication { public static void main(String[] args) { SpringApplication.run(DevToolApplication.class, args); } @RestController public static class HelloWorld { @GetMapping("test") public ResponseEntity<?> getTest() { return ResponseEntity.ok("hello world"); } } }
啟動項目,訪問http://localhost:8080/test,返回如下:
我們簡單修改代碼
@RestController public static class HelloWorld { @GetMapping("test") public ResponseEntity<?> getTest() { return ResponseEntity.ok("hello world after change file"); } }
運行命令mvn compile,運行完畢重新訪問http://localhost:8080/test
可以看到,我們的更改已經(jīng)生效了。
多模塊
假設(shè)現(xiàn)在我們的項目引用了其他項目作為子模塊
<dependency> <groupId>org.example</groupId> <artifactId>untitled</artifactId> <version>1.0-SNAPSHOT</version> </dependency>
我們需要在程序運行時,對上述子模塊的修改也即時生效。
在多模塊項目中使用Spring Boot Dev Tools比單模塊項目略復(fù)雜,由于在多模塊項目中主模塊對子模塊是引用關(guān)系,并且在運行時主模塊通過引用子模塊的jar文件的形式來啟動應(yīng)用程序,根據(jù)前面Spring Boot Dev Tools的原理,jar文件的加載將歸屬于基本類加載器,因此按照現(xiàn)在的做法無法做到子模塊的修改即時生效。
不過Spring Boot Dev Tools提供了對多模塊項目的支持,我們只需要添加簡單的配置即可實現(xiàn)多模塊項目的修改即時生效。
在項目的/resources中創(chuàng)建META-INF/spring-devtools.properties文件,并添加配置
restart.include.projectcommon=/untitled-1.0-SNAPSHOT.jar
上述配置表明重新啟動類加載器在重新啟動的時候,會加載最新的子模塊依賴,從而做到子模塊的修改即時生效。
現(xiàn)在子模塊中存在如下類
public class DemoA { private String name; public String getName() { return name; } public DemoA setName(String name) { this.name = name+"cgsj111"; return this; } }
主模塊中引用了上面的類
@RestController public static class HelloWorld { @GetMapping("test") public ResponseEntity<?> getTest() { DemoA demo = new DemoA(); demo.setName("demo name"); return ResponseEntity.ok(demo); } }
此時啟動應(yīng)用程序,訪問http://localhost:8080/test
可以看到響應(yīng)正常返回,此時我們修改子模塊的代碼
public class DemoA { private String name; public String getName() { return name; } public DemoA setName(String name) { this.name = name+"cgsj111 After Change"; return this; } }
然后在主模塊中運行命令 mvn compile,此時再次訪問接口
可以看到子模塊的修改已經(jīng)在主模塊中即時生效了。
遠程調(diào)試
Spring Boot Dev Tools所展現(xiàn)的高效便捷之處不僅僅局限于本地調(diào)試,對于遠程調(diào)試也有很好的支持。選擇性地啟用遠程支持是因為啟用它可能會帶來安全風(fēng)險。僅當在受信任的網(wǎng)絡(luò)上運行或使用SSL保護時,才應(yīng)啟用它。如果這兩個選項都不滿足,則不應(yīng)使用DevTools的遠程支持。您永遠不應(yīng)該在生產(chǎn)環(huán)境中啟用他。
啟用它需要確保構(gòu)建物中包含devtools,修改至如下配置:
<build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> <configuration> <!--確保項目打包是將Devtools包含進去--> <excludeDevtools>false</excludeDevtools> </configuration> </plugin> </plugins> </build>
然后,您需要設(shè)置spring.devtools.remote.secret屬性。像任何重要的密碼或機密一樣,該值應(yīng)唯一且強壯,以免被猜測或強行使用,例如,在application.properties中設(shè)置:
spring.devtools.remote.secret=cgsj8377
遠程devtools支持分為兩部分:接受連接的服務(wù)器端端點和在IDE中運行的客戶端應(yīng)用程序。設(shè)置spring.devtools.remote.secret屬性后,將自動啟用服務(wù)器組件,客戶端組件必須手動啟動。
調(diào)試演示
在項目文件夾中運行命令 mvn package生成jar文件,將jar文件部署到服務(wù)器(在這里我們以本地運行jar包的方式來模擬遠程部署)。然后在IDE進行如下配置(以Intellij IDEA為例)
如上圖我們添加了一個啟動器,啟動類為org.springframework.boot.devtools.RemoteSpringApplication,并且傳遞了一個程序參數(shù)來指定遠程應(yīng)用程序的地址,此處筆者在本機上試驗所以是一個本機的地址。
接下來我們啟動我們剛剛創(chuàng)建的啟動器
啟動日志如下
修改代碼至如下
@RestController public static class HelloWorld { @GetMapping("test") public ResponseEntity<?> getTest() { DemoA demo = new DemoA(); demo.setName("remote test"); return ResponseEntity.ok(demo); } }
然后運行命令mvn compile,可以看到我們的更改在運行的程序中即時生效了
總結(jié)
在我們的日常的開發(fā)過程中總會存在各種各樣的“等待”,這些時刻很大程度上會影響開發(fā)者的效率和注意力。而Developer Tools的出現(xiàn)緩解了這個問題,他使應(yīng)用程序的調(diào)試更加的便捷高效。有一點要注意的是在讓我們的更改生效之前需要執(zhí)行mvn compile命令,從而使本地代碼能被編譯成程序可以理解的字節(jié)碼文件。
看完上述內(nèi)容是否對您有幫助呢?如果還想對相關(guān)知識有進一步的了解或閱讀更多相關(guān)文章,請關(guān)注億速云行業(yè)資訊頻道,感謝您對億速云的支持。
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進行舉報,并提供相關(guān)證據(jù),一經(jīng)查實,將立刻刪除涉嫌侵權(quán)內(nèi)容。