PSR-1 基础编码规范

2023-06-10 17:34:31 浏览数 (1)

PSR-1 基础编码规范

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

本文中的 必须不得需要不应应该不应该推荐可以可选 等能愿动词按照 RFC 2119 中的描述进行解释。

1. 概览

  • PHP 代码文件 必须<?php<?= 标签开始
  • PHP 代码文件 必须 以 不带BOM的UTF-8 编码
  • PHP 代码中 应该 声明任一标志(类、函数、常量等),或引起副作用(如果一个函数修改了自己范围之外的资源,那就叫做有副作用,如:生成输出以及修改 .ini 配置文件等),但是不应该二者都有
  • 命名空间以及类 必须 符合 PSR 的自动加载规范: [PSR-0(已废弃)或 PSR-4] 中的一个
  • 类的命名 必须 遵循 StudlyCaps 大写开头的驼峰命名规范
  • 类中的常量所有字母都 必须 大写,单词间用下划线分隔
  • 方法名称 必须 符合 camelCase 式的小写开头驼峰命名规范

2. 文件

2.1. PHP 标签

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

2.2. 字符集编码

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

2.3. 副作用

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

副作用 一词的意思是,仅仅通过包含文件,不直接声明类、函数和常量等,而执行的逻辑操作。

副作用包含却不仅限于:生成输出,明确使用 requireinclude,连接到外部服务,修改 ini 设置,发出错误或异常,修改全局或静态变量,读取或写入一个文件,等等。

以下是一个 反例,一份包含「函数声明」以及产生「副作用」的代码:

代码语言:javascript复制
 1<?php
 2// [副作用]:修改 ini 配置
 3ini_set('error_reporting', E_ALL);
 4
 5// [副作用]:引入文件
 6include "file.php";
 7
 8// [副作用]:生成输出
 9echo "<html>n";
10
11// 声明函数
12function foo()
13{
14    // function body
15}

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

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

3. 命名空间和类名

命名空间和类名 必须 遵循 自动加载 规范: [PSR-0, PSR-4]。

这意味着每个类都独立为一个文件,并且至少在一个层次的命名空间内,那就是:顶级组织名(vendor name)。

类名 必须 以类似 StudlyCaps 形式的大写开头的驼峰命名方式声明。

PHP 5.3 及更高版本的代码 必须 使用正式的命名空间。

举个例子:

代码语言:javascript复制
1<?php
2// PHP 5.3 及更高版本:
3namespace VendorModel;
4
5class Foo
6{
7}

PHP 5.2 及更低版本 应该 使用伪命名空间,约定俗成,以顶级组织名称 Vendor_ 为类名前缀:

代码语言:javascript复制
1<?php
2// PHP 5.2.x 及更低版本:
3class Vendor_Model_Foo
4{
5}

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

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

4.1. 常量

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

代码语言:javascript复制
1<?php
2namespace VendorModel;
3
4class Foo
5{
6    const VERSION = '1.0';
7    const DATE_APPROVED = '2012-06-01';
8}

4.2. 属性

类的属性命名 可以 遵循:大写开头的驼峰式 StudlyCaps,小写开头的驼峰式 camelCase,·下划线分隔式

本规范不做强制要求,但无论遵循哪种命名方式,都 应该 在一定的范围内保持一致。这个范围可以是整个团队、整个包、整个类或整个方法。

4.3. 方法

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

0 人点赞