統一的命名規範是團隊協作、代碼審查、自動化工具 (靜態分析、IDE) 的基礎。本文整理 PHP 社區主流慣例 (PSR-12、PHP-FIG、主流框架) 並結合型別前綴習慣,提供可直接落地的命名標準。
| 可見性 | 命名風格 | 範例 |
| public | camelCase | $createdAt, $userName |
| protected | camelCase (可選 _ 前綴) | $cache, $_cache |
| private | camelCase + _ 前綴 (推薦) | $connection, $_eventDispatcher |
| static | SCREAMING_SNAKE_CASE | MAX_RETRY_COUNT, DEFAULT_TIMEOUT |
現代趨勢:PHP 8+ 推薦不加底線前綴,靠可見性關鍵字區分,配合 IDE 色彩區分。
四、變數命名 (含型別前綴體系)
型別前綴 (Hungarian Notation 變體) 在動態語言中仍有價值,特別是缺乏型別聲明的舊代碼庫。
| 型別 | 前綴 | 範例 | 說明 |
| string | str | $strMessage, $strJson | |
| array (一維) | a / arr | $aUsers, $arrIds | 單數名詞 |
| array (多維/關聯) | a / arr | $aUserData, $arrConfig | 複數名詞 |
| int / integer | n / int | $nCount, $intTotal | |
| float / double | f / flt | $fPrice, $fltRate | |
| bool / boolean | b / bln | $bActive, $blnEnabled | |
| object / class instance | p / obj | $pUser, $objService | p 為 pointer 習慣 |
| resource | rs / res | $rsConn, $resHandle | DB 連線、檔案句柄 |
| mixed / 未知 | mx / m | $mxResult, $mData | 函數回傳不確定型別 |
| callable / closure | fn / cb | $fnCallback, $cbHandler | |
| null 可為空 | ? (PHP 7.1+ 型別聲明) | ?string $name = null | 現代寫法優先 |
作用域前綴 (可選)
| 作用域 | 前綴 | 範例 |
| 全域變數 | g / g_ | $gConfig, $g_db |
| 靜態變數 | s / s_ | $sInstance, $s_cache |
| 參考/引用 | r / ref | $rStatus, $refData |
| 區域變數 | 無 (純 camelCase) | $userName, $totalCount |
五、常數命名
// 全域常數
define('APP_VERSION', '1.0.0');
define('DB_DEFAULT_HOST', '127.0.0.1');
// 類別常數
class Config {
public const MAX_UPLOAD_SIZE = 10 * 1024 * 1024;
public const ALLOWED_EXTENSIONS = ['jpg', 'png', 'gif'];
}
六、綜合實例:分頁服務
pDb = $pDb;
}
public function getPageData(int $nTotal, int $nPage = 1): array {
$nOffset = ($nPage - 1) * $this->nPerPage;
// SQL 查詢
$strSql = "SELECT * FROM users LIMIT {$nOffset}, {$this->nPerPage}";
$rsResult = $this->pDb->query($strSql);
$aRows = [];
while ($aRow = $rsResult->fetch()) {
$aRows[] = $aRow;
}
return [
'items' => $aRows,
'total' => $nTotal,
'per_page' => $this->nPerPage,
'current_page' => $nPage,
];
}
}
// 使用範例
$pDb = new Connection('mysql:host=localhost;dbname=app', 'user', 'pass');
$pPager = new BluePage($pDb);
$nTotal = (int)$pDb->query("SELECT COUNT(*) FROM users")->fetchColumn();
$aPageData = $pPager->getPageData($nTotal, 2);
七、現代 PHP 型別系統整合 (PHP 7.4+)
優先使用型別聲明替代前綴:
// 舊式:前綴標示型別
function calculateTotal(array $aItems, float $fTaxRate): float { ... }
// 新式:型別聲明 + 清晰命名
function calculateOrderTotal(array $items, float $taxRate): float { ... }
// 屬性型別聲明
class Order {
public int $id;
public string $customerEmail;
public float $totalAmount;
public bool $isPaid;
public ?DateTime $paidAt = null; // 可為 null
/** @var User[] */
public array $items = [];
}
八、工具強制規範
- PHP_CodeSniffer +
phpcs.xml (PSR-12 標準)
- PHP-CS-Fixer 自動修復
- Psalm / PHPStan 靜態分析 (型別檢查、命名建議)
- IDE 設定:PhpStorm / VS Code (PHP Intelephense) 即時提示
總結
命名規範的核心目標是可讀性、可搜尋性、可維護性。現代 PHP 開發建議:
- 類別/方法/屬性遵循 PSR-12 (PascalCase/camelCase)
- 盡量使用型別聲明替代匈牙利前綴
- 專案內統一風格,納入 CI/CD 檢查
- 重構舊代碼時逐步遷移至現代規範
copyright ©
萬盛學電腦網 all rights reserved