如何寫出優質 PHP 代碼:10 大良好編程習慣與最佳實務
代碼品質決定專案維護成本。遵循良好習慣能提升模組化、可讀性、安全性與效能。
- 模組化代碼:善用 OOP、MVC、服務層、資源庫模式,將業務邏輯與表現層分離,單一職責原則。
- 統一編碼規範:遵循 PSR-1/PSR-12,命名風格、縮排、大括號位置一致,使用 PHP_CodeSniffer 自動檢查。
- 可移植代碼:不依賴
short_open_tag、magic_quotes 等已棄用特性,明確宣告相依套件。
- 安全第一:深入理解 XSS、CSRF、SQL Injection、檔案上傳漏洞,使用
htmlspecialchars、Prepared Statement、CSRF Token、驗證上傳檔案型別。
- 完善註解:類別、方法、複雜邏輯加上 PHPDoc 註解,說明參數、回傳、拋出異常、副作用。
- 避免短標籤:統一使用
<?php ... ?>,確保跨伺服器相容。
- 單引號優先:靜態字串用單引號,避免雙引號掃描變數的微小開銷。
- 輸出轉義:
htmlspecialchars($str, ENT_QUOTES, 'UTF-8') 確保單雙引號皆轉義。
- 逗號輸出多字串:
echo 'a', 'b', $var; 比連接運算子 . 稍快,且避免臨時字串分配。
- 輸出前驗證輸入:
isset($_GET['q']) / empty() / filter_input() 確保變數存在且符合預期。
額外建議
- 使用 Composer 管理相依、自動載入
- 引入靜態分析工具:PHPStan、Psalm
- 撰寫單元測試(PHPUnit)、功能測試
- 部署流程自動化(CI/CD)、程式碼審查
- 定期重構、清理技術債
好代碼不是寫出來的,是重構出來的。從今天開始踐行這 10 點,代碼品質將顯著提升。