springboot~spring-javaformat插件惹的禍

来源:https://www.cnblogs.com/lori/archive/2023/06/27/17508762.html
-Advertisement-
Play Games

# 起因 我們在寫代碼時,有時間代碼過高,尤其是stream流的時間,可能有多個map,filter,sort組成,這樣我們更希望看到的是一種可讀性更好的風格 * 我的代碼是這樣的 ![](https://img2023.cnblogs.com/blog/118538/202306/118538-2 ...


起因

我們在寫代碼時,有時間代碼過高,尤其是stream流的時間,可能有多個map,filter,sort組成,這樣我們更希望看到的是一種可讀性更好的風格

  • 我的代碼是這樣的
  • 於是我手動將map進行了換行,想讓代碼更清晰一些
  • 我編碼之後,添加了手動換行,我習慣上會進行代碼統一格式化,idea里的ctrl+alt+L,這時,我發現我的換行沒了,又回去了
  • 於是我問了chatgpt,是否是自己配置的原因
在 IntelliJ IDEA 中手動修改代碼對齊並按回車換行後,如果在進行自動格式化後發現修改的部分被恢復,這可能是由於以下幾種情況導致的:

1. 自動格式化設置:檢查你的 IntelliJ IDEA 的自動格式化設置,確保它與你期望的格式化風格一致。你可以在 "Preferences"(或 "Settings")菜單中的 "Editor" -> "Code Style" 下找到相應的設置。確保選擇了適合你的編碼風格的選項,並且沒有啟用不希望的格式化功能(例如,"Reformat on file save")。

2. 代碼風格設置:如果你手動修改的代碼與當前項目的代碼風格設置不一致,自動格式化可能會覆蓋你的更改。在 "Preferences"(或 "Settings")菜單中的 "Editor" -> "Code Style" 中,選擇適合你的項目的代碼風格,並確保與你手動修改的代碼一致。

3. 編輯器行為設置:在 IntelliJ IDEA 的 "Preferences"(或 "Settings")菜單中,檢查 "Editor" -> "General" -> "Smart Keys" 設置。有些選項,如 "Reformat block on typing '}'" 或 "Keep when formatting",可能會影響自動格式化後的代碼。

4. 版本控制:如果你的項目使用了版本控制系統(如 Git),在進行提交或拉取操作時,IntelliJ IDEA 可能會根據版本控制的規則自動格式化代碼。這可能導致你手動修改的部分被恢復為代碼庫中的規範格式。

請檢查上述設置,並根據你的需求進行適當的調整,以確保代碼格式化的行為與你期望的一致。如果問題仍然存在,請提供更多的上下文信息,例如你手動修改的代碼示例和你的自動格式化設置,以便更好地幫助你解決問題。
  • 最後,我想起來,我使用了spring格式統一的代碼格式插件spring-javaformat,這個插件有兩個時機會觸發:
    • build項目時,會通過spring-javaformat去檢查你的代碼格式,不符合要求會提示你
    • 在編輯單個文件時,使用ctrl+alt+L進行代碼格式化時,這個插件也會把你代碼更新成符合它的格式
  • 我把這個插件刪除後,再執行一下格式化,問題就解決了,不過,我最後還是把spring-javaformat插件裝上了,因為這是一種統一的風格,我們應該去適應它和遵守它,因為它是一個標準化的方案

Spring Java Format

Spring Java Format是一個用於在Spring項目中格式化Java代碼的插件。它是基於Google的Java代碼格式化工具(google-java-format)開發的,專門用於與Spring框架的最佳實踐相匹配的代碼格式化。

Spring Java Format插件提供了與IDE(集成開發環境)集成的能力,例如在Eclipse和IntelliJ IDEA中使用。它可以自動格式化Java代碼,確保代碼風格的一致性和可讀性。

使用Spring Java Format插件,您可以定義代碼格式化規則,例如縮進大小、行長度、空格使用等。它還提供了一個命令行工具,可以在構建過程中自動格式化代碼。

要在Spring項目中使用Spring Java Format插件,您需要將其添加到項目的構建配置文件中。具體步驟可能因您使用的構建工具而有所不同。以下是一個使用Maven構建的示例:

  1. 在項目的pom.xml文件中,添加插件依賴:
<build>
    <plugins>
        <plugin>
            <groupId>io.spring.javaformat</groupId>
            <artifactId>spring-javaformat-maven-plugin</artifactId>
            <version>0.0.6</version>
            <executions>
                <execution>
                    <goals>
                        <goal>apply</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>
  1. 在命令行中運行以下命令,將項目中的Java代碼格式化:
mvn spring-javaformat:apply

這將使用Spring Java Format插件對項目中的Java代碼進行格式化。

請註意,具體的插件版本號可能會有所不同,請根據您使用的版本進行相應的配置。

除了Maven插件之外,Spring Java Format還提供了Gradle插件(spring-javaformat-gradle-plugin),您可以在Gradle項目中使用相似的方式進行配置和使用。

希望這可以幫助您瞭解Spring Java Format插件及其在Spring項目中的使用方式。如果您有任何其他問題,請隨時提問!

作者:倉儲大叔,張占嶺,
榮譽:微軟MVP
QQ:853066980

支付寶掃一掃,為大叔打賞!


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 一個小小的故障就可能造成巨大的負面影響,因此穩定性工作複雜卻又至關重要。本文將通過故障預防、修複、復盤來講解該如何建設一個穩定性體系。 來到阿裡後,我的工作內容一直都是商品中心的穩定性,這份工作對於我個人在技術和經驗上的成長提升是無比巨大的。在我看來,穩定性是一個極為複雜的工作,對人的能力考驗... ...
  • 斷路器能有效防止集成點、層疊失效、系統容量失衡和響應緩慢等危及穩定性的反模式出現,它能與超時模式緊密協作,跟蹤調用超時失敗 ...
  • ### 歡迎訪問我的GitHub > 這裡分類和彙總了欣宸的全部原創(含配套源碼):[https://github.com/zq2599/blog_demos](https://github.com/zq2599/blog_demos) ### 關於人臉識別 - 本文是《JavaCV人臉識別三部曲》 ...
  • 某日二師兄參加XXX科技公司的C++工程師開發崗位第27面: > 面試官:用過`std::set/std::map`嗎? > > 二師兄:用過。 > > 面試官:能介紹一下二者嗎? > > 二師兄:`std::set`是一個有序的集合,其中的元素是唯一的,即每個元素只能出現一次。一般用於去重和自動排 ...
  • ### 介紹 在平時做項目得時候,經常會看到很多包裡面定義了結構體。 e.g. 在`context`包裡面`Context`介面中的`Done()`方法,`Done()`返回一個是以空結構體定義數據的通道`chan struct{}`,那這裡他是有什麼特殊用意嗎?我們接下來分析`struct{}`的 ...
  • 幫一個客戶處理一個小程式bug修複,前面不知道客戶是直接購買一個倒閉的公司產品,還是破解版本的。 其中一些核心工具類代碼進行了加密,通過排查就找到了 Swoole Compiler 今天演示下如何進行代碼加密: 大致步驟 如下: 註冊 Swoole Compiler 賬號 地址:Swoole-Com ...
  • 在 C++11 中,可以使用 <chrono> 頭文件中的 std::chrono::system_clock 類來獲取當前時間戳。它提供了多種精度和解析度的時鐘類型,其中最常用的是系統時鐘。 以下是一個示常式序,演示如何使用 std::chrono::system_clock 類獲取當前毫秒數: ...
  • 摘要:在項目開發過程中,一個良好的項目結構對於團隊的協作和代碼的可維護性起著重要作用。通過使用自動生成項目結構文字樣式的工具。不僅節省了手動編寫項目結構的麻煩,還確保了結構的一致性和準確性。 本文分享自華為雲社區《【Python】自動化構建項目結構樣式》,作者: frica01。 引言 在使用 Py ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...