PHP編碼規范 · 3N編碼規范

PHP編碼規范 ============ [TOC] ## 概述本文檔摘錄自PHP互操作性框架制定小組（[PHP-FIG][]:PHP Framework Interoperability Group）制定的PHP編碼規范（[PSR][]:PHP Standards Recommendation）。目前官方已制定的規范包括以下6份文件： * [PSR-0][]（已棄用） * [PSR-1][] * [PSR-2][] * [PSR-2補充][] * [PSR-3][] * [PSR-4][] 關鍵詞 “必須”("MUST")、“一定不可/一定不能”("MUST NOT")、“需要”("REQUIRED")、 “將會”("SHALL")、“不會”("SHALL NOT")、“應該”("SHOULD")、“不該”("SHOULD NOT")、 “推薦”("RECOMMENDED")、“可以”("MAY")和”可選“("OPTIONAL")的詳細描述可參見 [RFC 2119][] 。 [PHP-FIG]: https://github.com/php-fig/ [PSR]: https://github.com/php-fig/fig-standards [RFC 2119]: http://www.ietf.org/rfc/rfc2119.txt [PSR-0]: https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-0-cn.md [PSR-1]: https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-1-basic-coding-standard-cn.md [PSR-2]: https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-2-coding-style-guide-cn.md [PSR-2補充]: https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-2-coding-style-guide-meta-cn.md [PSR-3]: https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-3-logger-interface-cn.md [PSR-4]: https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-4-autoloader-cn.md * * * * * ## [PSR-1][] 基本代碼規范本篇規范制定了代碼基本元素的相關標準，以確保共享的PHP代碼間具有較高程度的技術互通性。 ### 1. 概覽 -------------- - PHP代碼文件**必須**以 `<?php` 或 `<?=` 標簽開始； - PHP代碼文件**必須**以 `不帶BOM的 UTF-8` 編碼； - PHP代碼中**應該**只定義類、函數、常量等聲明，或其他會產生 `從屬效應` 的操作（如：生成文件輸出以及修改.ini配置文件等），二者只能選其一； - 命名空間以及類**必須**符合 PSR 的自動加載規范：[PSR-0][] 或 [PSR-4][] 中的一個； - 類的命名**必須**遵循 `StudlyCaps` 大寫開頭的駝峰命名規范； - 類中的常量所有字母都**必須**大寫，單詞間用下劃線分隔； - 方法名稱**必須**符合 `camelCase` 式的小寫開頭駝峰命名規范。 ### 2. 文件 -------- #### 2.1. PHP標簽 PHP代碼**必須**使用 `<?php ?>` 長標簽或 `<?= ?>` 短輸出標簽； **一定不可**使用其它自定義標簽。 #### 2.2. 字符編碼 PHP代碼**必須**且只可使用`不帶BOM的UTF-8`編碼。 > BOM（Byte Order Mark，即字節序標記）。 > UTF-8編碼的文件中，BOM占三個字節。 > PHP在設計時就沒有考慮BOM的問題，也就是說他不會忽略UTF-8編碼的文件開頭BOM的那三個字符。 #### 2.3. 從屬效應（副作用）一份PHP文件中**應該**要不就只定義新的聲明，如類、函數或常量等不產生從屬效應的操作，要不就只有會產生從屬效應的邏輯操作，但**不該**同時具有兩者。 “從屬效應”(side effects)一詞的意思是，僅僅通過包含文件，不直接聲明類、函數和常量等，而執行的邏輯操作。 “從屬效應”包含卻不僅限于：生成輸出、直接的 `require` 或 `include`、連接外部服務、修改 ini 配置、拋出錯誤或異常、修改全局或靜態變量、讀或寫文件等。以下是一個反例，一份包含聲明以及產生從屬效應的代碼： ```php <?php // 從屬效應：修改 ini 配置 ini_set('error_reporting', E_ALL); // 從屬效應：引入文件 include "file.php"; // 從屬效應：生成輸出 echo "<html>\n"; // 聲明函數 function foo() { // 函數主體部分 } ``` 下面是一個范例，一份只包含聲明不產生從屬效應的代碼： ```php <?php // 聲明函數 function foo() { // 函數主體部分 } // 條件聲明**不**屬于從屬效應 if (! function_exists('bar')) { function bar() { // 函數主體部分 } } ``` ### 3. 命名空間和類 ---------------------------- 命名空間以及類的命名必須遵循 [PSR-0][]. 根據規范，每個類都獨立為一個文件，且命名空間至少有一個層次：頂級的組織名稱（vendor name）。類的命名必須遵循 `StudlyCaps` 大寫開頭的駝峰命名規范。 PHP 5.3及以后版本的代碼**必須**使用正式的命名空間。例如： ```php <?php // PHP 5.3及以后版本的寫法 namespace Vendor\Model; class Foo { } ``` 5.2.x及之前的版本**應該**使用偽命名空間的寫法，約定俗成使用頂級的組織名稱（vendor name）如 `Vendor_` 為類前綴。 ```php <?php // 5.2.x及之前版本的寫法 class Vendor_Model_Foo { } ``` ### 4. 類的常量、屬性和方法 -------------------------- 此處的“類”指代所有的類、接口以及可復用代碼塊（traits） #### 4.1. 常量類的常量中所有字母都**必須**大寫，詞間以下劃線分隔。參照以下代碼： ```php <?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()` 式的小寫開頭駝峰命名規范。 * * * * * ## [PSR-2][] 代碼風格規范本篇規范是 [PSR-1][] 基本代碼規范的繼承與擴展。本規范希望通過制定一系列規范化PHP代碼的規則，以減少在瀏覽不同作者的代碼時，因代碼風格的不同而造成不便。當多名程序員在多個項目中合作時，就需要一個共同的編碼規范，而本文中的風格規范源自于多個不同項目代碼風格的共同特性，因此，本規范的價值在于我們都遵循這個編碼風格，而不是在于它本身。 ### 1. 概覽 ----------- - 代碼**必須**遵循 [PSR-1][] 中的編碼規范。 - 代碼**必須**使用4個空格符而不是 tab鍵進行縮進。 - 每行的字符數**應該**軟性保持在80個之內，理論上**一定不可**多于120個，但**一定不能**有硬性限制。 - 每個 `namespace` 命名空間聲明語句和 `use` 聲明語句塊后面，**必須**插入一個空白行。 - 類的開始花括號(`{`)**必須**寫在函數聲明后自成一行，結束花括號(`}`)也**必須**寫在函數主體后自成一行。 - 方法的開始花括號(`{`)**必須**寫在函數聲明后自成一行，結束花括號(`}`)也**必須**寫在函數主體后自成一行。 - 類的屬性和方法**必須**添加訪問修飾符（`private`、`protected` 以及 `public`）， `abstract` 以及 `final` **必須**聲明在訪問修飾符之前，而 `static` **必須**聲明在訪問修飾符之后。 - 控制結構的關鍵字后**必須**要有一個空格符，而調用方法或函數時則**一定不能**有。 - 控制結構的開始花括號(`{`)**必須**寫在聲明的同一行，而結束花括號(`}`)**必須**寫在主體后自成一行。 - 控制結構的開始左括號后和結束右括號前，都**一定不能**有空格符。 #### 1.1. 例子以下例子程序簡單地展示了以上大部分規范： ```php <?php namespace Vendor\Package; use FooInterface; use BarClass as Bar; use OtherVendor\OtherPackage\BazClass; class Foo extends Bar implements FooInterface { public function sampleFunction($a, $b = null) { if ($a === $b) { bar(); } elseif ($a > $b) { $foo->bar($arg1); } else { BazClass::bar($arg2, $arg3); } } final public static function bar() { // method body } } ``` ### 2. 通則 ---------- #### 2.1 基本編碼準則代碼**必須**符合 [PSR-1][] 中的所有規范。 #### 2.2 文件所有PHP文件**必須**使用`Unix LF (linefeed)`作為行的結束符。所有PHP文件**必須**以一個空白行作為結束。純PHP代碼文件**必須**省略最后的 `?>` 結束標簽。 #### 2.3. 行行的長度**一定不能**有硬性的約束。軟性的長度約束**一定**要限制在120個字符以內，若超過此長度，帶代碼規范檢查的編輯器**一定**要發出警告，不過**一定不可**發出錯誤提示。每行**不應該**多于80個字符，大于80字符的行**應該**折成多行。非空行后**一定不能**有多余的空格符。空行**可以**使得閱讀代碼更加方便以及有助于代碼的分塊。每行**一定不能**存在多于一條語句。 #### 2.4. 縮進代碼**必須**使用4個空格符的縮進，**一定不能**用 tab鍵。 > 備注: 使用空格而不是tab鍵縮進的好處在于， > 避免在比較代碼差異、打補丁、重閱代碼以及注釋時產生混淆。 > 并且，使用空格縮進，讓對齊變得更方便。 #### 2.5. 關鍵字以及 True/False/Null PHP所有 [關鍵字][]**必須**全部小寫。常量 `true` 、`false` 和 `null` 也**必須**全部小寫。 [關鍵字]: http://php.net/manual/en/reserved.keywords.php ### 3. namespace 以及 use 聲明 --------------------------------- `namespace` 聲明后必須插入一個空白行。所有 `use` 必須在 `namespace` 后聲明。每條 `use` 聲明語句必須只有一個 `use` 關鍵詞。 `use` 聲明語句塊后必須要有一個空白行。例如： ```php <?php namespace Vendor\Package; use FooClass; use BarClass as Bar; use OtherVendor\OtherPackage\BazClass; // ... additional PHP code ... ``` ### 4. 類、屬性和方法 ----------------------------------- 此處的“類”泛指所有的class類、接口以及traits可復用代碼塊。 #### 4.1. 擴展與繼承關鍵詞 `extends` 和 `implements`**必須**寫在類名稱的同一行。類的開始花括號**必須**獨占一行，結束花括號也**必須**在類主體后獨占一行。 ```php <?php namespace Vendor\Package; use FooClass; use BarClass as Bar; use OtherVendor\OtherPackage\BazClass; class ClassName extends ParentClass implements \ArrayAccess, \Countable { // constants, properties, methods } ``` `implements` 的繼承列表也**可以**分成多行，這樣的話，每個繼承接口名稱都**必須**分開獨立成行，包括第一個。 ```php <?php namespace Vendor\Package; use FooClass; use BarClass as Bar; use OtherVendor\OtherPackage\BazClass; class ClassName extends ParentClass implements \ArrayAccess, \Countable, \Serializable { // constants, properties, methods } ``` #### 4.2. 屬性每個屬性都**必須**添加訪問修飾符。 **一定不可**使用關鍵字 `var` 聲明一個屬性。每條語句**一定不可**定義超過一個屬性。 **不要**使用下劃線作為前綴，來區分屬性是 protected 或 private。以下是屬性聲明的一個范例： ```php <?php namespace Vendor\Package; class ClassName { public $foo = null; } ``` #### 4.3. 方法所有方法都**必須**添加訪問修飾符。 **不要**使用下劃線作為前綴，來區分方法是 protected 或 private。方法名稱后**一定不能**有空格符，其開始花括號**必須**獨占一行，結束花括號也**必須**在方法主體后單獨成一行。參數左括號后和右括號前**一定不能**有空格。一個標準的方法聲明可參照以下范例，留意其括號、逗號、空格以及花括號的位置。 ```php <?php namespace Vendor\Package; class ClassName { public function fooBarBaz($arg1, &$arg2, $arg3 = []) { // method body } } ``` #### 4.4. 方法的參數參數列表中，每個逗號后面**必須**要有一個空格，而逗號前面**一定不能**有空格。有默認值的參數，**必須**放到參數列表的末尾。 ```php <?php namespace Vendor\Package; class ClassName { public function foo($arg1, &$arg2, $arg3 = []) { // method body } } ``` 參數列表**可以**分列成多行，這樣，包括第一個參數在內的每個參數都**必須**單獨成行。拆分成多行的參數列表后，結束括號以及方法開始花括號必須寫在同一行，中間用一個空格分隔。 ```php <?php namespace Vendor\Package; class ClassName { public function aVeryLongMethodName( ClassTypeHint $arg1, &$arg2, array $arg3 = [] ) { // method body } } ``` #### 4.5. `abstract` 、 `final` 、以及 `static` 需要添加 `abstract` 或 `final` 聲明時， **必須**寫在訪問修飾符前，而 `static` 則**必須**寫在其后。 ```php <?php namespace Vendor\Package; abstract class ClassName { protected static $foo; abstract protected function zim(); final public static function bar() { // method body } } ``` #### 4.6. 方法及函數調用方法及函數調用時，方法名或函數名與參數左括號之間**一定不能**有空格，參數右括號前也 **一定不能**有空格。每個參數前**一定不能**有空格，但其后**必須**有一個空格。 ```php <?php bar(); $foo->bar($arg1); Foo::bar($arg2, $arg3); ``` 參數**可以**分列成多行，此時包括第一個參數在內的每個參數都**必須**單獨成行。 ```php <?php $foo->bar( $longArgument, $longerArgument, $muchLongerArgument ); ``` ### 5. 控制結構 --------------------- 控制結構的基本規范如下： - 控制結構關鍵詞后**必須**有一個空格。 - 左括號 `(` 后**一定不能**有空格。 - 右括號 `)` 前也**一定不**能有空格。 - 右括號 `)` 與開始花括號 `{` 間**一定**有一個空格。 - 結構體主體**一定**要有一次縮進。 - 結束花括號 `}` **一定**在結構體主體后單獨成行。每個結構體的主體都**必須**被包含在成對的花括號之中，這能讓結構體更加結構化，以及減少加入新行時，出錯的可能性。 #### 5.1. `if` 、 `elseif` 和 `else` 標準的 `if` 結構如下代碼所示，留意括號、空格以及花括號的位置，注意 `else` 和 `elseif` 都與前面的結束花括號在同一行。 ```php <?php if ($expr1) { // if body } elseif ($expr2) { // elseif body } else { // else body; } ``` **應該**使用關鍵詞 `elseif` 代替所有 `else if` ，以使得所有的控制關鍵字都像是單獨的一個詞。 #### 5.2. `switch` 和 `case` 標準的 `switch` 結構如下代碼所示，留意括號、空格以及花括號的位置。 `case` 語句**必須**相對 `switch` 進行一次縮進，而 `break` 語句以及 `case` 內的其它語句都必須相對 `case` 進行一次縮進。如果存在非空的 `case` 直穿語句，主體里必須有類似 `// no break` 的注釋。 ```php <?php switch ($expr) { case 0: echo 'First case, with a break'; break; case 1: echo 'Second case, which falls through'; // no break case 2: case 3: case 4: echo 'Third case, return instead of break'; return; default: echo 'Default case'; break; } ``` #### 5.3. `while` 和 `do while` 一個規范的 `while` 語句應該如下所示，注意其括號、空格以及花括號的位置。 ```php <?php while ($expr) { // structure body } ``` 標準的 `do while` 語句如下所示，同樣的，注意其括號、空格以及花括號的位置。 ```php <?php do { // structure body; } while ($expr); ``` #### 5.4. `for` 標準的 `for` 語句如下所示，注意其括號、空格以及花括號的位置。 ```php <?php for ($i = 0; $i < 10; $i++) { // for body } ``` #### 5.5. `foreach` 標準的 `foreach` 語句如下所示，注意其括號、空格以及花括號的位置。 ```php <?php foreach ($iterable as $key => $value) { // foreach body } ``` #### 5.6. `try`, `catch` 標準的 `try catch` 語句如下所示，注意其括號、空格以及花括號的位置。 ```php <?php try { // try body } catch (FirstExceptionType $e) { // catch body } catch (OtherExceptionType $e) { // catch body } ``` ### 6. 閉包 ----------- 閉包聲明時，關鍵詞 `function` 后以及關鍵詞 `use` 的前后都**必須**要有一個空格。開始花括號**必須**寫在聲明的同一行，結束花括號**必須**緊跟主體結束的下一行。參數列表和變量列表的左括號后以及右括號前，**必須不能**有空格。參數和變量列表中，逗號前**必須不能**有空格，而逗號后**必須**要有空格。閉包中有默認值的參數**必須**放到列表的后面。標準的閉包聲明語句如下所示，注意其括號、逗號、空格以及花括號的位置。 ```php <?php $closureWithArgs = function ($arg1, $arg2) { // body }; $closureWithArgsAndVars = function ($arg1, $arg2) use ($var1, $var2) { // body }; ``` 參數列表以及變量列表**可以**分成多行，這樣，包括第一個在內的每個參數或變量都**必須**單獨成行，而列表的右括號與閉包的開始花括號**必須**放在同一行。以下幾個例子，包含了參數和變量列表被分成多行的多情況。 ```php <?php $longArgs_noVars = function ( $longArgument, $longerArgument, $muchLongerArgument ) { // body }; $noArgs_longVars = function () use ( $longVar1, $longerVar2, $muchLongerVar3 ) { // body }; $longArgs_longVars = function ( $longArgument, $longerArgument, $muchLongerArgument ) use ( $longVar1, $longerVar2, $muchLongerVar3 ) { // body }; $longArgs_shortVars = function ( $longArgument, $longerArgument, $muchLongerArgument ) use ($var1) { // body }; $shortArgs_longVars = function ($arg) use ( $longVar1, $longerVar2, $muchLongerVar3 ) { // body }; ``` 注意，閉包被直接用作函數或方法調用的參數時，以上規則仍然適用。 ```php <?php $foo->bar( $arg1, function ($arg2) use ($var1) { // body }, $arg3 ); ```