PSR PHP 标准规范

2017-09-03 | by COUH

　　PSR PHP 标准规范制定了代码基本元素的相关标准，以确保共享的 PHP 代码间具有较高程度的技术互通性，避免各个框架自行发展的风格阻碍 PHP 的发展。

1、基本代码规范 ( PSR-1 )

1.1、概览

PHP代码文件 必须 以 <?php 或 <?= 标签开始；
PHP代码文件 必须 以不带 BOM 的 UTF-8 编码；
PHP代码中 应该 只定义类、函数、常量等声明，或其他会产生从属效应的操作，二者只能选其一；
命名空间以及类 必须 符合 PSR 自动加载规范：PSR-1 或 PSR-4 中的一个；
类的命名 必须 遵循 StudlyCaps 大写开头的驼峰命名规范；
类中的常量所有字母都 必须 大写，单词间用下划线分隔；
方法名称 必须 符合 camelCase 式的小写开头驼峰命名规范。

1.2、文件

1.2.1、PHP标签

PHP代码 必须 使用 <?php ?> 长标签或 <?= ?> 短输出标签； 一定不能使用其它自定义标签。

1.2.2、字符编码

PHP代码 必须 使用不带 BOM 的 UTF-8 编码。

1.2.3、从属效应（副作用）

一份 PHP 文件中 应该 要不就只定义新的声明，如类、函数或常量等不产生从属效应的操作，要不就只有会产生从属效应的逻辑操作，但 不该 同时具有两者。
「从属效应」( side effects )一词的意思是，仅仅通过包含文件，不直接声明类、函数和常量等，而执行的逻辑操作。
「从属效应」包含却不仅限于：生成输出、直接的 require 或 include、连接外部服务、修改 ini 配置、抛出错误或异常、修改全局或静态变量、读或写文件等。

//从属效应代码
<?php
// 「副作用」：修改 ini 配置
ini_set('error_reporting', E_ALL);

// 「副作用」：引入文件
include "file.php";

// 「副作用」：生成输出
echo "<html>\n";

// 声明函数
function foo()
{
    // 函数主体部分
}

//无从属效应代码
<?php
// 声明函数
functionfoo(){
    // 函数主体部分
}

// 条件声明**不**属于从属效应
if (! function_exists('bar')) {
    functionbar(){
        // 函数主体部分
    }
}

1.3、命名空间和类

命名空间以及类的命名 必须 遵循 PSR-1。根据规范，每个类都独立为一个文件，且命名空间至少有一个层次：顶级的组织名称（ vendor name ）。类的命名 必须 遵循 StudlyCaps 大写开头的驼峰命名规范
PHP 5.3 及以后版本的代码 必须 使用正式的命名空间。

<?php
// PHP 5.3 及以后版本的写法
namespace Vendor\Model;

class Foo{
}

5.2.x 及之前的版本 应该 使用伪命名空间的写法，约定俗成使用顶级的组织名称（ vendor name ）如 Vendor_ 为类前缀。

<?php
// 5.2.x及之前版本的写法
class Vendor_Model_Foo{
}

1.4、类的常量、属性和方法

此处的「类」指代所有的类、接口以及可复用代码块（ traits ）。

1.4.1、常量

类的常量中所有字母都 必须 大写，词间以下划线分隔。参照以下代码：

<?php
namespace Vendor\Model;

class Foo{
    const VERSION = '1.0';
    const DATE_APPROVED = '2012-06-01';
}

1.4.2、属性

类的属性命名 可以 遵循大写开头的驼峰式 ( StudlyCaps )、小写开头的驼峰式 ( camelCase ) 又或者是下划线分隔式 ( under_score )，本规范不做强制要求，但无论遵循哪种命名方式，都 应该 在一定的范围内保持一致。这个范围 可以 是整个团队、整个包、整个类或整个方法。

1.4.3、方法

方法名称 必须 符合 camelCase() 式的小写开头驼峰命名规范

2、代码风格规范 ( PSR-2 )

　　代码风格规范是 PSR-2 基本代码规范的继承与扩展。通过制定一系列规范化PHP代码的规则，以减少在浏览不同作者的代码时，因代码风格的不同而造成不便。当多名程序员在多个项目中合作时，就需要一个共同的编码规范，而本文中的风格规范源自于多个不同项目代码风格的共同特性，因此，本规范的价值在于我们都遵循这个编码风格，而不是在于它本身。

2.1、概览

代码 必须 符合 PSR-2 中的所有规范
代码 必须 使用 4 个空格符而不是 tab 键进行缩进。
每行的字符数 应该 软性保持在 80 个之内，理论上一定不可多于 120 个，但 一定不能 有硬性限制。
非空行后 一定不能有多余的空格符。
空行 可以 使得阅读代码更加方便以及有助于代码的分块。
每行 一定不能存在多于一条语句。
PHP所有关键字 必须 全部小写。
常量 true 、false 和 null 也 必须 全部小写
每个 namespace 命名空间声明语句和 use 声明语句块后面，必须 插入一个空白行。
类的开始花括号({) 必须 写在函数声明后自成一行，结束花括号(})也 必须 写在函数主体后自成一行。
方法的开始花括号({) 必须 写在函数声明后自成一行，结束花括号(})也 必须 写在函数主体后自成一行。
类的属性和方法 必须 添加访问修饰符（private、protected 以及 public）， abstract 以及 final 必须 声明在访问修饰符之前，而 static 必须 声明在访问修饰符之后。
控制结构的关键字后 必须 要有一个空格符，而调用方法或函数时则 一定不能 有空格符。
控制结构的开始花括号({) 必须 写在声明的同一行，而结束花括号(}) 必须 写在主体后自成一行。
控制结构的开始左括号后和结束右括号前 一定不能 有空格符。

2.2、示例

示例简单地展示了以上大部分规范

<?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 functionbar()
    {
        // method body
    }
}

2.3、文件

代码 必须 符合 PSR-2 中的所有规范
所有 PHP 文件 必须 使用 Unix LF ( linefeed ) 作为行的结束符。
所有 PHP 文件 必须 以一个空白行作为结束。
纯 PHP 代码文件 必须 省略最后的 ?> 结束标签。

2.4、namespace 以及 use 声明

所有 use 必须 在 namespace 后声明。
每条 use 声明语句 必须 只有一个 use 关键词。
use 声明语句块后 必须 要有一个空白行。

//示例
<?php
namespace Vendor\Package;

use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;

// ... additional PHP code ...

2.5、类、属性和方法

此处的「类」泛指所有的 class 类、接口以及（ traits ）可复用代码块。

2.5.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
}

2.5.2、属性

每个属性都 必须 添加访问修饰符。
一定不能 使用关键字 var 声明一个属性。
每条语句 一定不能 定义超过一个属性。
不该 使用下划线作为前缀，来区分属性是 protected 或 private。

//示例
<?php
namespace Vendor\Package;

classClassName
{
    public $foo = null;
}

2.5.3、方法

所有方法都 必须 添加访问修饰符。
不该 使用下划线作为前缀，来区分方法是 protected 或 private。
方法名称后 一定不能 有空格符，其开始花括号 必须独占一行，结束花括号也 必须 在方法主体后单独成一行。参数左括号后和右括号前 一定不能 有空格。

//示例，留意其括号、逗号、空格以及花括号的位置。
<?php
namespace Vendor\Package;

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

2.5.4、方法的参数

参数列表中，每个参数后面 必须 要有一个空格，而前面 一定不能 有空格。
有默认值的参数，必须放到参数列表的末尾。

<?php
namespace Vendor\Package;

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

参数列表 可以 分列成多行，这样，包括第一个参数在内的每个参数都 必须 单独成行。
拆分成多行的参数列表后，结束括号以及方法开始花括号 必须 写在同一行，中间用一个空格分隔。

<?php
namespace Vendor\Package;

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

2.5.5、abstract 、 final 、以及 static

需要添加 abstract 或 final 声明时， 必须写在访问修饰符前，而 static 则 必须 写在其后。

<?php
namespace Vendor\Package;

abstract class ClassName
{
    protected static $foo;

    abstract protected functionzim();

    final public static functionbar()
    {
        // method body
    }
}

2.5.6、方法及函数调用

方法及函数调用时，方法名或函数名与参数左括号之间 一定不能 有空格，参数右括号前也 一定不能 有空格。每个参数前 一定不能 有空格，但其后 必须 有一个空格。

<?php
bar();
$foo->bar($arg1);
Foo::bar($arg2, $arg3);

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

<?php
$foo->bar(
    $longArgument,
    $longerArgument,
    $muchLongerArgument
);

2.6、控制结构

控制结构关键词后 必须 有一个空格。
左括号 ( 后 一定不能 有空格。
右括号 ) 前也 一定不能 有空格。
右括号 ) 与开始花括号 { 间 必须 有一个空格。
结构体主体 必须 要有一次缩进。
结束花括号 } 必须 在结构体主体后单独成行。
每个结构体的主体都 必须 被包含在成对的花括号之中，这能让结构体更加结构话，以及减少加入新行时，出错的可能性。

2.6.1、if 、 elseif 和 else

标准的 if 结构如下代码所示，留意括号、空格以及花括号的位置，注意 else 和 elseif 都与前面的结束花括号在同一行。

<?php
if ($expr1) {
    // if body
} elseif ($expr2) {
    // elseif body
} else {
    // else body;
}

应该 使用关键词 elseif 代替所有 else if ，以使得所有的控制关键字都像是单独的一个词。

2.6.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;
}

2.6.3、while 和 do while

一个规范的 while 语句 应该 如下所示，注意其括号、空格以及花括号的位置。

<?php
while ($expr) {
    // structure body
}

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

<?php
do {
    // structure body;
} while ($expr)

2.6.4、for

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

<?php
for ($i = 0; $i < 10; $i++) {
    // for body
}

2.6.5、foreach

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

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

2.6.6、try, catch

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

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

2.7、闭包

闭包声明时，关键词 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
);

0.详细描述可参见 RFC 2119 ↩
1.必须( MUST ) ↩
2.一定不能( MUST NOT ) ↩
3.需要( REQUIRED ) ↩
4.将会( SHALL ) ↩
5.不会( SHALL NOT ) ↩
6.应该( SHOULD ) ↩
7.不该( SHOULD NOT ) ↩
8.推荐( RECOMMENDED ) ↩
9.可以( MAY ) ↩
10.可选( OPTIONAL ) ↩

PHP

下一篇 liip 脚本升级 Mac 自带 PHP

上一篇修正笔记本内建显示器连接类型

查看评论