PHP 规范之PSR规范

概述

PSR 不是PHP官方标准，而是从如Zend、Symfony2等知名PHP项目中提炼出来的一系列标准，目前有越来越多的社区项目加入并遵循该标准。

参考：http://psr.phphub.org/

PSR-0 自动加载 X已废弃
PSR-1 基本代码规范
PSR-2 代码样式
PSR-3 日志接口
PSR-4 如何指定文件路径从而自动加载类定义

PSR-1基本代码规范

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

文件

PHP代码文件必须以 <?php 或 <?= 标签开始；
PHP代码文件必须以不带 BOM 的 UTF-8 编码；
PHP代码中应该只定义类、函数、常量等声明，或其他会产生副作用的操作

（如：生成文件输出以及修改 .ini配置文件等），二者只能选其一；

命名空间与类

类命名必须遵循 StudlyCaps 大写开头的驼峰命名规范；
每个类都独立为一个文件，且命名空间至少有一个层次：顶级的组织名称（vendorname）
类属性：小写开头驼峰 $studlyCaps
类方法：小写开头驼峰

常量

类中的常量所有字母都必须大写，单词间用下划线分隔；
方法名称必须符合 camelCase 式的小写开头驼峰命名规范。

PSR-2编码风格规范

缩进

代码必须使用4个空格符而不是「Tab 键」进行缩进。

行

每行的字符数应该软性保持在 80 个之内，一定不可多于 120 个，但一定不可有硬性限制。
所有PHP文件必须以一个空白行作为结束。
每行一定不可存在多于一条语句每个 namespace 命名空间声明语句和 use 声明语句块后面，必须插入一个空白行。
类的开始花括号（{）必须写在函数声明后自成一行，结束花括号（}）也必须写在函数主体后自成一行。
方法的开始花括号（{）必须写在函数声明后自成一行，结束花括号（}）也必须写在函数主体后自成一行。
控制结构的开始花括号（{）必须写在声明的同一行，而结束花括号（}）必须写在主体后自成一行。

修饰符

类的属性和方法必须添加访问修饰符（private、protected 以及 public），abstract 以及final 必须声明在访问修饰符之前，而 static 必须声明在访问修饰符之后。

空格

类方法参数每个逗号后面必须要有一个空格，而逗号前面一定不可有空格
控制结构的开始左括号后和结束右括号前，都一定不可有空格符。

关键字

控制结构的关键字后必须要有一个空格符，而调用方法或函数时则一定不可有。
PHP所有关键字必须全部小写，常量 true 、false 和 null 也必须全部小写。

PSR-3日志接口规范

LoggerInterface 接口对外定义了八个方法，分别用来记录 RFC 5424 中定义的八个等级的日志：debug、 info、 notice、 warning、 error、 critical、 alert 以及 emergency 。
第九个方法 —— log，其第一个参数为记录的等级。可使用一个预先定义的等级常量作为参数来调用此方法，必须与直接调用以上八个方法具有相同的效果。
如果传入的等级常量参数没有预先定义，则必须抛出PsrLogInvalidArgumentException 类型的异常。在不确定的情况下，使用者不该使用未支持的等级常量来调用此方法。

/*** 日志等级常量定义*/class LogLevel{constEMERGENCY='emergency';constALERT     ='alert';constCRITICAL  ='critical';constERROR     ='error';constWARNING   ='warning';constNOTICE    ='notice';constINFO      ='info';constDEBUG     ='debug';}

PSR-4自动加载规范

类似如下范例：<NamespaceName>(<SubNamespaceNames>)*<ClassName>

完全合规类名必须有一个顶级命名空间（Vendor Name）
完全合规类名可以有多个子命名空间
完全合规类名应该有一个终止类名
下划线在完全合规类名中是没有特殊含义的
字母在完全合规类名中可以是任何大小写的组合
所有类名必须以大小写敏感的方式引用
终止类名对应一个以 .php 结尾的文件。文件名必须和终止类名大小写匹配

一些实际商用项目中使用的规范

控制层

不出现sql语句(sql封装到模型层然后作为方法调用)
sql语句、3行以上逻辑代码空行
上下文关系函数或方法间不空行
bool使用if(true === $name)的形式
使用双引号链接变量
注意隐式转换
使用全局变量需要注释其含义，取值范围：

8 函数头部如下注释：

或者

9 注释间空行：

10 文件头部注释:

或者

11 switch语句的case跳转需要注释

12 标记变量的命名：

13 接口的命名前缀

14 状态码尽量使用常量，而不是难以理解的数字

15 类文件名使用首大写驼峰方式，普通文件名使用下划线方式

16 配置里的变量名使用下划线方式