Java 開發者必守的 10 條鐵律：從代碼規範到工程素養

前言

知道規則不難，難的是始終如一地遵守。這 10 條鐵律涵蓋代碼質量、架構思維、工程習慣，是從「寫出代碼」到「交付產品」的分水嶺。

1. 給代碼加註釋 —— 給未來的自己與同事

• 類/接口/公共方法必須有 Javadoc：職責、參數、返回值、異常、副作用、線程安全性。
• 複雜邏輯、業務規則、演算法、臨時妥協（TODO/FIXME）需行內註釋。
• 註釋解釋「為什麼」，代碼本身說明「做什麼」。

2. 拒絕過度設計 —— 簡單優於複雜

• 5 用戶的系統不需要 EJB、微服務、複雜框架。
• YAGNI 原則：You Ain't Gonna Need It。當前不需要，就不引入。
• 為學習新技術而強行套用項目，是不專業的表現。

3. 「少即是多」不等於「寫最少行代碼」

可讀性 > 簡潔性。一個 20 行的清晰 if-else 鏈，優於 1 行嵌套三元運算符的「神代碼」。

// ❌ 縮減行數但難讀
if (condA && (condB || condC) && condD) doSomething();

// ✅ 拆分條件，命名中間變量，清晰表達業務含義
boolean eligible = condA && (condB || condC) && condD;
if (eligible) doSomething();

4. 消除魔法數值/字符串 —— 統一常量管理

// ❌ 硬編碼散落各處
if ("SD".equals(status) && (sellOffDate == null || today.before(sellOffDate))) ...

// ✅ 常量類集中管理
public class StatusConstants {
    public static final String STATUS_SD = "SD";
    public static final String STATUS_OBS = "OBS";
    public static final String STATUS_NYP = "NYP";
}
// 使用
if (STATUS_SD.equals(status) && (sellOffDate == null || today.before(sellOffDate))) ...

修改時只需改一處，IDE 重構安全可靠。

5. 不要重複造輪子 —— 善用成熟框架/庫

• Web 框架：Spring Boot、Spring MVC、Struts（歷史）。
• 工具庫：Apache Commons、Guava、Hutool、Jackson、Lombok。
• 緩存：Caffeine、Redis、Ehcache。
• 連接池：HikariCP。
• 日誌：SLF4J + Logback/Log4j2。
• 但記住第 2 條：3 個頁面的系統不需要 Spring Boot。

6. 杜絕 System.out.println 與字符串拼接濫用

• 性能殺手：循環中 System.out.println 導致 10000 倍慢化；字符串 + 產生海量臨時對象。
• 規範做法：

// 日誌框架 + 等級控制
private static final Logger log = LoggerFactory.getLogger(MyClass.class);
if (log.isDebugEnabled()) log.debug("Processing item: {}", item); // 佔位符延遲拼接

// 字符串構建
StringBuilder sb = new StringBuilder();
for (int i = 0; i < 20; i++) sb.append(base);
String result = sb.toString();

7. 重視 GUI/用戶體驗 —— 不是「能用」就行

• 界面是產品的臉面，直接決定用戶留存與滿意度。
• 三原則：不重複造輪子（找成熟組件庫）、先做原型圖確認需求、戴上用戶帽子思考（而非開發者視角）。
• 前後端分離時代，後端也要關注 API 設計體驗（RESTful、錯誤碼、文檔）。

8. 需求文檔化 —— 無文檔無開發

• 無論多趕工，業務需求必須落筆成文（Wiki、Markdown、Confluence）。
• 文檔是溝通基線、驗收標準、維護指南、知識傳承載體。
• 敏捷不等於無文檔，輕量級文檔同樣有效。

9. 單元測試：不測試不提交

• 核心原則：先寫測試（TDD 理念），再寫實現。
• 覆蓋所有 public 方法、邊界條件、異常路徑、業務關鍵邏輯。
• Getter/Setter 除非有特殊邏輯否則可跳過。
• 測試代碼同樣要乾淨、可讀、可維護。

10. 質量第一，拒絕無效加班

• 管理者看重高質量交付，而非工時長短。
• 遵守前 9 條，自然產出少 Bug、易維護代碼，減少返工與加班。
• 可持續的工作節奏，才能長期產出優秀作品。

總結

這 10 條鐵律，前 5 條治代碼，中 3 條治工程，後 2 條治心態。內化為習慣，外化為品質，是從碼農到工程師的必經之路。