PHP的PSR-2編碼風格規範的詳細介紹（程式碼）-php教程-PHP中文網

這篇文章帶給大家的內容是關於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中文網其他相關文章！