【PHP开发规范】继承与扩展:PSR-2 编码风格规范

时间 2019-12-08

标签 PHP开发规范继承扩展 psr 编码风格规范栏目软件设计繁體版

原文原文链接

以前的一篇文章是对PSR-1的基本介绍php

接下来是PSR-2 编码风格规范，它是 PSR-1 基本代码规范的继承与扩展。闭包

PSR-1 和PSR-2是PHP开发中基本的编码规范，你们其实均可以参考学习下，虽说每一个开发者都有本身熟悉的一套开发规范，可是我以为仍是根据行业标准来编写咱们的代码，毕竟标准都是通过验证的了。但愿能对PHP开发者有帮助吧。编辑器

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 sampleFunction($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文件必须以一个空白行做为结束。spa

纯PHP代码文件必须省略最后的 ?> 结束标签。代码规范

2.3. 行

行的长度必定不可有硬性的约束。code

软性的长度约束必须要限制在 120 个字符之内，若超过此长度，带代码规范检查的编辑器必须要发出警告，不过必定不可发出错误提示。blog

每行不应多于80个字符，大于80字符的行应该折成多行。

非空行后必定不可有多余的空格符。

空行能够使得阅读代码更加方便以及有助于代码的分块。

每行必定不可存在多于一条语句。

2.4. 缩进

代码必须使用4个空格符的缩进，必定不可用 tab键。

备注：使用空格而不是「tab键缩进」的好处在于，

避免在比较代码差别、打补丁、重阅代码以及注释时产生混淆。

而且，使用空格缩进，让对齐变得更方便。

2.5. 关键字以及 True/False/Null

PHP全部关键字必须所有小写。

常量 true 、false 和 null 也必须所有小写。

3. namespace 以及 use 声明

namespace 声明后必须插入一个空白行。

全部 use 必须在 namespace 后声明。

每条 use 声明语句必须只有一个 use 关键词。

use 声明语句块后必须要有一个空白行。

例如：

<?php

namespace Vendor\Package;
use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;

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 = [])
 {
 // 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 = []
 ) {
 // 方法的内容
 }
}

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进行一次缩进。

若是存在非空的 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
);

参考资料：

https://psr.phphub.org/

------------------------------------------------------------------------------

欢迎关注个人公众号【phper的进阶之路】，将不断更新各类技术心得，免费提供各类学习资源！！！