Java 編碼規範全攻略：命名、格式、導入、類結構最佳實踐

命名規範

通用原則： 完整英文單詞 > 縮寫；避免長名稱（<15 字符）；避免相似名稱（如 data/date）；除常量外禁用下劃線。

代碼風格一致性

項目組必須統一風格（縮進、大括號位置、空格/Tab、行寬），個人偏好服從團隊規範。推薦採用 K&R 或 BSD 風格，縮進 4 空格（禁用 Tab），行寬 ≤ 80 字符。

文件結構組織

1. 文件頭說明（可選）
2. Package 聲明
3. 空行
4. Import 語句（分組：java.* → javax.* → 第三方 → 項目內部，組間空行）
5. 空行
6. 類/接口定義（Javadoc → 字段 → 構造器 → 方法 → 內部類 → main）

字段聲明順序

Public 常量 → Public 變量 → Protected 常量 → Protected 變量 → Package 常量 → Package 變量 → Private 常量 → Private 變量

其他關鍵細節

• 循環變量： 簡單循環用 i/j/k，嵌套層級深時用語義名。
• 流變量： in/out/inOut 對應 InputStream/OutputStream/雙向流。
• 集合變量： 用復數（customers）或修飾詞（allUsers）。
• 匈牙利命名法可選： 如 strName、iCount，團隊統一即可。

工具落地

配置 IDE（IntelliJ IDEA / Eclipse）代碼格式化模板、導入排序規則、命名檢查插件（Checkstyle、SpotBugs），將規範內化為提交前自動檢查，杜絕人工疏漏。