PHP标准规范PSR
PSR 是 PHP Standard Recommendations 的简写,由 PHP FIG (opens new window) 组织制定的 PHP 规范,是 PHP 开发的实践标准。
目前已表决通过了 6 套标准,已经得到大部分 PHP 框架的支持和认可。
- PSR-1:基础编码规范 (opens new window)
- PSR-2:编码风格规范 (opens new window)
- PSR-3:日志接口规范 (opens new window)
- PSR-4:自动加载规范 (opens new window)
- PSR-5:缓存接口规范 (opens new window)
- PSR-7:HTTP 消息接口规范 (opens new window)
# PSR-1 基础编码规范
- PHP 代码文件 必须 以
<?php
或<?=
标签开始; - PHP 代码文件 必须 以
不带 BOM 的 UTF-8
编码; - PHP 代码中 应该 只定义类、函数、常量等声明,或其他会产生
副作用
的操作(如:生成文件输出以及修改 .ini 配置文件等),二者只能选其一; - 命名空间以及类 必须 符合 PSR 的自动加载规范:PSR-4 (opens new window) 中的一个;
- 类的命名 必须 遵循
StudlyCaps
大写开头的驼峰命名规范; - 类中的常量所有字母都 必须 大写,单词间用下划线分隔;
- 方法名称 必须 符合
camelCase
式的小写开头驼峰命名规范。
# PSR-2 编码风格规范
- 代码 必须 遵循 PSR-1 (opens new window) 中的编码规范 。
- 代码 必须 使用 4 个空格符而不是「Tab 键」进行缩进。
- 每行的字符数 应该 软性保持在 80 个之内,理论上 一定不可 多于 120 个,但 一定不可 有硬性限制。
- 每个
namespace
命名空间声明语句和use
声明语句块后面,必须 插入一个空白行。 - 类的开始花括号(
{
) 必须 写在类声明后自成一行,结束花括号(}
)也 必须 写在类主体后自成一行。 - 方法的开始花括号(
{
) 必须 写在函数声明后自成一行,结束花括号(}
)也 必须 写在函数主体后自成一行。 - 类的属性和方法 必须 添加访问修饰符(
private
、protected
以及public
),abstract
以及final
必须 声明在访问修饰符之前,而static
必须 声明在访问修饰符之后。 - 控制结构的关键字后 必须 要有一个空格符,而调用方法或函数时则 一定不可 有。
- 控制结构的开始花括号(
{
) 必须 写在声明的同一行,而结束花括号(}
) 必须 写在主体后自成一行。 - 控制结构的开始左括号后和结束右括号前,都 一定不可 有空格符。
# PSR-3 日志接口规范
- 日志接口提供了8个级别的日志方法包含(debug\info\notice\warning\error\critical\alert\emergency),log方法接受日志级别作为第一个参数
- 每一个方法都接受一个字符串作为一个描述,或者是实现了
__toString()
方法的类 - 每一个方法都接受一个数组类型的上下文数据
Psr\Log\AbstractLogger
是实现日志接口的好的方式,Psr\Log\LoggerTrait
仅仅需要实现log方法,Psr\Log\NullLogger
空日志接口,Psr\Log\LoggerAwareInterface
可以wrapper一个logger,Psr\Log\LogLevel
包含8个日志级别
# PSR-4 自动加载规范
- 适用于类、接口、traits和其他相似的结构
- 一个完全限定的类名具备如下结构
\NamespaceName\SubNamespaceName*\ClassName
, 即包含顶级的命名空间as a vendor namespace
,或许包含一个或者多个子命名空间,必须包含一个类名,下划线不再具有任何意义,类名大小写敏感。自动加载不能抛出异常,不报错,不返回任何值
# PSR-7 HTTP 消息接口规范
- 包含
Psr\Http\Message\RequestInterface和Psr\Http\Message\ResponseInterface
,这两个接口都是扩展Psr\Http\Message\MessageInterface
而来 - http头大小写不敏感
上次更新: 2022/12/02, 22:04:34