PHP代码规范PSR2

时间  2019-11-12
标签 php 代码 规范 psr2 psr 栏目 PHP 繁體版
原文   原文链接

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

全部已接受的规范参考：https://github.com/hfcorriez/fig-standards/tree/zh_CN/%E6%8E%A5%E5%8F%97html

代码样式规范git

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

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

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

1. 大纲ide

  • 代码必须遵照 PSR-1。函数

  • 代码必须使用4个空格的缩进，而不是制表符。ui

  • 一行代码长度不该硬性限制；软限制必须为120个字符；也应当是80个字符或者更少。google

  • 在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

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程