工程開發
java-coding-standards avatar

java-coding-standards

強制執行高品質 Java 17+ 編碼標準、Spring Boot 慣例以及可維護的專案架構。

簡介

Java Coding Standards 技能為編寫、審查和維護 Spring Boot 服務中的乾淨、可擴展代碼提供了完整的框架。專為使用 Java 17 或更高版本的開發人員設計,它確保了命名慣例、異常處理和現代語言功能使用的統一性。透過優先考慮清晰度和不變性,此技能可幫助團隊減少技術債並建立更強大、可觀察的後端系統。無論您是構建新的微服務還是重構舊組件,此工具都能作為自動化架構指南,確保代碼保持地道、類型安全且適合生產環境。

  • 強制執行嚴格的類別、記錄和方法命名慣例,以及清晰的 PascalCase 和 camelCase 標準。

  • 透過鼓勵使用 Java records、final 欄位以及避免共享可變狀態來提升不變性。

  • 提供現代 Java 功能的最佳實踐,包括有效的 Optional 處理、Stream 管道和模式匹配。

  • 指導 Maven 和 Gradle 專案結構,將其劃分為 config、controller、service、repository 和 dto 等邏輯領域。

  • 設定明確的錯誤管理期望,優先使用領域特定的未檢查異常和有意義的日誌模式。

  • 支援與 JUnit 5、AssertJ 和 Mockito 的整合,以促進確定性、流暢且易於維護的單元測試。

  • 在開發過程中,使用此技能根據標準專案結構驗證方法簽章和套件配置。

  • 輸入您的代碼片段或拉取請求,以獲取有關長參數列表、深度巢狀或魔術數字等反模式的回饋。

  • 在同行評審中將此作為基準,以確保 Bean Validation、nullable 註解和依賴注入的一致使用。

  • 此技能強調 Java 17+ 功能;舊版本可能需要進行特定調整。本技能假設採用標準 Spring Boot 生態系統;自訂框架可能需要進行微小的配置調整以符合建議的專案配置。

倉庫統計

Star 數
170,586
Fork 數
26,440
Open Issue 數
153
主要語言
JavaScript
預設分支
main
同步狀態
閒置
最近同步時間
2026年4月30日 上午10:39
在 GitHub 查看