PHP代码规范PSR2

左手的ㄟ右手 2022-07-24 06:21 243阅读 0赞

转载地址：http://my.oschina.net/u/1420250/blog/193971

[FIG][]组织在制定跟PHP相关规范，简称PSR。目前已有4个代码规范，近期抽空翻译成了中文版。建议做PHP的同学都关注一下。  
文档仓库地址：[https://github.com/hfcorriez/fig-standards][https_github.com_hfcorriez_fig-standards]

所有已接受的规范参考：[https://github.com/hfcorriez/fig-standards/tree/zh\_CN/%E6%8E%A5%E5%8F%97][https_github.com_hfcorriez_fig-standards_tree_zh_CN_E6_8E_A5_E5_8F_97]

代码样式规范

本指南的意图是为了减少不同开发者在浏览代码时减少认知的差异。 为此列举一组如何格式化PHP代码的共用规则。

各个成员项目的共性组成了本文的样式规则。当不同的开发者在不同的项目中合作时，将会在这些不同的项目中使用一个共同的标准。 因此，本指南的好处不在于规则本身，而在于共用这些规则。

在 RFC 2119中的特性关键词"必须"(MUST)，“不可”(MUST NOT)，“必要”(REQUIRED)，“将会”(SHALL)，“不会”(SHALL NOT)，“应当”(SHOULD)，“不应”(SHOULD NOT)，“推荐”(RECOMMENDED)，“可以”(MAY)和“可选”(OPTIONAL)在这文档中将被用来描述。

1. 大纲

*  代码必须遵守 [PSR-1][]。
 *  代码必须使用4个空格的缩进，而不是制表符。
 *  一行代码长度不应硬性限制；软限制必须为120个字符；也应当是80个字符或者更少。
 *  在namespace声明下面必须有一个空行，并且use声明代码块下面也必须有一个空行。
 *  类的左花括号必须放到下一行，右花括号必须放在类主体的下一行。
 *  方法的左花括号必须放在下一行，右花括号必须放在方法主体下面。
 *  所有的属性和方法必须有可见性(译者注：Public, Protect, Private)声明；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()

// method body

2. 概括

2.1 基础代码规范

代码必须遵守 [PSR-1][] 的所有规则。

2.2 文件

所有的PHP文件必须使用Unix LF(换行)作为行结束符。

所有PHP文件必须以一个空行结束。

纯PHP代码的文件关闭标签?>必须省略

2.3. 行

行长度不可有硬限制。

行长度的软限制必须是120个字符；对于软限制，自动样式检查器必须警告但不可报错。

行实际长度不应超过80个字符；较长的行应当被拆分成多个不超过80个字符的后续行。

在非空行后面不可有空格。

空行可以用来改善可读性和区分相关的代码块。

一行不应多于一个语句。

2.4. 缩进

代码必须使用4个空格的缩进，并且不可使用制表符作为缩进。

注意：只用空格，不和制表符混合使用，将会对避免代码差异，补丁，历史和注解中的一些问题有帮助。使用空格还可以使调整细微的缩进来改进行间对齐变得非常简单。

2.5. 关键词和 True/False/Null

PHP [keywords][] 必须使用小写。

PHP常量true, false和null必须使用小写。

3. Namespace和Use声明

如果存在，namespace声明之后必须有一个空行。

如果存在，所有的use声明必须放在namespace声明的下面。

一个use关键字必须只用于一个声明。

在use声明代码块后面必须有一个空行。

示例:

<?php

namespace Vendor\\Package;

use FooClass;

use BarClass as Bar;

use OtherVendor\\OtherPackage\\BazClass;

// ... additional PHP code ...

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

// constants, properties, methods

implements一个列表可以被拆分为多个有一次缩进的后续行。如果这么做，列表的第一项必须要放在下一行，并且每行必须只有一个接口。

<?php

namespace Vendor\\Package;

use FooClass;

use BarClass as Bar;

use OtherVendor\\OtherPackage\\BazClass;

class ClassName extends ParentClass implements

\\ArrayAccess,

\\Countable,

\\Serializable

// constants, properties, methods

4.2. 属性

所有的属性必须声明可见性。

var关键词不可用来声明属性。

一个语句不可声明多个属性。

属性名称不应使用单个下划线作为前缀来表明保护或私有的可见性。

一个属性声明看起来应该下面这样的。

<?php

namespace Vendor\\Package;

class ClassName

public $foo = null;

4.3. 方法

所有的方法必须声明可见性。

方法名不应只使用单个下划线来表明是保护或私有的可见性。

方法名在声明之后不可跟随一个空格。左花括号必须放在下面自成一行，并且右花括号必须放在方法主体的下面自成一行。左括号后面不可有空格，右括号前面不可有空格。

一个方法定义看来应该像下面这样。 注意括号，逗号，空格和花括号：

<?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 = \[\]

) \{

// method body

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主体往下落空则必须有一个类似// 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. 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

);

7. 结论

在该指南中有很多风格的元素和做法有意被忽略掉。这些包括但不局限于：

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

以后的建议可以修改和扩展该指南以满足这些或其他风格的元素和实践。

附录A 调查

为了写这个风格指南，我们采用了调查个项目以确定共同的做法。这个调查在这里供他人查看。

A.1. 调查数据

url,http://www.horde.org/apps/horde/docs/CODING\_STANDARDS,http://pear.php.net/manual/en/standards.php,http://solarphp.com/manual/appendix-standards.style,http://framework.zend.com/manual/en/coding-standard.html,http://symfony.com/doc/2.0/contributing/code/standards.html,http://www.ppi.io/docs/coding-standards.html,https://github.com/ezsystems/ezp-next/wiki/codingstandards,http://book.cakephp.org/2.0/en/contributing/cakephp-coding-conventions.html,https://github.com/UnionOfRAD/lithium/wiki/Spec%3A-Coding,http://drupal.org/coding-standards,http://code.google.com/p/sabredav/,http://area51.phpbb.com/docs/31x/coding-guidelines.html,https://docs.google.com/a/zikula.org/document/edit?authkey=CPCU0Us&hgd=1&id=1fcqb93Sn-hR9c0mkN6m\_tyWnmEvoswKBtSc0tKkZmJA,http://www.chisimba.com,n/a,https://github.com/Respect/project-info/blob/master/coding-standards-sample.php,n/a,Object Calisthenics for PHP,http://doc.nette.org/en/coding-standard,http://flow3.typo3.org,https://github.com/propelorm/Propel2/wiki/Coding-Standards,http://developer.joomla.org/coding-standards.html

voting,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,no,no,no,?,yes,no,yes

indent\_type,4,4,4,4,4,tab,4,tab,tab,2,4,tab,4,4,4,4,4,4,tab,tab,4,tab

line\_length\_limit\_soft,75,75,75,75,no,85,120,120,80,80,80,no,100,80,80,?,?,120,80,120,no,150

line\_length\_limit\_hard,85,85,85,85,no,no,no,no,100,?,no,no,no,100,100,?,120,120,no,no,no,no

class\_names,studly,studly,studly,studly,studly,studly,studly,studly,studly,studly,studly,lower\_under,studly,lower,studly,studly,studly,studly,?,studly,studly,studly

class\_brace\_line,next,next,next,next,next,same,next,same,same,same,same,next,next,next,next,next,next,next,next,same,next,next

constant\_names,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper,upper

true\_false\_null,lower,lower,lower,lower,lower,lower,lower,lower,lower,upper,lower,lower,lower,upper,lower,lower,lower,lower,lower,upper,lower,lower

method\_names,camel,camel,camel,camel,camel,camel,camel,camel,camel,camel,camel,lower\_under,camel,camel,camel,camel,camel,camel,camel,camel,camel,camel

method\_brace\_line,next,next,next,next,next,same,next,same,same,same,same,next,next,same,next,next,next,next,next,same,next,next

control\_brace\_line,same,same,same,same,same,same,next,same,same,same,same,next,same,same,next,same,same,same,same,same,same,next

control\_space\_after,yes,yes,yes,yes,yes,no,yes,yes,yes,yes,no,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes,yes

always\_use\_control\_braces,yes,yes,yes,yes,yes,yes,no,yes,yes,yes,no,yes,yes,yes,yes,no,yes,yes,yes,yes,yes,yes

else\_elseif\_line,same,same,same,same,same,same,next,same,same,next,same,next,same,next,next,same,same,same,same,same,same,next

case\_break\_indent\_from\_switch,0/1,0/1,0/1,1/2,1/2,1/2,1/2,1/1,1/1,1/2,1/2,1/1,1/2,1/2,1/2,1/2,1/2,1/2,0/1,1/1,1/2,1/2

function\_space\_after,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no,no

closing\_php\_tag\_required,no,no,no,no,no,no,no,no,yes,no,no,no,no,yes,no,no,no,no,no,yes,no,no

line\_endings,LF,LF,LF,LF,LF,LF,LF,LF,?,LF,?,LF,LF,LF,LF,?,,LF,?,LF,LF,LF

static\_or\_visibility\_first,static,?,static,either,either,either,visibility,visibility,visibility,either,static,either,?,visibility,?,?,either,either,visibility,visibility,static,?

control\_space\_parens,no,no,no,no,no,no,yes,no,no,no,no,no,no,yes,?,no,no,no,no,no,no,no

blank\_line\_after\_php,no,no,no,no,yes,no,no,no,no,yes,yes,no,no,yes,?,yes,yes,no,yes,no,yes,no

class\_method\_control\_brace,next/next/same,next/next/same,next/next/same,next/next/same,next/next/same,same/same/same,next/next/next,same/same/same,same/same/same,same/same/same,same/same/same,next/next/next,next/next/same,next/same/same,next/next/next,next/next/same,next/next/same,next/next/same,next/next/same,same/same/same,next/next/same,next/next/next

A.2. 调查说明

indent\_type: 缩进类型。 tab = "使用制表符"，2 or 4 = "空格数量"

line\_length\_limit\_soft: 行长度的“软”限制，用字符。 ? = 不表示或者数字 no 意为不限制.

line\_length\_limit\_hard: 行长度的"硬"限制，用字符。 ? = 不表示或者数字, no 意为不限制.

class\_names: 类名如何命名 lower = 只是小写, lower\_under = 小写加下划线, studly = 骆驼型.

class\_brace\_line: 类的左花括号是放在同(same)一行还是在下(next)一行？

constant\_names: 类常量如何命名？upper = 大写加下划线分隔符。

true\_false\_null: 全校写或者全大写？

method\_names: 方法名如何命名？camel = 驼峰式, lower\_under = 小写加下划线分隔符。

method\_brace\_line: 方法的左花括号在同(same)一行还是在下(next)一行？

control\_brace\_line: 控制结构的左花括号在同(same)一行还是在下(next)一行？

control\_space\_after: 控制结构关键词后是否有空格？

always\_use\_control\_braces: 控制结构总是使用花括号？

else\_elseif\_line: 当使用else和elseif，是否放在同(same)一行还是在下(next)一行？

case\_break\_indent\_from\_switch: case和break分别从swith语句处缩进多少次？

function\_space\_after: 函数调用的函数名和左括号是否有空格？

closing\_php\_tag\_required: 如过是纯PHP文件，关闭标签?>是否需要？

line\_endings: 使用何种的行结束符？

static\_or\_visibility\_first: 在定义方法的时候static和可见性谁在前面？

control\_space\_parens: 在控制结构表达式中，左括号后面和右括号前面是否要有一个空格？yes = if ( $expr ), no =if ($expr).

blank\_line\_after\_php: PHP的开始标签后面是否需要一个空行？

class\_method\_control\_brace: 左花括号在类，方法和控制结构中的位置。

A.3. 调查结果

indent\_type:

tab: 7

2: 1

4: 14

line\_length\_limit\_soft:

?: 2

no: 3

75: 4

80: 6

85: 1

100: 1

120: 4

150: 1

line\_length\_limit\_hard:

?: 2

no: 11

85: 4

100: 3

120: 2

class\_names:

?: 1

lower: 1

lower\_under: 1

studly: 19

class\_brace\_line:

next: 16

same: 6

constant\_names:

upper: 22

true\_false\_null:

lower: 19

upper: 3

method\_names:

camel: 21

lower\_under: 1

method\_brace\_line:

next: 15

same: 7

control\_brace\_line:

next: 4

same: 18

control\_space\_after:

no: 2

yes: 20

always\_use\_control\_braces:

no: 3

yes: 19

else\_elseif\_line:

next: 6

same: 16

case\_break\_indent\_from\_switch:

0/1: 4

1/1: 4

1/2: 14

function\_space\_after:

no: 22

closing\_php\_tag\_required:

no: 19

yes: 3

line\_endings:

?: 5

LF: 17

static\_or\_visibility\_first:

?: 5

either: 7

static: 4

visibility: 6

control\_space\_parens:

?: 1

no: 19

yes: 2

blank\_line\_after\_php:

?: 1

no: 13

yes: 8

class\_method\_control\_brace:

next/next/next: 4

next/next/same: 11

next/same/same: 1

same/same/same: 6

[FIG]: http://www.php-fig.org/
[https_github.com_hfcorriez_fig-standards]: https://github.com/hfcorriez/fig-standards
[https_github.com_hfcorriez_fig-standards_tree_zh_CN_E6_8E_A5_E5_8F_97]: https://github.com/hfcorriez/fig-standards/tree/zh_CN/%E6%8E%A5%E5%8F%97
[PSR-1]: https://github.com/hfcorriez/fig-standards/blob/zh_CN/%E6%8E%A5%E5%8F%97/PSR-1-basic-coding-standard.md
[keywords]: http://php.net/manual/en/reserved.keywords.php