PHP的PSR-2編碼風格規範的詳細介紹（程式碼）

這篇文章帶給大家的內容是關於PHP的PSR-2編碼風格規範的詳細介紹（代碼），有一定的參考價值，有需要的朋友可以參考一下，希望對你有所幫助。

接下來是PSR-2 程式設計風格規範，它是 PSR-1 基本程式碼規範的繼承與擴充。

PSR-1 和PSR-2是PHP開發中基本的編碼規範，大家其實都可以參考學習下，雖然說每個開發者都有自己熟悉的一套開發規範，但我覺得還是根據業界標準來編寫我們的程式碼，畢竟標準都是經過驗證的了。希望能對PHP開發者有幫助。

1、概覽

程式碼 必須 遵循 [PSR-1]() 中的編碼規格 。

程式碼 必須 使用4個空格符號而不是「Tab 鍵」來縮排。

每行的字元數 應該 軟性維持在 80 個之內，理論上 一定不可 多於 120 個，但 一定不可 有硬性限制。

每個 namespace 命名空間宣告語句和 use 宣告語句區塊後面，必須 插入一個空白行。

類別的開始花括號（{） 必須 寫在類別宣告後自成一行，結束花括號（}）也 必須 寫在類別主體後面自成一行。

方法的開始花括號（{） 必須 寫在函數宣告後自成一行，結束花括號（}）也 必須 寫在函數主體後自成一行。

類別的屬性和方法 必須 新增存取修飾符（private、protected 以及 public），abstract 以及 final 必須 聲明在存取修飾符之前，而 static 必須 聲明在存取修飾符之後。

控制結構的關鍵字後 必須 要有一個空格符，而呼叫方法或函數時則 一定不可 有。

控制結構的開始花括號（{） 必須 寫在宣告的同一行，而結束花括號（}） 必須 寫在主體後面自成一行。

控制結構的開始左括號後和結束右括號前，都 一定不可 有空格符號。

1.1. 範例

以下範例程式簡單地展示了上述大部分規格：

<?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()
 {
 // 方法的内容
 }
}

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 也 必須 全部小寫。

3. namespace 以及 use 宣告

namespace 宣告後 必須 插入一個空白行。

所有 use 必須 在 namespace 後宣告。

每條 use 宣告語句 必須 只有一個 use 關鍵字。

use 宣告語句區塊後 必須 要有一個空白行。

例如：

<?php

namespace Vendor\Package;
use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;

4. 類別、屬性和方法

此處的「類別」泛指所有的「類類別」、“介面」以及「traits 可重複使用程式碼區塊」。

4.1. 擴充與繼承

關鍵字 extends 和 implements 必須 寫在類別名稱的同一行。

類別的開始花括號 必須 獨佔一行，結束花括號也 必須 在類別主體後面獨佔一行。

<?php
namespace Vendor\Package;
use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;
class ClassName extends ParentClass implements \ArrayAccess, \Countable
{
 // 这里面是常量、属性、类方法
}

implements 的繼承清單也 可以 分成多行，這樣的話，每個繼承介面名稱都 必須 分開獨立成行，包括第一個。

<?php

namespace Vendor\Package;
use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;
class ClassName extends ParentClass implements
 \ArrayAccess,
 \Countable,
 \Serializable
{
 // 这里面是常量、属性、类方法
}

4.2. 屬性

每個屬性都 必須 新增存取修飾符。

一定不可 使用關鍵字 var 宣告一個屬性。

每条语句 一定不可 定义超过一个属性。

不该 使用下划线作为前缀，来区分属性是 protected 或 private。

以下是属性声明的一个范例：

<?php
namespace Vendor\Package;
class ClassName
{
 public $foo = null;
}

4.3方法

所有方法都 必须 添加访问修饰符。

不该 使用下划线作为前缀，来区分方法是 protected 或 private。

方法名称后 一定不可 有空格符，其开始花括号 必须 独占一行，结束花括号也 必须 在方法主体后单独成一行。参数左括号后和右括号前 一定不可 有空格。

一个标准的方法声明可参照以下范例，留意其括号、逗号、空格以及花括号的位置。

<?php
namespace Vendor\Package;
class ClassName
{
 public function fooBarBaz($arg1, &$arg2, $arg3 = [])
 {
 // method body
 }
}

4.4. 方法的参数

参数列表中，每个逗号后面 必须 要有一个空格，而逗号前面 一定不可 有空格。

有默认值的参数，必须 放到参数列表的末尾。

<?php
namespace Vendor\Package;
class ClassName
{
 public function foo($arg1, &$arg2, $arg3 = [])
 {
 // method body
 }
}

参数列表 可以 分列成多行，这样，包括第一个参数在内的每个参数都 必须 单独成行。

拆分成多行的参数列表后，结束括号以及方法开始花括号 必须 写在同一行，中间用一个空格分隔。

<?php
namespace Vendor\Package;
class ClassName
{
 public function aVeryLongMethodName(
 ClassTypeHint $arg1,
 &$arg2,
 array $arg3 = []
 ) {
 // 方法的内容
 }
}

4.5. abstract 、 final 、 以及 static

需要添加 abstract 或 final 声明时，必须 写在访问修饰符前，而 static 则 必须 写在其后。

<?php
namespace Vendor\Package;
abstract class ClassName
{
 protected static $foo;
 abstract protected function zim();
 final public static function bar()
 {
 // method body
 }
}

4.6. 方法及函数调用

方法及函数调用时，方法名或函数名与参数左括号之间 一定不可 有空格，参数右括号前也 一定不可 有空格。每个参数前 一定不可 有空格，但其后 必须 有一个空格。

<?php
bar();
$foo->bar($arg1);
Foo::bar($arg2, $arg3);
参数 可以 分列成多行，此时包括第一个参数在内的每个参数都 必须 单独成行。
<?php
$foo->bar(
 $longArgument,
 $longerArgument,
 $muchLongerArgument
);

5. 控制结构

控制结构的基本规范如下：

• 控制结构关键词后 必须 有一个空格。

• 左括号 ( 后 一定不可 有空格。

• 右括号 ) 前也 一定不可 有空格。

• 右括号 ) 与开始花括号 { 间 必须 有一个空格。

• 结构体主体 必须 要有一次缩进。

• 结束花括号 } 必须 在结构体主体后单独成行。

每个结构体的主体都 必须 被包含在成对的花括号之中，

这能让结构体更加结构话，以及减少加入新行时，出错的可能性。

5.1. if 、elseif 和 else

标准的 if 结构如下代码所示，请留意「括号」、「空格」以及「花括号」的位置，

注意 else 和 elseif 都与前面的结束花括号在同一行。

<?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
switch ($expr) {
 case 0:
 echo &#39;First case, with a break&#39;;
 break;
 case 1:
 echo &#39;Second case, which falls through&#39;;
 // no break
 case 2:
 case 3:
 case 4:
 echo &#39;Third case, return instead of break&#39;;
 return;
 default:
 echo &#39;Default case&#39;;
 break;
}

5.3. while 和 do while

一个规范的 while 语句应该如下所示，注意其「括号」、「空格」以及「花括号」的位置。

<?php
while ($expr) {
 // structure body
}

标准的 do while 语句如下所示，同样的，注意其「括号」、「空格」以及「花括号」的位置。

<?php
do {
 // structure body;
} while ($expr);

5.4. for

标准的 for 语句如下所示，注意其「括号」、「空格」以及「花括号」的位置。

<?php
for ($i = 0; $i < 10; $i++) {
 // for body
}

5.5. foreach

标准的 foreach 语句如下所示，注意其「括号」、「空格」以及「花括号」的位置。

<?php
foreach ($iterable as $key => $value) {
 // foreach body
}

5.6. try, catch

标准的 try catch 语句如下所示，注意其「括号」、「空格」以及「花括号」的位置。

<?php
try {
 // try body
} catch (FirstExceptionType $e) {
 // catch body
} catch (OtherExceptionType $e) {
 // catch body
}

6. 闭包

闭包声明时，关键词 function 后以及关键词 use 的前后都 必须 要有一个空格。

开始花括号 必须 写在声明的同一行，结束花括号 必须 紧跟主体结束的下一行。

参数列表和变量列表的左括号后以及右括号前，一定不可 有空格。

参数和变量列表中，逗号前 一定不可 有空格，而逗号后 必须 要有空格。

闭包中有默认值的参数 必须 放到列表的后面。

标准的闭包声明语句如下所示，注意其「括号」、「空格」以及「花括号」的位置。

<?php
$closureWithArgs = function ($arg1, $arg2) {
 // body
};
$closureWithArgsAndVars = function ($arg1, $arg2) use ($var1, $var2) {
 // body
};

参数列表以及变量列表 可以 分成多行，这样，包括第一个在内的每个参数或变量都 必须 单独成行，而列表的右括号与闭包的开始花括号 必须 放在同一行。

以下几个例子，包含了参数和变量列表被分成多行的多情况。

<?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
$foo->bar(
 $arg1,
 function ($arg2) use ($var1) {
 // body
 },
 $arg3
);

【推荐课程：PHP视频教程】

以上是PHP的PSR-2編碼風格規範的詳細介紹（程式碼）的詳細內容。更多資訊請關注PHP中文網其他相關文章！