Java 代碼編寫規範：打造高質量、可維護的專業項目

核心原則

良好的代碼規範不僅關乎美觀，更直接影響項目的可讀性、可移植性、性能及團隊協作效率。以下規範涵蓋命名、格式化、性能優化、測試等關鍵維度。

1. 變量與成員定義

• 成員變量：優先使用 protected，避免繼承類直接依賴內部實現，保護封裝性。
• 數組聲明：統一使用 int[] packets 風格，拒絕 int packets[]（C 風格）。
• 區分作用域：在構造器、Setter 中明確使用 this.field = param，消除變量遮蔽歧義。

2. 可讀性與可維護性

• 消除魔術數字：用常量或枚舉替代硬編碼數值（如 MAX_RETRY = 3）。
• 拒絕花俏技巧：清晰直白優於炫技；相關邏輯集中放置，減少跳轉認知負荷。
• 換行處理：優先用 println() 或 System.lineSeparator()，避免硬編碼 \n 導致跨平台顯示異常。
• 棄用 PrintStream：改用 PrintWriter，避免編碼轉換問題。

3. 排版與格式化（強制執行）

• 關鍵字/操作符前後加空格（if (a == b)）。
• 邏輯塊之間空行分隔；長語句在低優先級操作符處換行，操作符置行首。
• 一行一句：嚴禁多語句同行。
• 縮進統一 4 空格；{ 和 } 獨佔一行，與所屬語句左對齊（K&R 風格變體）。

4. 性能意識（貫穿開發全程）

• 循環中避免創建對象：移至循環外復用，或使用對象池。
• 字符串拼接用 StringBuffer/StringBuilder：String 不可變，頻繁拼接產生大量臨時對象，拖垮 GC。
• 謹慎用 synchronized：僅在必要時同步，縮小鎖範圍，防死鎖；JBuilder 等舊版 IDE 在同步塊斷點調試有已知缺陷。
• 若無法立即實現高效算法，務必在註釋標註 TODO: optimize，技術債務可視化。

5. 測試與維護底線

1. 單元測試覆蓋率達到語句級（Statement Coverage）。
2. 新代碼必須逐行跟蹤，觀察數據流與變量變化。
3. 重構/優化後的代碼強制經過 Code Review 並回歸測試。
4. 版本升級前進行全量嚴格測試，杜絕「改一行、壞一片」。

工具化落地建議

將上述規範配置進 Checkstyle、SpotBugs、SonarQube 等靜態分析工具，接入 CI 流水線，實現「提交即檢查、合並即達標」。團隊定期審閱規範文檔，隨 JDK 版本演進（如 Java 17+ 的 Record、Pattern Matching）及時更新。

代碼是給人讀的，附帶能在機器上運行。規範不是束縛，而是團隊共識的最低保障——讓維護者（包括未來的你）能在最短時間理解意圖、安全修改、放心重構。