「PSR 规范」PSR-1 基础编码规范

2021-07-28 本文已影响0人晨曦入诗

基本代码规范

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

关于「能愿动词」的使用

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

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

1. 概览

PHP 代码文件必须以 <?php 或 <?= 标签开始；
PHP 代码必须以 不带 BOM 的 UTF-8 编码；
PHP 代码中应该只定义类、函数、常量等声明，或其他会产生 副作用 的操作（如：生成文件输出以及修改 .ini 配置文件等），二者只能选择其一；
命名空间以及类必须符合 PSR 的自动加载规范：PSR-4 中的一个；
类的命名必须遵循 StudyCaps 大写开头的驼峰命名规范；
类中常量的所有字母都必须大写，单词间用下划线分割；
方法名称必须符合 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);
//「副作用」：引入文件
inclde "file.php";
//「副作用」：生成输出
echo "<html>\n";
//声明函数
function foo()
{
      //函数主体部分
}

下面是一个示例，一份只包含声明不产生「副作用」的代码：

<?php
//声明函数
function foo()
{
    //函数主题部分
}

//条件声明函数 **不** 属于「副作用」
if (! function_exists('bar')){
    function bar()
    {
      //函数主题部分
    }
}

3. 命名空间和类

命名空间以及类的命名必须遵守 PSR-4。
根据规范，每个类都独立为一个文件，且命名空间至少有一个层次：顶级的组织命名（vemdor name）。
类的命名必须遵循 StudyCaps 大写开头的驼峰式命名规范。
PHP 5.3 及以后版本的代码必须使用正式的命名空间。
例如：

<?php
//PHP 5.3 及以后版本的写法
namespace Vendor\Model;

class foo
{

}

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

<?php
//PHP 5.2.x 及之前版本的写法
class Vendor_Model_foo
{

}

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

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

4.1.常量

类的常量中所有字母必须大写，词间一下花谢分割。
参照一下代码：

<?php
namespace Vendor\Model;

class foo
{
    const VERSION = '1.0';
    const DATE_APPROVED = '2021-07-28';

}

4.2. 属性

类的属性命名可以遵循：

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

4.3.方法

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