PHP编码规范(中文版)——PSR-4

引言

是PHP Standard Recommendation的简写,它其实应该叫PSRs,即系列推荐标准:目前通过的规范有PSR-0(Autoloading Standard)、PSR-1(Basic Coding Standard)、PSR-2(Coding Style Guide)、PSR-3(Logger Interface)、PSR-4(Improved Autoloading)。它不是PHP官方标准,而是从如Zend、Symfony2等知名PHP项目中提炼出来的一系列标准,目前有越来有多的社区项目加入成员并遵循该标准。

PHP-FIG— PHP Framework Interoperability Group, 是制定PSRs开发规范的组织,它的成员由很多知名PHP社区项目组成,在其官网首页下方可以看到成员清单。这些成员制定规范,并且落实在自己的项目中。

其实各个PSR规范的内容都很简洁明了,比起那些动则几十页的规范,真是好太多了。


关键词 “必须”(“MUST”)、“一定不可/一定不能”(“MUST NOT”)、“需要”(“REQUIRED”)、 “将会”(“SHALL”)、“不会”(“SHALL NOT”)、“应该”(“SHOULD”)、“不该”(“SHOULD NOT”)、 “推荐”(“RECOMMENDED”)、“可以”(“MAY”)和”可选“(“OPTIONAL”)的详细描述可参见 [RFC 2119][] 。

1. 概述

本 PSR 是关于由文件路径自动载入对应类的相关规范, 本规范是可互操作的,可以作为任一自动载入规范的补充,其中包括PSR-0,此外, 本 PSR 还包括自动载入的类对应的文件存放路径规范。

2. 详细说明

1、此处的“类”泛指所有的class类、接口、traits可复用代码块以及其它类似结构。

2、一个完整的类名需具有以下结构:

\<命名空间>(\<子命名空间>)*\<类名>

1)完整的类名必须要有一个顶级命名空间,被称为 “vendor namespace”;

2)完整的类名可以有一个或多个子命名空间;

3)完整的类名必须有一个最终的类名;

4)完整的类名中任意一部分中的下滑线都是没有特殊含义的;

5)完整的类名可以由任意大小写字母组成;

6)所有类名都必须是大小写敏感的。

3、当根据完整的类名载入相应的文件……

1)完整的类名中,去掉最前面的命名空间分隔符,前面连续的一个或多个命名空间和子命名空间,作为“命名空间前缀”,其必须与至少一个“文件基目录”相对应;

2)紧接命名空间前缀后的子命名空间必须与相应的”文件基目录“相匹配,其中的命名空间分隔符将作为目录分隔符。

3)末尾的类名必须与对应的以.php为后缀的文件同名。

4)自动加载器(autoloader)的实现一定不能抛出异常、一定不能触发任一级别的错误信息以及不应该有返回值。

3. 例子

下表展示了符合规范完整类名、命名空间前缀和文件基目录所对应的文件路径。

PHP编码规范(中文版)——PSR-4_第1张图片

关于本规范的实现,可参阅相关实例

注意:实例并属于规范的一部分,且随时有所变动

官方文档:http://www.php-fig.org/psr/psr-4/

GitHub:https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md

你可能感兴趣的:(PHP编码规范(中文版)——PSR-4)