PSR-2 编码风格规范

编码风格指南

本篇规范是 PSR-1基本代码规范的继承与扩展。

本规范希望通过制定一系列规范化 PHP 代码的规则，以减少在浏览不同作者的代码时，因代码风格的不同而造成不便。

当多名程序员在多个项目中合作时，就需要一个共同的编码规范，

而本文中的风格规范源自于多个不同项目代码风格的共同特性，

因此，本规范的价值在于我们都遵循这个编码风格，而不是在于它本身。

本文件中的 必须，不得，需要，应，不应，应该，不应该，推荐，可能 和 可选 等能愿动词按照 RFC 2119 中的描述进行解释。

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 sampleMethod($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 的关键字必须使用小写形式。

PHP 的常量 true， false，还有 null 必须使用小写形式。

3. 命名空间和使用声明

namespace 声明之后必须存在一个空行。

所有的 use 声明必须位于 namespace 声明之后。

每条 use 声明必须只有一个 use 关键字。

use 语句块之后必须存在一个空行。

例如：

<?php
namespace Vendor\Package;
use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;
// ... 其他 PHP 代码 ...

4. 类、属性和方法

此处的「类」泛指所有的「class类」、「接口」以及「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 = [])
    {
        // 方法主体
    }
}

4.4. 方法的参数

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

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

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

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

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

<?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()
    {
        // 方法主体
    }
}

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 '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
while ($expr) {
    // 结构体
}

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

<?php
do {
    // 结构体
} while ($expr);

5.4. for

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

<?php
for ($i = 0; $i < 10; $i++) {
    // for 循环主体
}

5.5. foreach

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

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

5.6. try, catch

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

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

6. 闭包

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

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

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

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

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

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

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

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

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

<?php
$longArgs_noVars = function (
    $longArgument,
    $longerArgument,
    $muchLongerArgument
) {
    // 主体
};
$noArgs_longVars = function () use (
    $longVar1,
    $longerVar2,
    $muchLongerVar3
) {
    // 主体
};
$longArgs_longVars = function (
    $longArgument,
    $longerArgument,
    $muchLongerArgument
) use (
    $longVar1,
    $longerVar2,
    $muchLongerVar3
) {
    // 主体
};
$longArgs_shortVars = function (
    $longArgument,
    $longerArgument,
    $muchLongerArgument
) use ($var1) {
    // 主体
};
$shortArgs_longVars = function ($arg) use (
    $longVar1,
    $longerVar2,
    $muchLongerVar3
) {
    // 主体
};

注意，闭包被直接用作函数或方法调用的参数时，以上规则仍然适用。

<?php
$foo->bar(
    $arg1,
    function ($arg2) use ($var1) {
        // 主体
    },
    $arg3
);

7. 总结

本指南故意删除了许多风格与实践，它们包括但不限于：

全局变量和常量的声明
函数声明
运算符与赋值
行间对齐
注释与文档描述块
类名前缀与后缀
最佳实践

本指南将来的修订和扩展可能会弥补上述或其他风格与最佳实践。