PSR-2 编码风格规范
PSR-2 编码风格规范
本篇规范是 PSR-1 基本代码规范的继承与扩展。
本规范希望通过制定一系列规范化 PHP 代码的规则，以减少在浏览不同作者的代码时，因代码风格的不同而造成不便。
当多名程序员在多个项目中合作时，就需要一个共同的编码规范， 而本文中的风格规范源自于多个不同项目代码风格的共同特性， 因此，本规范的价值在于我们都遵循这个编码风格，而不是在于它本身。
本文中的 必须，不得，需要，应，不应，应该，不应该，推荐，可以 和 可选 等能愿动词按照 RFC 2119 中的描述进行解释。
概览
- 代码 必须 遵循 PSR-1 中的编码规范 。
- 代码 必须 使用 4 个空格符而不是
Tab 键进行缩进。 - 每行的字符数 应该 软性保持在 80 个之内，理论上 不得 多于 120 个，但 不得 有硬性限制。
- 每个
namespace命名空间声明语句和use声明语句块后面，必须 插入一个空白行。 - 类的开始花括号
{必须 写在类声明后自成一行，结束花括号}也 必须 写在类主体后自成一行。 - 方法的开始花括号
{必须 写在函数声明后自成一行，结束花括号}也 必须 写在函数主体后自成一行。 - 类的属性和方法 必须 添加访问修饰符
private、protected以及public，abstract以及final必须 声明在访问修饰符之前，而static必须 声明在访问修饰符之后。 - 控制结构的关键字后 必须 要有一个空格符，而调用方法或函数时则 一定不可 有。
- 控制结构的开始花括号
{必须 写在声明的同一行，而结束花括号}必须 写在主体后自成一行。 - 控制结构的开始左括号后和结束右括号前，都 不得 有空格符。
例子
本示例将作为下文规则的快速概览：
1<?php
2namespace Vendor\Package;
3
4use FooInterface;
5use BarClass as Bar;
6use OtherVendor\OtherPackage\BazClass;
7
8class Foo extends Bar implements FooInterface
9{
10 public function sampleMethod($a, $b = null)
11 {
12 if ($a === $b) {
13 bar();
14 } elseif ($a > $b) {
15 $foo->bar($arg1);
16 } else {
17 BazClass::bar($arg2, $arg3);
18 }
19 }
20
21 final public static function bar()
22 {
23 // method body
24 }
25}通则
基本编码标准
代码 必须 符合 PSR-1 中的所有规范。
文件
- 所有 PHP 文件 必须 使用
Unix LF (linefeed)作为行的结束符。 - 所有 PHP 文件 必须 以一个空白行作为结束。
- 纯 PHP 代码文件 必须 省略最后的 ?> 结束标签。
行
- 行的长度 不得 有硬性的约束。
- 软性的长度约束 必须 要限制在 120 个字符以内，若超过此长度，带代码规范检查的编辑器 必须 要发出警告，不过 一定不可 发出错误提示。
- 每行 不该 多于 80 个字符，大于 80 字符的行 应该 折成多行。
- 非空行后 不得 有多余的空格符。
- 空行 可以 使得阅读代码更加方便以及有助于代码的分块。
- 每行 不得 存在多于一条语句。
缩进
代码 必须 使用 4 个空格来进行缩进， 并且 不得 使用 tab 键来缩进。
注：仅使用空格，而不是使用空格和 tab 键混在一起， 能帮助避免在查看代码差异，打补丁，查看提交历史，以及进行注解时产生问题。使用空格也使得代码对齐更轻松。
关键字与 True/False/Null
PHP 的 关键字 必须 使用小写形式。
PHP 的常量 true， false， 还有 null 必须 使用小写形式。
命名空间和使用声明
namespace声明之后 必须 存在一个空行。- 所有的
use声明 必须 位于namespace声明之后。 - 每条
use声明 必须 只有一个use关键字。 use语句块之后 必须 存在一个空行。
例如：
1<?php
2namespace Vendor\Package;
3
4use FooClass;
5use BarClass as Bar;
6use OtherVendor\OtherPackage\BazClass;
7
8// ... 其他 PHP 代码 ...类、属性和方法
此处的 类 泛指所有的 class 类 、接口(interface)以及 traits 可复用代码块。
扩展与继承
关键词 extends 和 implements 必须 写在类名称的同一行。
类的开始花括号 必须 独占一行，结束花括号也 必须 在类主体后独占一行。
1<?php
2namespace Vendor\Package;
3
4use FooClass;
5use BarClass as Bar;
6use OtherVendor\OtherPackage\BazClass;
7
8class ClassName extends ParentClass implements \ArrayAccess, \Countable
9{
10 // 这里面是常量、属性、类方法
11}implements 的继承列表也 可以 分成多行，这样的话，每个继承接口名称都 必须 分开独立成行，包括第一个。
1<?php
2namespace Vendor\Package;
3
4use FooClass;
5use BarClass as Bar;
6use OtherVendor\OtherPackage\BazClass;
7
8class ClassName extends ParentClass implements
9 \ArrayAccess,
10 \Countable,
11 \Serializable
12{
13 // 这里面是常量、属性、类方法
14}属性
- 每个属性都 必须 添加访问修饰符。
- 不得 使用关键字
var声明一个属性。 - 每条语句 不得 定义超过一个属性。
- 不该 使用下划线作为前缀，来区分属性是
protected或private。
以下是属性声明的一个范例：
1<?php
2namespace Vendor\Package;
3
4class ClassName
5{
6 public $foo = null;
7}方法
- 所有方法都 必须 添加访问修饰符。
- 不该 使用下划线作为前缀，来区分方法是
protected或private访问修饰符。 - 方法名称后 不得 有空格符，其开始花括号 必须 独占一行，结束花括号也 必须 在方法主体后单独成一行。参数左括号后和右括号前 不得 有空格。
一个标准的方法声明可参照以下范例，留意其括号、逗号、空格以及花括号的位置。
1<?php
2namespace Vendor\Package;
3
4class ClassName
5{
6 public function fooBarBaz($arg1, &$arg2, $arg3 = [])
7 {
8 // 方法主体
9 }
10}方法的参数
参数列表中，每个逗号后面 必须 要有一个空格，而逗号前面 不得 有空格。
有默认值的参数，必须 放到参数列表的末尾。
1<?php
2namespace Vendor\Package;
3
4class ClassName
5{
6 public function foo($arg1, &$arg2, $arg3 = [])
7 {
8 // 方法主体
9 }
10}参数列表 可以 分列成多行，这样，包括第一个参数在内的每个参数都 必须 单独成行。
拆分成多行的参数列表后，结束括号以及方法开始花括号 必须 写在同一行，中间用一个空格分隔。
1<?php
2namespace Vendor\Package;
3
4class ClassName
5{
6 public function aVeryLongMethodName(
7 ClassTypeHint $arg1,
8 &$arg2,
9 array $arg3 = []
10 ) {
11 // 方法主体
12 }
13}abstract, final, 和 static 关键字
需要添加 abstract 或 final 声明时，必须 写在访问修饰符前，而 static 则 必须 写在其后。
1<?php
2namespace Vendor\Package;
3
4abstract class ClassName
5{
6 protected static $foo;
7
8 abstract protected function zim();
9
10 final public static function bar()
11 {
12 // 方法主体
13 }
14}方法及函数调用
方法及函数调用时，方法名或函数名与参数左括号之间 不得 有空格，参数右括号前也 不得 有空格。每个逗号前 不得 有空格，但其后 必须 有一个空格。
1<?php
2bar();
3$foo->bar($arg1);
4Foo::bar($arg2, $arg3);参数 可以 分列成多行，此时包括第一个参数在内的每个参数都 必须 单独成行。
1<?php
2$foo->bar(
3 $longArgument,
4 $longerArgument,
5 $muchLongerArgument
6);控制结构
控制结构的基本规范如下：
- 控制结构关键词后 必须 有一个空格。
- 左括号
(后 不得 有空格。 - 右括号
)前也 不得 有空格。 - 右括号
)与开始花括号{间 必须 有一个空格。 - 结构体主体 必须 要有一次缩进。
- 结束花括号
}必须 在结构体主体后单独成行。
每个结构体的主体都 必须 被包含在成对的花括号之中， 这能让结构体更加标准化，以及减少加入新行时，出错的可能性。
if, elseif, else
标准的 if 结构如下代码所示，请留意 括号、空格 以及花括号的位置， 注意 else 和 elseif 都与前面的结束花括号在同一行。
1<?php
2if ($expr1) {
3 // if body
4} elseif ($expr2) {
5 // elseif body
6} else {
7 // else body;
8}应该 使用关键词 elseif 代替所有 else if ，以使得所有的控制关键字都像是单独的一个词。
switch, case
标准的 switch 结构如下代码所示，留意 括号、空格 以及花括号的位置，
case 语句 必须 相对 switch 进行一次缩进，而 break 语句以及 case 内的其它语句都 必须 相对 case 进行一次缩进。
如果存在非空的 case 直穿语句，主体里 必须 有类似 // no break 的注释。
1<?php
2switch ($expr) {
3 case 0:
4 echo 'First case, with a break';
5 break;
6 case 1:
7 echo 'Second case, which falls through';
8 // no break
9 case 2:
10 case 3:
11 case 4:
12 echo 'Third case, return instead of break';
13 return;
14 default:
15 echo 'Default case';
16 break;
17}while, do while
一个规范的 while 语句应该如下所示，注意其 括号、空格 以及花括号的位置，
1<?php
2while ($expr) {
3 // 结构体
4}标准的 do while 语句如下所示，同样的，注意其 括号、空格 以及花括号的位置，
1<?php
2do {
3 // 结构体
4} while ($expr);for
标准的 for 语句如下所示，注意其 括号、空格 以及花括号的位置，
1<?php
2for ($i = 0; $i < 10; $i++) {
3 // for 循环主体
4}foreach
标准的 foreach 语句如下所示，注意其 括号、空格 以及花括号的位置，
1<?php
2foreach ($iterable as $key => $value) {
3 // foreach 主体
4}try, catch
标准的 try catch 语句如下所示，注意其 括号、空格 以及花括号的位置，
1<?php
2try {
3 // try 主体
4} catch (FirstExceptionType $e) {
5 // catch 主体
6} catch (OtherExceptionType $e) {
7 // catch 主体
8}闭包
闭包声明时，关键词 function 后以及关键词 use 的前后都 必须 要有一个空格。
开始花括号 必须 写在声明的同一行，结束花括号 必须 紧跟主体结束的下一行。
参数列表和变量列表的左括号后以及右括号前，不得 有空格。
参数和变量列表中，逗号前 不得 有空格，而逗号后 必须 要有空格。
闭包中有默认值的参数 必须 放到列表的后面。
标准的闭包声明语句如下所示，注意其 括号 、 空格以及 花括号 的位置。
1<?php
2$closureWithArgs = function ($arg1, $arg2) {
3 // 主体
4};
5
6$closureWithArgsAndVars = function ($arg1, $arg2) use ($var1, $var2) {
7 // 主体
8};参数列表以及变量列表 可以 分成多行，这样，包括第一个在内的每个参数或变量都 必须 单独成行，而列表的右括号与闭包的开始花括号 必须 放在同一行。
以下几个例子，包含了参数和变量列表被分成多行的多情况。
1<?php
2$longArgs_noVars = function (
3 $longArgument,
4 $longerArgument,
5 $muchLongerArgument
6) {
7 // 主体
8};
9
10$noArgs_longVars = function () use (
11 $longVar1,
12 $longerVar2,
13 $muchLongerVar3
14) {
15 // 主体
16};
17
18$longArgs_longVars = function (
19 $longArgument,
20 $longerArgument,
21 $muchLongerArgument
22) use (
23 $longVar1,
24 $longerVar2,
25 $muchLongerVar3
26) {
27 // 主体
28};
29
30$longArgs_shortVars = function (
31 $longArgument,
32 $longerArgument,
33 $muchLongerArgument
34) use ($var1) {
35 // 主体
36};
37
38$shortArgs_longVars = function ($arg) use (
39 $longVar1,
40 $longerVar2,
41 $muchLongerVar3
42) {
43 // 主体
44};注意，闭包被直接用作函数或方法调用的参数时，以上规则仍然适用。
1<?php
2$foo->bar(
3 $arg1,
4 function ($arg2) use ($var1) {
5 // 主体
6 },
7 $arg3
8);总结
本指南故意删除了许多风格与实践， 它们包括但不限于：
- 全局变量和常量的声明
- 函数声明
- 运算符与赋值
- 行间对齐
- 注释与文档描述块
- 类名前缀与后缀
- 最佳实践