如果我告訴你有一個工具可以使你的Java項目中的「Spring」風格更加一致,那該怎麼辦?那就對了!Spring創建了一組可應用於任何Java項目的插件,並承諾提供一致的「Spring」樣式。讓我們仔細看看。
Spring為您提供了一個方便的工具,以確保您的Java項目具有一致的「Spring」風格!滿足Spring Java Format插件集!
該工具於今年5月發布,當前使用版本為0.0.6。
設置到這一點的插件包括:
應用包裝和空白約定的源格式化程序一個checkstyle插件,可以強制執行代碼庫的一致性該項目的目的是提供一致性,因此,每個插件通常不可配置。這意味著您需要更改代碼以匹配所需的約定,您無法配置插件約定以匹配您的樣式。
根據它的GitHub repo,大多數編碼約定和樣式來自Spring Framework和Spring Boot項目。Spring Framework手動格式化代碼,而Spring Boot使用自動格式化。
您應該記住的一件事是僅格式化和Checkstyle不足以產生真正一致的代碼。在這裡開發Spring Boot時,您可以找到一些有用的提示。
入門
如果您期待著它,我們來看看如何開始。
Maven的
對於源格式,請將其添加 spring-javaformat-maven-plugin 到 build 插件中:
而 io.spring.javaformat 在插件組 ~/.m2/settings.xml 如下:
您現在可以運行 ./mvnw spring-javaformat:apply 以重新格式化代碼。
Gadle的
對於源格式,請將其添加 spring-javaformat-gradle-plugin 到 build 插件中:
該插件添加 format 和 checkFormat 任務到項目中。在 checkFormat 運行標準的搖籃任務時自動應用 check 任務。
Eclipse的
使用Eclipse,只要在項目構建腳本中發現Maven或Gradle插件,就會自動激活插件。
如果您需要自定義插件應用的項目特定設置,則應.eclipse 在項目的根目錄中添加一個 文件夾。.prefs 此文件夾中的所有 文件都將複製到項目 .settings 文件夾中。通常你會提供自己的 org.eclipse.jdt.core.prefs 和 org.eclipse.jdt.ui.prefs 文件。
要安裝插件,您可以使用 io.spring.javaformat.eclipse.site zip文件。
IntelliJ IDEA的
與Eclipse案例非常相似,只要在項目構建腳本中發現Maven或Gradle插件,插件就會自動激活。Spring Java Format圖標(形成過程)也將顯示在狀態欄中,表示格式化程序處於活動狀態。您可以使用標準 code → reformat code 操作來格式化代碼。
要安裝插件,您可以使用 spring-javaformat-intellij-plugin jar文件。