PHP 标准规范,PSR-1，PSR-2，PSR-3，PSR-4，PSR-5，PSR-6，PSR-7及其他标准

最新推荐文章于 2023-04-12 10:42:33 发布

weixin_33841503

最新推荐文章于 2023-04-12 10:42:33 发布

阅读量734

点赞数

文章标签： php 数据库

原文链接：http://www.cnblogs.com/zx-admin/p/7070160.html

版权

官方网站：https://psr.phphub.org/ 这里还有其他很多规范，但是很多都是英文。

github：https://github.com/summerblue/psr.phphub.org/tree/master/psrs

这些都是开发规范，越规范越好，个人观点，当然根据实际业务情况，最好是遵守规范，这样项目的延续性会更好，如果你想挖坑.....

PSR-1 基础编码规范

基本代码规范

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

关于「能愿动词」的使用

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

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

参见：RFC 2119

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) 一词的意思是，仅仅通过包含文件，不直接声明类、函数和常量等，而执行的逻辑操作。

「副作用」包含却不仅限于：

生成输出
直接的 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()  {  // 函数主体部分  } }

命名空间和类

命名空间以及类的命名必须遵循 PSR-4。

根据规范，每个类都独立为一个文件，且命名空间至少有一个层次：顶级的组织名称（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 { }

类的常量、属性和方法

此处的「类」指代所有的类、接口以及可复用代码块（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 中的编码规范。
代码必须使用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文件必须以一个空白行作为结束。

纯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 声明语句块后必须要有一个空白行。

例如：

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

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 );

总结

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

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

本规范之后的修订与扩展将弥补以上不足。

PSR-3 日志接口规范

规范说明

1.1 基本规范

LoggerInterface 接口对外定义了八个方法，分别用来记录 RFC 5424 中定义的八个等级的日志：debug、 info、 notice、 warning、 error、 critical、 alert 以及 emergency 。
第九个方法 —— log，其第一个参数为记录的等级。可使用一个预先定义的等级常量作为参数来调用此方法，必须与直接调用以上八个方法具有相同的效果。如果传入的等级常量参数没有预先定义，则必须抛出 Psr\Log\InvalidArgumentException 类型的异常。在不确定的情况下，使用者不该使用未支持的等级常量来调用此方法。

1.2 记录信息

以上每个方法都接受一个字符串类型或者是有 __toString() 方法的对象作为记录信息参数，这样，实现者就能把它当成字符串来处理，否则实现者必须自己把它转换成字符串。

记录信息参数可以携带占位符，实现者可以根据上下文将其它替换成相应的值。

其中占位符必须与上下文数组中的键名保持一致。

占位符的名称必须由一个左花括号 { 以及一个右括号 } 包含。但花括号与名称之间一定不可有空格符。

占位符的名称应该只由 A-Z、a-z、0-9、下划线 _、以及英文的句号 . 组成，其它字符作为将来占位符规范的保留。

实现者可以通过对占位符采用不同的转义和转换策略，来生成最终的日志。而使用者在不知道上下文的前提下，不该提前转义占位符。

以下是一个占位符使用的例子：

/**
 * 用上下文信息替换记录信息中的占位符
 */ function interpolate($message, array $context = array()) {  // 构建一个花括号包含的键名的替换数组  $replace = array();  foreach ($context as $key => $val) {  $replace['{' . $key . '}'] = $val;  }   // 替换记录信息中的占位符，最后返回修改后的记录信息。  return strtr($message, $replace); }  // 含有带花括号占位符的记录信息。 $message = "User {username} created";  // 带有替换信息的上下文数组，键名为占位符名称，键值为替换值。 $context = array('username' => 'bolivar');  // 输出 "Username bolivar created" echo interpolate($message, $context);

1.3 上下文

每个记录函数都接受一个上下文数组参数，用来装载字符串类型无法表示的信息。它可以装载任何信息，所以实现者必须确保能正确处理其装载的信息，对于其装载的数据，一定不可抛出异常，或产生PHP出错、警告或提醒信息（error、warning、notice）。
如需通过上下文参数传入了一个 Exception 对象，必须以 exception 作为键名。记录异常信息是很普遍的，所以如果它能够在记录类库的底层实现，就能够让实现者从异常信息中抽丝剥茧。当然，实现者在使用它时，必须确保键名为 exception 的键值是否真的是一个 Exception，毕竟它可以装载任何信息。

1.4 助手类和接口

Psr\Log\AbstractLogger 类使得只需继承它和实现其中的 log 方法，就能够很轻易地实现 LoggerInterface 接口，而另外八个方法就能够把记录信息和上下文信息传给它。
同样地，使用 Psr\Log\LoggerTrait 也只需实现其中的 log 方法。不过，需要特别注意的是，在 traits 可复用代码块还不能实现接口前，还需要 implement LoggerInterface。
在没有可用的日志记录器时，Psr\Log\NullLogger 接口可以为使用者提供一个备用的日志「黑洞」。不过，当上下文的构建非常消耗资源时，带条件检查的日志记录或许是更好的办法。
Psr\Log\LoggerAwareInterface 接口仅包括一个 setLogger(LoggerInterface $logger) 方法，框架可以使用它实现自动连接任意的日志记录实例。
Psr\Log\LoggerAwareTrait trait可复用代码块可以在任何的类里面使用，只需通过它提供的 $this->logger，就可以轻松地实现等同的接口。
Psr\Log\LogLevel 类装载了八个记录等级常量。

2. 包

上述的接口、类和相关的异常类，以及一系列的实现检测文件，都包含在 psr/log 文件包中。

3. `Psr\Log\LoggerInterface`

<?php

namespace Psr\Log;  /**  * 日志记录实例  *  * 日志信息变量 —— message，**必须** 是一个字符串或是实现了 __toString() 方法的对象。  *  * 日志信息变量中 **可以** 包含格式如 “{foo}” (代表 foo) 的占位符，  * 它将会由上下文数组中键名为「foo」的键值替代。  *  * 上下文数组可以携带任意的数据，唯一的限制是，当它携带的是一个 exception 对象时，它的键名 **必须** 是 "exception"。  *  * 详情可参阅： https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-3-logger-interface-cn.md  */ interface LoggerInterface {  /**  * 系统不可用  *  * @param string $message  * @param array $context  * @return null  */  public function emergency($message, array $context = array());   /**  * **必须** 立刻采取行动  *  * 例如：在整个网站都垮掉了、数据库不可用了或者其他的情况下， **应该** 发送一条警报短信把你叫醒。  *  * @param string $message  * @param array $context  * @return null  */  public function alert($message, array $context = array());   /**  * 紧急情况  *  * 例如：程序组件不可用或者出现非预期的异常。  *  * @param string $message  * @param array $context  * @return null  */  public function critical($message, array $context = array());   /**  * 运行时出现的错误，不需要立刻采取行动，但必须记录下来以备检测。  *  * @param string $message  * @param array $context  * @return null  */  public function error($message, array $context = array());   /**  * 出现非错误性的异常。  *  * 例如：使用了被弃用的API、错误地使用了API或者非预想的不必要错误。  *  * @param string $message  * @param array $context  * @return null  */  public function warning($message, array $context = array());   /**  * 一般性重要的事件。  *  * @param string $message  * @param array $context  * @return null  */  public function notice($message, array $context = array());   /**  * 重要事件  *  * 例如：用户登录和SQL记录。  *  * @param string $message  * @param array $context  * @return null

转载于:https://www.cnblogs.com/zx-admin/p/7070160.html

weixin_33841503

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
PHP 标准规范,PSR-1，PSR-2，PSR-3，PSR-4，PSR-5，PSR-6，PSR-7及其他标准

官方网站：https://psr.phphub.org/ 这里还有其他很多规范，但是很多都是英文。 github：https://github.com/summerblue/psr.phphub.org/tree/master/psrs这些都是开发规范，越规范越好，个人观点，当然根据实际业务情况，最好是遵守规范，这样项目的延续性会更好，如果你想挖坑.....PSR-1 基础...
复制链接

扫一扫