PHP 編程五大良好習慣：寫出可維護、高效的代碼

優秀開發者與普通開發者的效率差距可達 10%-20%，核心在於編程習慣。良好習慣不僅提升開發效率，更能降低全生命周期維護成本（佔總成本 60%+）。本文總結五大關鍵習慣。

習慣一：使用良好的命名

目標：代碼如散文般易讀，無需註釋即可理解意圖。

反面教材

<?php
function getNBDay($d) {
    switch($d) {
        case 5: case 6: case 7: return 1;
        default: return ($d + 1);
    }
}
$day = 5;
$nextDay = getNBDay($day);
echo "Next day is: " . $nextDay . "\n";
?>

問題：getNBDay、$d、$nextDay 均無法傳達業務含義（是工作日？自然日？邏輯錯誤風險高）。

優化版

<?php
function getNextBusinessDay(int $currentDayOfWeek): int {
    // 5=五, 6=六, 7=日 → 下周一(1)
    if ($currentDayOfWeek >= 5) return 1;
    return $currentDayOfWeek + 1;
}

$today = 5; // 周五
$nextBusinessDay = getNextBusinessDay($today);
echo "Next business day is: " . $nextBusinessDay . "\n";

習慣二：分解為更小的單元

• 函數控制在 20-30 行以內
• 單一職責：一個函數只做一件事
• 提取重復邏輯為獨立函數/類
• 便於單元測試、複用、閱讀

習慣三：為代碼添加有效註釋

• 文檔註釋：類/函數/方法用 PHPDoc 格式說明用途、參數、返回值、異常
• 邏輯註釋：解釋「為什麼這樣做」而非「做了什麼」
• TODO/FIXME：標記待辦/已知問題
• 避免顯而易見的註釋（如 $i++; // i加1）

習慣四：處理錯誤條件

<?php
// 悪習：假設一切正常
$user = getUserById($id);
echo $user->name;

// 良習：防禦性編程
$user = getUserById($id);
if ($user === null) {
    throw new UserNotFoundException("User ID {$id} not found");
}
if (!$user->isActive()) {
    throw new UserInactiveException("User {$id} is inactive");
}
echo $user->name;

• 輸入驗證、邊界檢查、異常捕獲
• 使用異常而非錯誤碼/布爾返回值
• 提供有意義的錯誤信息便於排查

習慣五：切忌複製粘貼代碼

• DRY 原則：Don't Repeat Yourself
• 複製代碼意味著：Bug 需多處修復、邏輯變更需同步多處、理解成本倍增
• 重構手法：提取公共方法、使用繼承/組合、引入策略模式/模板方法模式

綜合示例：重構前後對比

重構前：200 行巨大函數，混雜 SQL、業務邏輯、HTML 輸出、錯誤處理

重構後：

class OrderService {
    public function processOrder(OrderDTO $dto): OrderResult {
        $this->validate($dto);
        $order = $this->createOrderEntity($dto);
        $this->calculatePricing($order);
        $this->persist($order);
        $this->notifyCustomer($order);
        return new OrderResult($order->id, 'success');
    }
    // 私有方法分別處理驗證、創建、定價、持久化、通知
}

習慣養成路徑

1. Code Review 互相檢查
2. 靜態分析工具（PHPStan, Psalm, PHP_CodeSniffer）
3. 閱讀優秀開源項目代碼（Laravel, Symfony 核心組件）
4. 刻意練習：每次提交前自我審查 5 分鐘

良好習慣是「複利投資」：前期付出額外精力，長期收獲指數級的維護性與擴展性紅利。