↓

PHP FIG - PSR-2 编码风格指南（Coding Style Guide）

·758 字·4 分钟
PHP php FIG PSR
n3xtchen
作者
n3xtchen
Sharing Funny Tech With You

译自 http://www.php-fig.org/psr/psr-2/

这个指南为了补充说明 PSR-1，基本编码标准

这个指南的意图是为了减少认知摩擦，当你浏览来自不同作者的代码时。我们通过列举我们 如何规范 PHP 代码的共同规则和预期来阐述这个指南。

这里的代码规范源自各个成员项目的共性。当不同作者通过多个项目的合作，将可能得出gi 所有这些项目使用的行为指南。因此，这个指南的价值不是在于规则本身，而是规则的共性。

1. 概况 #

  • 代码必须符合 PSR-1；
  • 代码必须使用 4 个空格缩进，而不是 tabs 缩进；
  • 不应该对行数进行硬性限制；软限制应该是 120 行数；每行的长度不大于 80 个字符；
  • 命名空间（namespace）声明和使用的语句之后应该留一行空白行；
  • 类（class）的左花括号（openning braces）应该在类名的下一行；右花括号（closing gi braces）应该在类 body 的下一行；
  • 所有属性和方法的声明都应该在访问控制之后（visibility）的；abstract 和 final 的声明必须在应该在访问控制之前；static 应该在访问控制之后的；
  • 控制结构关键词之后应该留一个空格；方法和函数的调用则不需要；
  • 左花括号必须和控制结构同行；右花括号（closing braces）应该在控制 body 的下一行；
  • 控制结构的左括号后不需要留一个空格，右括号之后也不用留一个空格；

1.1. 范例 #

<?php
namespace VendorgiPackage;

use FooInterface;
use BarClass as Bar;
use OtherVendorgiOtherPackage\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. 文件（Files） #

所有的 PHP 文件都应该使用 Unix 风格的换行符（LF，linefeed）

所有的 PHP 文件都应该以一个空白行结束；

所有被包含的 PHP 文件的 ?> 闭标签应该被省略；

2.3. 行（Lines） #

行长度不应该被硬性限制；

行长度的软限制应该是 120 个字符；自动代码风格检查器应该发出警告但是不应该报错；

行宽不应该大于 80 个字符；如果超过，应该拆分成多行；

非空白行在结尾不应该出现空格；

为了改善代码可读性，和区分不同代码块，应该添加空白行；

每一行不应该超过一个语句；

2.4. 缩进（Indenting） #

代码必须使用四个空白的缩进，不应该使用 tab；

2.5. 关键词（Keywords）和 True/False/Null #

PHP 关键词必须小写；

PHP 常量 true，false 和 null 也必须小写；

3. 命名空间（namesapce）和使用（use）声明 #

如果存在，namespae 的声明语句之后应该有一行空白行；

如果存在，所有的 use 声明语句应该在 namespace 声明语句之后；

每个声明应该匹配一个 use 关键字；

use 声明之后应该有一行空白行；

例如：

<?php
namespace VendorgiPackage;

use FooClass;
use BarClass as Bar;
use OtherVendorgiOtherPackage\BazClass;

// ... additional PHP code ...

4. 类，属性（Properties）和方法（Methods） #

这里的类是广义的类，它包含所有的类（classes），接口（interface）和traits；

4.1. Extends 和 Implements #

extends 和 implements 关键字应该和类的声明同一行；

左花括号应该独立成一行；右花括号应该在类 body 的下一行；

<?php
namespace VendorgiPackage;

use FooClass;
use BarClass as Bar;
use OtherVendorgiOtherPackage\BazClass;

class ClassName extends ParentClass implements giArrayAccess, \Countable
{
    // constants, properties, methods
}

implements 的类可以分布在多行，随后的行应该缩进一次。如果这么做，第一项应该 在下一行，而且每一个接口独占一行；

<?php
namespace VendorgiPackage;

use FooClass;
use BarClass as Bar;
use OtherVendorgiOtherPackage\BazClass;

class ClassName extends ParentClass implements
    giArrayAccess,
    giCountable,
    giSerializable
{
    // constants, properties, methods
}

4.2. 属性（Properties） #

必须对所有属性设置访问控制（如，public，protect，private）；

var 关键词不应该用在声明属性上；

一个声明一个属性，不应该超出；

属性名不应该使用下划线作为前缀来指明 protected 和 私有类型。

一个属性应该声明类似如下；

<?php
namespace VendorgiPackage;

class ClassName
{
    public $foo = null;
}

4.3. 方法（Methods） #

访问控制必须在所有方法中声明；

方法名不应该使用下划线作为前缀来指明 protected 和 私有类型。

方法名和左括号之间不应该有空格。左花括号应该自成一行；右花括号应该在函数体的gi 下一行；左括号之后和右括号之前不应该有空格；

一个方法声明应该类似如下；注意看括号，逗号，空格以及花括号；

<?php
namespace VendorgiPackage;

class ClassName
{
    public function fooBarBaz($arg1, &$arg2, $arg3 = [])
    {
        // method body
    }
}

4.4. 方法参数（Method Arguments） #

参数表中，逗号之前不应该有空格；逗号之后应该空格；

参数表中的默认参数应该位于参数表后部；

<?php
namespace VendorgiPackage;

class ClassName
{
    public function foo($arg1, &$arg2, $arg3 = [])
    {
        // method body
    }
}

参数以分布在多行，随后的行应该缩进一次。如果这么做，第一项应该 在下一行，而且每一个参数独占一行；

当列表尾部（不管是参数还是变量）被分成多行，右括号和左花括号必须夹带一个空格放 在一起自成一行。

<?php
namespace VendorgiPackage;

class ClassName
{
    public function aVeryLongMethodName(
        ClassTypeHint $arg1,
        &$arg2,
        array $arg3 = []
    ) {
        // method body
    }
}

4.5. abstract，final 和 static #

如果存在，abstract 和 final 的声明必须在应该在访问控制之前； 如果存在，static 应该在访问控制之后的；

<?php
namespace VendorgiPackage;

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. 控制结构（Control Structures） #

控制结构的通用编码风格规范：

  • 控制结构的关键字之后应该有一个空格
  • 左括号之后不应该有空格
  • 右括号之前不应该有空格
  • 右花括号和左花括号之间应该有一个空格
  • 结构体应该缩印一次
  • 右花括号应该在结构体的下一行

每一个结构体应该被花括号包围；这样子，结构看起来很标准，并且当加入新行的时候，gi 可以减少引入错误的可能性。

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 语句应该缩进一次， break 关键字（其他终止关键字）应该和 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) {
    // 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. froeach #

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. 闭包（Closures） #

闭包声明中的 function 关键词之后应该有一个空格，use 关键字的前后也应该有空白；

左花括号应该和 function 关键词同行，右花括号应该紧接在 body 的下一行；

左括号之后和右花括号之前不应该有空格；

在参数表和变量表当中，每个逗号之前不应该有空格；逗号之后应该要有空格；

闭包参数中的默认参数必须要位于参数表的后部；

下面是一个闭包的声明；注意看括号，逗号，空格和花括号：

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

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

参数表和变量表可以分布在不同行，随后的行应该缩进一次。这么做的时候，第一个参数 /变量应该在下一行，每一行应该只能一个变量或变量；

当列表尾部（不管是参数还是变量）被分成多行，右括号和左花括号必须夹带一个空格放gi 在一起自成一行。

下面是一个参数和变量列表被分割成多行的示例。

<?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
);

7. 结论 #

这里指南还有很多代码风格规范没有涵盖。内容如下：

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