PHP编程风格规范

php   规范   PSR  

关于「能愿动词」的使用

为了避免歧义,文档大量使用了「能愿动词」,对应的解释如下:

  • 必须 (MUST):绝对,严格遵循,请照做,无条件遵守;
  • 一定不可 (MUST NOT):禁令,严令禁止;
  • 应该 (SHOULD):强烈建议这样做,但是不强求;
  • 不该 (SHOULD NOT: 强烈不建议这样做,但是不强求;
  • 可以 (MAY)可选 (OPTIONAL):选择性高一点,在这个文档内,此词语使用较少;

一、PSR-1 基础编码规范

基础编程规范制定了代码基本元素的相关标准,以确保共享的PHP代码间具有较高程度的技术互通性。

1、概览

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

2、文件

2.1. PHP标签

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

2.2. 字符编码

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

2.3 副作用

一份 PHP 文件中 应该 要不就只定义新的声明,如类、函数或常量等不产生 副作用 的操作,要不就只书写会产生 副作用 的逻辑操作,但 不该 同时具有两者。

「副作用」(side effects) 一词的意思是,仅仅通过包含文件,不直接声明类、函数和常量等,而执行的逻辑操作。
「副作用」包含却不仅限于:

  • 生成输出
  • 直接的 requireinclude
  • 连接外部服务
  • 修改 ini 配置
  • 抛出错误或异常
  • 修改全局或静态变量
  • 读或写文件等
  • 以下是一个 反例,一份包含「函数声明」以及产生「副作用」的代码:
  1. <?php
  2. // 「副作用」:修改 ini 配置
  3. ini_set('error_reporting', E_ALL);
  4. // 「副作用」:引入文件
  5. include "file.php";
  6. // 「副作用」:生成输出
  7. echo "<html>\n";
  8. // 声明函数
  9. function foo()
  10. {
  11. // 函数主体部分
  12. }

下面是一个范例,一份只包含声明不产生「副作用」的代码:

  1. <?php
  2. // 声明函数
  3. function foo()
  4. {
  5. // 函数主体部分
  6. }
  7. // 条件声明 **不** 属于「副作用」
  8. if (! function_exists('bar')) {
  9. function bar()
  10. {
  11. // 函数主体部分
  12. }
  13. }

3、命名空间和类

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

  1. <?php
  2. // PHP 5.3及以后版本的写法
  3. namespace Vendor\Model;
  4. class Foo
  5. {
  6. }

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

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

4.1. 常量

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

  1. <?php
  2. namespace Vendor\Model;
  3. class Foo
  4. {
  5. const VERSION = '1.0';
  6. const DATE_APPROVED = '2012-06-01';
  7. }

4.2. 属性

类的属性命名 可以 遵循:

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

4.3. 方法

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

二、PSR-2 编码风格规范

编程风格指南

本篇规范是 [PSR-1][] 基本代码规范的继承与扩展。

本规范希望通过制定一系列规范化PHP代码的规则,以减少在浏览不同作者的代码时,因代码风格的不同而造成不便。
当多名程序员在多个项目中合作时,就需要一个共同的编码规范,

而本文中的风格规范源自于多个不同项目代码风格的共同特性,
因此,本规范的价值在于我们都遵循这个编码风格,而不是在于它本身。

1、概览

  • 代码 必须 遵循 [PSR-1]() 中的编码规范 。
  • 代码 必须 使用4个空格符而不是「Tab 键」进行缩进。
  • 每行的字符数 应该 软性保持在 80 个之内,理论上 一定不可 多于 120 个,但 一定不可 有硬性限制。
  • 每个 namespace 命名空间声明语句和 use 声明语句块后面,必须 插入一个空白行。
  • 类的开始花括号({) 必须 写在函数声明后自成一行,结束花括号(})也 必须 写在函数主体后自成一行。
  • 方法的开始花括号({) 必须 写在函数声明后自成一行,结束花括号(})也 必须 写在函数主体后自成一行。
  • 类的属性和方法 必须 添加访问修饰符(privateprotected 以及 public),abstract 以及 final 必须 声明在访问修饰符之前,而 static 必须 声明在访问修饰符之后。
  • 控制结构的关键字后 必须 要有一个空格符,而调用方法或函数时则 一定不可 有。
  • 控制结构的开始花括号({) 必须 写在声明的同一行,而结束花括号(}) 必须 写在主体后自成一行。
  • 控制结构的开始左括号后和结束右括号前,都 一定不可 有空格符。

1.1. 例子

以下例子程序简单地展示了以上大部分规范:

  1. <?php
  2. namespace Vendor\Package;
  3. use FooInterface;
  4. use BarClass as Bar;
  5. use OtherVendor\OtherPackage\BazClass;
  6. class Foo extends Bar implements FooInterface
  7. {
  8. public function sampleFunction($a, $b = null)
  9. {
  10. if ($a === $b) {
  11. bar();
  12. } elseif ($a > $b) {
  13. $foo->bar($arg1);
  14. } else {
  15. BazClass::bar($arg2, $arg3);
  16. }
  17. }
  18. final public static function bar()
  19. {
  20. // 方法的内容
  21. }
  22. }

2. 通则

2.1 基本编码准则

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

2.2 文件

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

2.3. 行

行的长度 一定不可 有硬性的约束。
软性的长度约束 必须 要限制在 120 个字符以内,若超过此长度,带代码规范检查的编辑器 必须 要发出警告,不过 一定不可 发出错误提示。
每行 不该 多于80个字符,大于80字符的行 应该 折成多行。
非空行后 一定不可 有多余的空格符。
空行 可以 使得阅读代码更加方便以及有助于代码的分块。
每行 一定不可 存在多于一条语句。

2.4. 缩进

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

  1. 备注:使用空格而不是「tab键缩进」的好处在于,
  2. 避免在比较代码差异、打补丁、重阅代码以及注释时产生混淆。
  3. 并且,使用空格缩进,让对齐变得更方便。

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

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

常量 truefalsenull必须 全部小写。

3. namespace 以及 use 声明

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

例如:

  1. <?php
  2. namespace Vendor\Package;
  3. use FooClass;
  4. use BarClass as Bar;
  5. use OtherVendor\OtherPackage\BazClass;
  6. // ... 更多的 PHP 代码在这里 ...

4. 类、属性和方法

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

4.1.扩展与继承

关键词 extendsimplements 必须 写在类名称的同一行。
类的开始花括号 必须 独占一行,结束花括号也 必须 在类主体后独占一行。

  1. <?php
  2. namespace Vendor\Package;
  3. use FooClass;
  4. use BarClass as Bar;
  5. use OtherVendor\OtherPackage\BazClass;
  6. class ClassName extends ParentClass implements \ArrayAccess, \Countable
  7. {
  8. // 这里面是常量、属性、类方法
  9. }

implements 的继承列表也 可以 分成多行,这样的话,每个继承接口名称都 必须 分开独立成行,包括第一个。

  1. <?php
  2. namespace Vendor\Package;
  3. use FooClass;
  4. use BarClass as Bar;
  5. use OtherVendor\OtherPackage\BazClass;
  6. class ClassName extends ParentClass implements
  7. \ArrayAccess,
  8. \Countable,
  9. \Serializable
  10. {
  11. // 这里面是常量、属性、类方法
  12. }

4.2. 属性

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

  1. <?php
  2. namespace Vendor\Package;
  3. class ClassName
  4. {
  5. public $foo = null;
  6. }

4.3. 方法

所有方法都 必须 添加访问修饰符。
不该 使用下划线作为前缀,来区分方法是 protected 或 private。
方法名称后 一定不可 有空格符,其开始花括号 必须 独占一行,结束花括号也 必须 在方法主体后单独成一行。参数左括号后和右括号前 一定不可 有空格。
一个标准的方法声明可参照以下范例,留意其括号、逗号、空格以及花括号的位置。

  1. <?php
  2. namespace Vendor\Package;
  3. class ClassName
  4. {
  5. public function fooBarBaz($arg1, &$arg2, $arg3 = [])
  6. {
  7. // method body
  8. }
  9. }

4.4. 方法的参数

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

  1. <?php
  2. namespace Vendor\Package;
  3. class ClassName
  4. {
  5. public function foo($arg1, &$arg2, $arg3 = [])
  6. {
  7. // method body
  8. }
  9. }

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

  1. <?php
  2. namespace Vendor\Package;
  3. class ClassName
  4. {
  5. public function aVeryLongMethodName(
  6. ClassTypeHint $arg1,
  7. &$arg2,
  8. array $arg3 = []
  9. ) {
  10. // 方法的内容
  11. }
  12. }

4.5. abstractfinal 、 以及 static

需要添加 abstractfinal 声明时,必须 写在访问修饰符前,而 static必须 写在其后。

  1. <?php
  2. namespace Vendor\Package;
  3. abstract class ClassName
  4. {
  5. protected static $foo;
  6. abstract protected function zim();
  7. final public static function bar()
  8. {
  9. // method body
  10. }
  11. }

4.6. 方法及函数调用

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

  1. <?php
  2. bar();
  3. $foo->bar($arg1);
  4. Foo::bar($arg2, $arg3);

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

  1. <?php
  2. $foo->bar(
  3. $longArgument,
  4. $longerArgument,
  5. $muchLongerArgument
  6. );

5. 控制结构

控制结构的基本规范如下:

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

5.1. ifelseifelse

标准的 if 结构如下代码所示,请留意「括号」、「空格」以及「花括号」的位置,
注意 elseelseif 都与前面的结束花括号在同一行。

  1. <?php
  2. if ($expr1) {
  3. // if body
  4. } elseif ($expr2) {
  5. // elseif body
  6. } else {
  7. // else body;
  8. }

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

5.2. switchcase

标准的 switch 结构如下代码所示,留意括号、空格以及花括号的位置。
case 语句 必须 相对 switch 进行一次缩进,而 break 语句以及 case 内的其它语句都 必须 相对 case 进行一次缩进。
如果存在非空的 case 直穿语句,主体里 必须 有类似 // no break 的注释。

  1. <?php
  2. switch ($expr) {
  3. case 0:
  4. echo 'First case, with a break';
  5. break;
  6. case 1:
  7. echo 'Second case, which falls through';
  8. // no break
  9. case 2:
  10. case 3:
  11. case 4:
  12. echo 'Third case, return instead of break';
  13. return;
  14. default:
  15. echo 'Default case';
  16. break;
  17. }

5.3. whiledo while

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

  1. <?php
  2. while ($expr) {
  3. // structure body
  4. }

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

  1. <?php
  2. do {
  3. // structure body;
  4. } while ($expr);

5.4. for

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

  1. <?php
  2. for ($i = 0; $i < 10; $i++) {
  3. // for body
  4. }

5.5. foreach

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

  1. <?php
  2. foreach ($iterable as $key => $value) {
  3. // foreach body
  4. }

5.6. try, catch

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

  1. <?php
  2. try {
  3. // try body
  4. } catch (FirstExceptionType $e) {
  5. // catch body
  6. } catch (OtherExceptionType $e) {
  7. // catch body
  8. }

6. 闭包

闭包声明时,关键词 function 后以及关键词 use 的前后都 必须 要有一个空格。
开始花括号 必须 写在声明的同一行,结束花括号 必须 紧跟主体结束的下一行。
参数列表和变量列表的左括号后以及右括号前,一定不可 有空格。
参数和变量列表中,逗号前 一定不可 有空格,而逗号后 必须 要有空格。
闭包中有默认值的参数 必须 放到列表的后面。
标准的闭包声明语句如下所示,注意其「括号」、「空格」以及「花括号」的位置。

  1. <?php
  2. $closureWithArgs = function ($arg1, $arg2) {
  3. // body
  4. };
  5. $closureWithArgsAndVars = function ($arg1, $arg2) use ($var1, $var2) {
  6. // body
  7. };

参数列表以及变量列表 可以 分成多行,这样,包括第一个在内的每个参数或变量都 必须 单独成行,而列表的右括号与闭包的开始花括号 必须 放在同一行。
以下几个例子,包含了参数和变量列表被分成多行的多情况。

  1. <?php
  2. $longArgs_noVars = function (
  3. $longArgument,
  4. $longerArgument,
  5. $muchLongerArgument
  6. ) {
  7. // body
  8. };
  9. $noArgs_longVars = function () use (
  10. $longVar1,
  11. $longerVar2,
  12. $muchLongerVar3
  13. ) {
  14. // body
  15. };
  16. $longArgs_longVars = function (
  17. $longArgument,
  18. $longerArgument,
  19. $muchLongerArgument
  20. ) use (
  21. $longVar1,
  22. $longerVar2,
  23. $muchLongerVar3
  24. ) {
  25. // body
  26. };
  27. $longArgs_shortVars = function (
  28. $longArgument,
  29. $longerArgument,
  30. $muchLongerArgument
  31. ) use ($var1) {
  32. // body
  33. };
  34. $shortArgs_longVars = function ($arg) use (
  35. $longVar1,
  36. $longerVar2,
  37. $muchLongerVar3
  38. ) {
  39. // body
  40. };

注意,闭包被直接用作函数或方法调用的参数时,以上规则仍然适用。

  1. <?php
  2. $foo->bar(
  3. $arg1,
  4. function ($arg2) use ($var1) {
  5. // body
  6. },
  7. $arg3
  8. );

三、PSR-4 自动加载规范

1. 概述

本 PSR 是关于由文件路径 自动载入 对应类的相关规范,
本规范是可互操作的,可以作为任一自动载入规范的补充,其中包括 [PSR-0](),此外,
本 PSR 还包括自动载入的类对应的文件存放路径规范。

2. 详细说明

2.1. 此处的「类」泛指所有的「Class类」、「接口」、「traits 可复用代码块」以及其它类似结构。

2.2. 一个完整的类名需具有以下结构: \<命名空间>(\<子命名空间>)*\<类名>

  • 完整的类名 必须 要有一个顶级命名空间,被称为 “vendor namespace”;
  • 完整的类名 可以 有一个或多个子命名空间;
  • 完整的类名 必须 有一个最终的类名;
  • 完整的类名中任意一部分中的下滑线都是没有特殊含义的;
  • 完整的类名 可以 由任意大小写字母组成;
  • 所有类名都 必须 是大小写敏感的。

2.3. 当根据完整的类名载入相应的文件

  • 完整的类名中,去掉最前面的命名空间分隔符,前面连续的一个或多个命名空间和子命名空间,作为「命名空间前缀」,其必须与至少一个「文件基目录」相对应;
  • 紧接命名空间前缀后的子命名空间 必须 与相应的「文件基目录」相匹配,其中的命名空间分隔符将作为目录分隔符。
  • 末尾的类名 必须 与对应的以 .php 为后缀的文件同名。
  • 自动加载器(autoloader)的实现 一定不可 抛出异常、一定不可 触发任一级别的错误信息以及 不应该 有返回值。

3. 例子

下表展示了符合规范完整类名、命名空间前缀和文件基目录所对应的文件路径。

完整类名 命名空间前缀 文件基目录 文件路径
\Acme\Log\Writer\File_Writer Acme\Log\Writer ./acme-log-writer/lib/ ./acme-log-writer/lib/File_Writer.php
\Symfony\Core\Request Symfony\Core ./vendor/Symfony/Core/ ./vendor/Symfony/Core/Request.php
\Zend\Acl Zend /usr/includes/Zend/ /usr/includes/Zend/Acl.php


评论 0

发表评论

Top