PHP-FIG
在说啥是PSR-[0-4]规范的之前,我觉得我们有必要说下它的发明者和规范者:PHP-FIG,它的网站是:www.php-fig.org。就是这个联盟组织发明和创造了PSR-[0-4]规范,FIG 是 Framework Interoperability Group(框架可互用性小组)的缩写,由几位开源框架的开发者成立于 2009 年,从那开始也选取了很多其他成员进来,虽然不是 “官方” 组织,但也代表了社区中不小的一块。组织的目的在于:以最低程度的限制,来统一各个项目的编码规范,避免各家自行发展的风格阻碍了程序设计师开发的困扰,于是大伙发明和总结了PSR,PSR是Proposing a Standards Recommendation(提出标准建议)的缩写,截止到目前为止,总共有5套PSR规范,分别是:
psr-0与psr-4的区别:
PSR-0:
- 一个标准的命名空间与类名称的定义必须符合以下结构:\<Vendor Name><Namespace>*(ClassName)
- 其中Vendor Name 为每个命名空间都必须要有的一个顶级命名空间名
- 需要的话,每个命名空间下可以拥有多个子命名空间
- 当根据完整的命名空间名从文件系统中载入类文件时,每个命名空间之间的分隔符都会被转换成文件夹路径分隔符
- 类命名中的每个_字符也会被转换成文件夹路径分隔符,而命名空间中的_字符则是无特殊含义的。
- 当从文件系统中载入标准的命名空间或类时,都将添加.php为目标文件后缀
- 组织名称(Vendor Name)、命名空间(Namespace)以及类的名称(Class Name)可由任意大小写字母组成。
PSR-1
- PHP代码文件必须以<?php 或<?= 标签开头
- PHP代码文件必须以不带BOM的UTF-8编码
- PHP代码中应该只定义类、函数、常量等声明,或其他会产生从属效应的操作(生成文件输出以及修改.ini配置文件等),二者只能选其一
- 命名空间以及类必须符合PSR的自动加载规范:PSR-4;
- 类的命名必须遵循StudlyCaps大写开头的驼峰命名规范;
- 类中的常量所有字母都必须大写,单词间用下划线分隔;
- 方法名称必须符合camelCase式的小写开头驼峰命名规范
PSR-2
- 代码必须遵循PSR-1中的编码规范
- 代码必须使用四个空格符而不是tab键进行缩进。
- 每行的字符数应该软性保持在80个内,理论上不可多于120个,但一定不能由硬性限制
- 每个namespace命名空间声明语句和use声明语句块后面,必须插入一个空白行
- 类的开始花名号({)必须在函数声明后自成一行,结束花名号(})也必须在函数主体后自成一行
- 类的属性和方法必须添加访问修饰符(private protected以及public),abstract以及final必须声明在访问修饰符之前,而static必须声明在访问修饰符之后。
- 控制结构的关键字后必须要有一个空格符,而调用方法或函数时则一定不能有。
- 控制结构的开始花括号({)必须写在声明的同一行,而结束花括号(})必须写在主体后自成一行。
- 控制结构的开始左括号后和结束右括号前,都一定不能有空格符。
PSR-3
- LoggerInterface 接口对外定义了八个方法,分别用来记录RFC 5424中定义的八个登记日志:debug、info、notice、warning、error、critical、alert以及emergency。
- 第九个方法-log,其第一个参数为记录的等级,可使用一个预先定义的等级常量作为参数来调用此方法,必须与直接调用以上八个方法具有相同的效果。如果传入的等级常量参数没有预先定义,就必须抛出Psr\Log\InvalidArgumentException类型的异常,在不确定的情况下,使用者不该使用为支持的等级常量来调用此方法。
PSR-4
- 此处的“类”泛指所有的class类、接口、traits可复用代码块以及其他类似结构。
- 一个完整的类名需要具有以下结构
- \<命名空间>(\<子命名空间>)*\<类名>
- 1.完整的类名必须要有一个顶级命名空间,被称为“Vendor namespace”
- 2.完成的类名可以有一个或多个子命名空间
- 3.完整的类名必须有一个最终的类名
- 4.完整的类名中任意一部分中的下划线都是没有特殊意义的
- 5.完整的类名可以由任意大小写字母组成
- 6.所有类名都必须是大小写敏感的
- 当根据完整的类名载入相应的文件……
- 1.完整的类名中,去掉最前面的命名空间分隔符,前面连续的一个或多个命名空间和子命名空间,作为“命名空间前缀”,其必须与至少一个“文件基目录”相对应。
- 2.紧接命名空间前缀后的子命名空间必须与相对应的“文件基目录”相匹配,其中的命名空间分隔符作为目录分割符
- 3.末尾的类名必须与对应的.php为后缀的文件同名
- 4.自动加载器(autoloader)的实现一定不能抛出异常,一定不能触发任一级别的错误信息以及不应该有返回值。
综合实例:
<?php
namespace Standard; // 顶部命名空间
// 空一行
use Test\TestClass;//use引入类
/**
* 类描述
*
* 类名必须大写开头驼峰.
*/
abstract class StandardExample // {}必须换行
{
/**
* 常量描述.
*
* @var string
*/
const THIS_IS_A_CONST = ''; // 常量全部大写下划线分割
/**
* 属性描述.
*
* @var string
*/
public $nameTest = ''; // 属性名称建议开头小写驼峰
// 成员属性必须添加public(不能省略), private, protected修饰符
/**
* 属性描述.
*
* @var string
*/
private $_privateNameTest = ''; // 类私有成员属性,【个人建议】下划线小写开头驼峰
/**
* 构造函数.
*
* 构造函数描述
*
* @param string $value 形参名称/描述
*/
public function __construct($value = '')// 成员方法必须添加public(不能省略), private, protected修饰符
{// {}必须换行
$this->nameTest = new TestClass();
// 链式操作
$this->nameTest->functionOne()
->functionTwo()
->functionThree();
// 一段代码逻辑执行完毕 换行
// code...
}
/**
* 成员方法名称.
*
* 成员方法描述
*
* @param string $value 形参名称/描述
*
* @return 返回值类型 返回值描述
* 返回值类型:string,array,object,mixed(多种,不确定的),void(无返回值)
*/
public function testFunction($value = '')// 成员方法必须小写开头驼峰
{
// code...
}
/**
* 成员方法名称.
*
* 成员方法描述
*
* @param string $value 形参名称/描述
*
* @return 返回值类型 返回值描述
*/
private function _privateTestFunction($value = '')// 私有成员方法【个人建议】下划线小写开头驼峰
{
// code...
}
/**
* 成员方法名称.
*
* 成员方法描述
*
* @param string $value 形参名称/描述
*
* @return 返回值类型 返回值描述
*/
public static function staticFunction($value = '')// static位于修饰符之后
{
// code...
}
/**
* 成员方法名称.
*
* 成员方法描述
*
* @param string $value 形参名称/描述
*
* @return 返回值类型 返回值描述
*/
abstract public function abstractFunction($value = ''); // abstract位于修饰符之前
/**
* 成员方法名称.
*
* 成员方法描述
*
* @param string $value 形参名称/描述
*
* @return 返回值类型 返回值描述
*/
final public function finalFunction($value = '')// final位于修饰符之前
{
// code...
}
/**
* 成员方法名称.
*
* 成员方法描述
*
* @param string $valueOne 形参名称/描述
* @param string $valueTwo 形参名称/描述
* @param string $valueThree 形参名称/描述
* @param string $valueFour 形参名称/描述
* @param string $valueFive 形参名称/描述
* @param string $valueSix 形参名称/描述
*
* @return 返回值类型 返回值描述
*/
public function tooLangFunction(
$valueOne = '', // 变量命名可小写开头驼峰或者下划线命名,个人那习惯,据说下划线可读性好
$valueTwo = '',
$valueThree = '',
$valueFour = '',
$valueFive = '',
$valueSix = '')// 参数过多换行
{
if ($valueOne === $valueTwo) {// 控制结构=>后加空格,同{一行,(右边和)左边不加空格
// code...
}
switch ($valueThree) {
case 'value':
// code...
break;
default:
// code...
break;
}
do {
// code...
} while ($valueFour <= 10);
while ($valueFive <= 10) {
// code...
}
for ($i=0; $i < $valueSix; $i++) {
// code...
}
}
}