分享每一天-PHP中的PSR规范

PHP中的PSR规范

PHP 2192 0 创建时间：2020-05-23 16:22:59

PSR规范 php

## 什么是PSR？
PSR是PHP Standards Recommendation的简称，这个是php-fig组织制定的一套规范。至今，php-fig已经发布了五个规范：

- PSR-0：自动加载标准，2014-10-21该标准已经被废弃，使用PSR-4替代，不再细讲
- PSR-1：基本的编码风格
- PSR-2：编码风格（更严格）
- PSR-3：日志记录器接口
- PSR-4：自动加载

## PSR-1
PHP标签：
PHP代码必须放在<?php ?>标签或<?= ?>标签中。

编码：
PHP文件必须使用无BOM的UTF-8编码。

副作用：
一个PHP文件可以定义符号（比如类、函数、常量等），或者执行只有唯一副作用的操作（比如输出结果、处理数据等），但是不能同时做这两件事，尽量是一个PHP文件的功能单一。在操作的时候尽量把变量、类、函数的声明分开，通过include或require文件的方式来使用。

如下不符合规范：

<?php
    // 改变设置
    ini_set('error_reporting', E_ALL);
    
    // 加载文件
    include "file.php";
    
    // 打印输出
    echo "<html>\n";
    
    // 声明
    function foo()
    {
        // function body
    }

符合规范如下：

```php
<?php
// 声明
function foo()
{
    // function body
}

// 条件判断
if (! function_exists('bar')) {
    function bar()
    {
        // function body
    }
}
```
命名空间和类：
命名空间和类必须遵循PSR-4自动加载器标准。

类的名称：
每个类都有自己的命名空间，且都在顶级命名空间下，类名必须使用驼峰式（CamelCase）。
PHP 5.3 及以上，必须使用正式的命名空间，例如：
 ```php
<?php
// PHP 5.3 及以后
namespace Vendor\Model;

class Foo
{
}
```
常量：
常量必须全部是用大写，并且使用下划线（_）分开。例如：
```php
<?php
namespace Vendor\Model;

class Foo
{
    const VERSION = '1.0';
    const DATE_APPROVED = '2012-06-01';
}
```
类的方法：
类的方法必须使用小写字母开头的驼峰式（camelCase）命名。

## PSR-2
PSR-2是对PSR-1的PHP的扩充。
贯彻PSR-1：
使用PSR-2代码标准之前要先贯彻PSR-1的代码标准。

文件和代码行：
PHP文件必须使用Unix风格的换行符（LF， linefeed），最后要有一个空行，仅包含PHP代码的文件而且不能使用PHP关闭标签?>，每行代码不应该超过80个字符，每行末尾不能有空格，每行只能有一条语句，可以在适当的地方添加空行提高代码的阅读性。

##### 关键字：
PHP的关键字必须使用小写，而且true, false, 和 null也必须小写。

命名空间和use声明：
现在，namespace声明之后必须要有一个空行，而且use声明必须放在namespace之后，必须分别使用use引入命名空间，而且use后要有空行.

##### 类的继承和实现：
extends和implements关键字必须和类名在同一行，类、接口和Traits定义体的起始括号应该在类名之后新起一行，结束括号也必须新起一行

## PSR-3

与PSR-1和PSR-2不同，PSR-3规定了一套通用的日志记录器接口（Psr\Log\LoggerInterface），为了符合PSR-3规范，框架必须实现该规范中的接口，这样可以更多的兼容第三方应用。PSR-3规范中包含了9个方法，每个方法都对应了RFC 5424协议的一个日志级别，而且都接受两个参数$message和$context.....

## PSR-4
PSR-4规范描述了一个标准的自动加载器策略，指在运行时按需查找PHP类、接口或Traits。支持PSR-4自动加载器标准的PHP组建和框架，使用同一个自动加载器就能找到相关代码，然后将其载入PHP解释器。有了这个功能，就可以把现代PHP生态系统中很多客户操作的组件联系起来。
 
参考文档： https://learnku.com/docs/psr

PHP中的PSR规范

商品推荐

广告推荐

推荐文章