PHP编码规范

发表于 2016/03/11

作者 ly827

23 分钟阅读

PHP编码规范

PSR-1 基本代码规范

1. 概览

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

2. 文件

2.1 PHP标签

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

2.2. 字符编码

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

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
// 声明函数
function foo()
{
    // 函数主体部分
}
// 条件声明**不**属于从属效应
if (! function_exists('bar')) {
    function bar()
    {
        // 函数主体部分
    }
}

3. 命名空间和类

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

class Foo
{
	//class body
}

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

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

4. 类的常量、属性和方法

此处的“类”值代所有的类、接口一级可复用代码块（traits）

4.1 常量

累的常量中所有的字母必须大写，词间以下划线分隔。

<?php 
namespace Vendor\Model;

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

4.2 属性

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

4.3 方法

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

PSR-2 代码风格规范

本篇规范是 PSR-1 基本代码规范的继承与扩展。本规范希望通过制定一系列规范化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()
    {
        // method body
    }
}

2. 通则

2.1 基本编码准则

代码必须符合 PSR-1 中的所有规范。

2.2 文件

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

2.3 行

行的长度一定不能有硬性的约束。软性的长度约束一定要限制在120个字符以内，若超过此长度，带代码规范检查的编辑器一定要发出警告，不过一定不可发出错误提示。每行不应该多于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声明语句块后__必须__要有一个空白行。例如：

namespace Vendor\Package;

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

// ... additional PHP code ...

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
{
    // 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声明一个属性。每条语句一定不可定义超过一个属性。不要使用下划线作为前缀，来区分属性是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 = []
    ) {
        // 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(){
		//body
	}
}

4.6 方法及函数调用

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

<?php 
bar();
$foo->bar($arg1);
Foo::bar($arg1, $arg2); 参数可以分列成多行，此时包括第一个参数在内的每个参数都__必须__单独成行。
<?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

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

<?php
foreach ($iterable as $key => $value) {
	//forecah 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 ($var2) {
		//body
	},
	$arg3
);

7. 总结

以上规范难免有疏忽，其中包括但不仅限于：

全局变量和常量的定义
函数的定义
操作符和赋值
行内对齐
注释和文档描述块
类名的前缀及后缀
最佳实践

PHP

PHP Standard

本文由作者按照 CC BY 4.0 进行授权