【PHP開發規範】老生常談的編碼開發規範你懂多少？
【PHP開發規範】老生常談的編碼開發規範你懂多少？
這幾天看了一下阿裏技術發布的一套Java開發規範《阿裏巴巴Java開發手冊》，裏面寫了阿裏內部的Java開發規範標準，寫的很好。這套Java統一規範標準將有助於提高行業編碼規範化水平，幫助行業人員提高開發質量和效率、大大降低代碼維護成本。
看完我去搜下了一些PHP的一些開發規範標準，其中了解到了PSR規範是PHP行業中常用的一套開發標準。感嘆自己學得那麽少，標準的規範這麽晚才發現。
其實對於新手或者有幾年經驗的開發者來說，這些規範我們都要掌握的，很多時候我們做好這些規範，在協同開發中，能提高我們的開發質量和效率。
什麽是PSR？
PSR 是 PHP Standard Recommendations 的簡寫，由 PHP FIG 組織制定的 PHP 規範，是 PHP 開發的實踐標準。
PHP FIG目前已表決通過了 6 套標準，已經得到大部分 PHP 框架的支持和認可。
其中已經通過的有：
- PSR-1 基礎編碼規範
- PSR-2 編碼風格規範
- PSR-3 日誌接口規範
- PSR-4 自動加載規範
- PSR-6 緩存接口規範
- PSR-7 HTTP 消息接口規範
*註：其中PSR-0已被棄用，PSR-5還在起草中，以後再補充
這裏先介紹PSR-1 基礎編碼規範
1. 概覽
- PHP代碼文件 必須 以 <?php 或 <?= 標簽開始；
- PHP代碼文件 必須 以 不帶 BOM 的 UTF-8 編碼；
- PHP代碼中 應該 只定義類、函數、常量等聲明，或其他會產生 副作用 的操作（如：生成文件輸出以及修改 .ini 配置文件等），二者只能選其一；
- 命名空間以及類 必須 符合 PSR 的自動加載規範：[PSR-4]() 中的一個；
- 類的命名 必須 遵循 StudlyCaps 大寫開頭的駝峰命名規範；
- 類中的常量所有字母都 必須 大寫，單詞間用下劃線分隔；
- 方法名稱 必須 符合 camelCase 式的小寫開頭駝峰命名規範。
2. 文件
2.1. PHP標簽
PHP代碼 必須 使用 <?php ?> 長標簽 或 <?= ?> 短輸出標簽；
一定不可 使用其它自定義標簽。
2.2. 字符編碼
PHP代碼 必須 且只可使用 不帶BOM的UTF-8 編碼。（這點很重要）
2.3. 副作用
一份 PHP 文件中 應該 要不就只定義新的聲明，如類、函數或常量等不產生 副作用 的操作，要不就只書寫會產生 副作用 的邏輯操作，但 不該 同時具有兩者。
「副作用」(side effects) 一詞的意思是，僅僅通過包含文件，不直接聲明類、函數和常量等，而執行的邏輯操作。
「副作用」包含卻不僅限於：
- 生成輸出
- 直接的 require 或 include
- 連接外部服務
- 修改 ini 配置
- 拋出錯誤或異常
- 修改全局或靜態變量
- 讀或寫文件等
以下是一個 反例，一份包含「函數聲明」以及產生「副作用」的代碼：
<?php // 「副作用」：修改 ini 配置 ini_set(‘error_reporting‘, E_ALL); // 「副作用」：引入文件 include "file.php"; // 「副作用」：生成輸出 echo "<html>\n"; // 聲明函數 function foo() { // 函數主體部分 }
下面是一個範例，一份只包含聲明不產生「副作用」的代碼：
<?php // 聲明函數 function foo() { // 函數主體部分 } // 條件聲明 **不** 屬於「副作用」 if (! function_exists(‘bar‘)) { function bar() { // 函數主體部分 } }
3. 命名空間和類
命名空間以及類的命名必須遵循 [PSR-4]()。
根據規範，每個類都獨立為一個文件，且命名空間至少有一個層次：頂級的組織名稱（vendor name）。
類的命名 必須 遵循 StudlyCaps 大寫開頭的駝峰命名規範。
PHP 5.3 及以後版本的代碼 必須 使用正式的命名空間。
例如：
<?php // PHP 5.3及以後版本的寫法 namespace Vendor\Model; class Foo { }
5.2.x 及之前的版本 應該 使用偽命名空間的寫法，約定俗成使用頂級的組織名稱（vendor name）如 Vendor_ 為類前綴。
<?php // 5.2.x及之前版本的寫法 class Vendor_Model_Foo { }
4. 類的常量、屬性和方法
此處的「類」指代所有的類、接口以及可復用代碼塊（traits）。
4.1. 常量
類的常量中所有字母都 必須 大寫，詞間以下劃線分隔。
參照以下代碼：
<?php namespace Vendor\Model; class Foo { const VERSION = ‘1.0‘; const DATE_APPROVED = ‘2012-06-01‘; }
4.2. 屬性
類的屬性命名 可以 遵循：
- 大寫開頭的駝峰式 ($StudlyCaps)
- 小寫開頭的駝峰式 ($camelCase)
- 下劃線分隔式 ($under_score)
本規範不做強制要求，但無論遵循哪種命名方式，都 應該 在一定的範圍內保持一致。這個範圍可以是整個團隊、整個包、整個類或整個方法。
4.3. 方法
方法名稱 必須 符合 camelCase() 式的小寫開頭駝峰命名規範。
參考資料：
https://psr.phphub.org/
------------------------------------------------------------------------------
歡迎關註我的公眾號【phper的進階之路】，將不斷更新各種技術心得，免費提供各種學習資源！！！
【PHP開發規範】老生常談的編碼開發規範你懂多少？