搜尋澳門生活誌

Spring Boot 06 - Spring Boot Web 調試工具

MacauYeah・2024-08-02

之前兩節，都一直在講怎樣寫code，也介紹了Test Case的好。若為初次接觸，Spring有很多設定需要摸索，若開始時就設定錯誤，對不少人來講都會有很大打擊。在這裏，筆者就介紹一些vscode和spring的工具，可以讓IDE多幫忙一下，減少走歪路的機會。 vscode插件以下兩個插件，都在於提示用戶設定。 Spring Boot Dashboard vscjava.vscodespringbootdashboard 可以那它來運作spring boot app，省去找尋main 位置的麻煩綜覽整個程式中的所有Bean Bean是一個很重要的元素，日後會再提及若程式為Spring boot web，可以顯示所 http endpoint。 Spring Boot Tools vmware.vscodespringboot 檢查設定檔的設定值有沒有寫錯（application.properties， application.yml）綜覽檔案中的有以@為首的與spring相關的元素（檔案很大時就會有用）可以在IDE運行spring時，查看@元素的bean資訊 not works , 加了actuator也是沒有看見 Spring Initializr（vscjava.vscodespringinitializr）經網絡初始化spring 專案的依賴引用設定 Maven for Java vscjava.vscodemaven 若大家在使用Spring Initializr時，選取了maven作管理工具，那麼這插件就可以在後續幫忙更新引用。若專案的Spring 及㡳層引用有變，vscode也需要它來引用更新。這是java 開發工具包vscjava的其中一員，它的其他插件也可以順帶安裝。調試工具 open api swaggerui 如果我們在開發Web http API ，其實都是為了該某個客戶端使用。但如果該客端明白我們的API該怎樣使用，大家總不會逐個連結，自行編寫使用手冊及範例吧。所以就有了open api 和 swaggerui 的旦生。 open api，就是一個公認的使用手冊標準，我們只要在springweb中加入 springdocopenapistarterwebmvcui 的程式庫，就可以自動為我們的controller 生成 open api 的說明檔。更強大的是，這個程式庫可以利用剛生成的open api，配上 swaggerui ，自動測生一個可供測試的頁面。這個頁面可以供碼農們直接操作，也會產生對應的 curl 指令，讓碼農們可以在任何的主機上重複。這樣，那麼是沒有太多解釋的說明文檔也可以使用。做法很簡單，在pom.xml中加入依賴。 org.springdoc springdocopenapistarterwebmvcui 2.5.0 由於安全性問題，上述程式碼未能完整顯示，請參見文末完成Source Code 然後我們就可以加入Controller，運行 spring 後，我們可以在 httplocalhost8080swaggeruiindex.html 找到 swagger 的頁面，然後就可以在 ui 上測試API了。躲在Proxy背後的 swagger 如果你跟筆者一樣，使用 codeserver 或 github codespaces ，你就不能很隨意地連接到 8080 端口。你只能經過Http Proxy去訪問。這樣 open api的原有的設定就不合用了。這時我們需要自行修改 open api 的 bean，加入我們真正的根路徑。然後筆者使用 codeserver，而IDE只會在port 9000上執行，它對外的前置路徑會是 httplocalhost9000proxy8080。 @Bean public OpenAPI springShopOpenAPI Server server = new Server; server.setUrlquot;httplocalhost9000proxy8080quot;; return new OpenAPI.serversList.ofserver; 由於安全性問題，上述程式碼未能完整顯示，請參見文末完成Source Code 然後訪問 httplocalhost9000proxy8080swaggeruiindex.html，還會發現 quot;Failed to load remote configuration.quot; 。但你可以在 quot;explorequot; 搜尋欄位內貼上 httplocalhost9000proxy8080v3apidocs，再一次搜尋檔案，就回復正常了。註：如果你熟習Nginx這類Reverse Proxy ，你的環境有條件直接修改 Request Header，加入XForwarded，就不用煩惱寫Bean了，也不用手動在explore裏重新修正apidocs的位置。詳見 httpsspringdoc.orgindex.html#howcanideployspringdocopenapistarterwebmvcuibehindareverseproxy Controller的繼承 Spring Controller的 @ 標記 Annotation ，其實支援繼承的。經Spring 生成的 api docs，也有如何效果。例如以下程式碼 public class ParentController @GetMappingquot;postfixquot; public String postfix return quot;this is postfixquot;; @RestController @RequestMappingquot;apiquot; public class ChildController extends ParentController @GetMappingquot;directquot; public String directCall return quot;direct resultquot;; 由於安全性問題，上述程式碼未能完整顯示，請參見文末完成Source Code 在ChildController的實例中，它會有兩個API，分別是 apidirect apiprefix 它支援Java Function Overwrite（覆寫），但不能改 @ 標記，以下就是一個錯的例子 @RestController @RequestMappingquot;apiquot; public class ChildController extends ParentController @GetMappingquot;Overwritequot; 把這個 @ 行刪了才能正常執行 public String postfix return quot;this is Overwritequot;; 由於安全性問題，上述程式碼未能完整顯示，請參見文末完成Source Code Source Code spring boot web api doc