PHP代码规范

PHP编码规范

 

1. 标识符命名规范

标识符的命名力求做到统一、达意和简洁。

 

1.1 统一

统一是指，对于同一个概念，在程序中用同一种表示方法，比如对于供应商，既可以用supplier，也可以用provider，但是我们只能选定一个使用，至少在一个项目中保持统一。统一是作为重要的，如果对同一概念有不同的表示方法，会使代码混乱难以理解。即使不能取得好的名称，但是只要统一，阅读起来也不会太困难，因为阅读者只要理解一次。

1.2 达意

达意是指，标识符能准确的表达出它所代表的意义，比如： newSupplier, OrderPaymentGatewayService等；而 supplier1, service2，idtts等则不是好的命名方式。准确有两成含义，一是正确，而是丰富。如果给一个代表供应商的变量起名是 order，显然没有正确表达。同样的，supplier1, 远没有targetSupplier意义丰富。.

1.3 简洁

简洁是指，在统一和达意的前提下，用尽量少的标识符。如果不能达意，宁愿不要简洁。比如：theOrderNameOfTheTargetSupplierWhichIsTransfered 太长， transferedTargetSupplierOrderName则较好，但是transTgtSplOrdNm就不好了。省略元音的缩写方式不要使用，我们的英语往往还没有好到看得懂奇怪的缩写。

1.4 英文 vs 拼音

尽量使用通俗易懂的英文单词，如果不会可以向队友求助，实在不行则使用汉语拼音，避免拼音与英文混用。比如表示归档，用archive比较好, 用pigeonhole则不好，用guiDang尚可接受。

 

 

 

2基本代码规范

2.1概览

l  PHP代码文件必须以 <?php 或 <?= 标签开始；

l  PHP代码文件必须以 不带BOM的 UTF-8 编码；

l  PHP代码中应该只定义类、函数、常量等声明，或其他会产生 从属效应 的操作（如：生成文件输出以及修改.ini配置文件等），二者只能选其一；

l  命名空间以及类必须符合 PSR 的自动加载规范PSR-4；

l  类的命名必须遵循 StudlyCaps 大写开头的驼峰命名规范；

l  类中的常量所有字母都必须大写，单词间用下划线分隔；

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

2.2文件

2.2.1. PHP标签

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

2.2.2. 字符编码

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

2.2.3. 从属效应（副作用）

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

“从属效应”(side effects)一词的意思是，仅仅通过包含文件，不直接声明类、 函数和常量等，而执行的逻辑操作。

 

“从属效应”包含却不仅限于：生成输出、直接的 require 或 include、连接外部服务、修改 ini 配置、抛出错误或异常、修改全局或静态变量、读或写文件等。

以下是一个反例，一份包含声明以及产生从属效应的代码：

 

下面是一个范例，一份只包含声明不产生从属效应的代码：

 

 

2.3. 命名空间和类

命名空间以及类的命名必须遵循 PSR-4

根据规范，每个类都独立为一个文件，且命名空间至少有一个层次：顶级的组织名称（vendor name）。

类的命名必须 遵循 StudlyCaps 大写开头的驼峰命名规范。

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

例如：

 

 

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

 

 

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

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

 

2.4.1. 常量

类的常量中所有字母都必须大写，词间以下划线分隔。 参照以下代码：

 

 

2.4.2. 属性

类的属性命名可以遵循下划线分隔式 ($under_score)风格。

2.4.3. 方法

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

3.编码风格规范

当多名程序员在多个项目中合作时，就需要一个共同的编码规范，而本文中的风格规范源自于多个不同项目代码风格的共同特性，因此，本规范的价值在于我们都遵循这个编码风格，而不是在于它本身。

3.1. 概览

l  代码必须遵循 PSR-1 中的编码规范。

l  代码必须使用4个空格符而不是 tab键进行缩进。

l  每行的字符数应该软性保持在80个之内，理论上一定不可多于120个，但一定不能有硬性限制。

l  每个 namespace 命名空间声明语句和 use 声明语句块后面，必须插入一个空白行。

l  类的开始花括号({)必须写在函数声明后自成一行，结束花括号(})也必须写在函数主体后自成一行。

l  方法的开始花括号({)必须写在函数声明后自成一行，结束花括号(})也必须写在函数主体后自成一行。

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

l  控制结构的关键字后必须要有一个空格符，而调用方法或函数时则一定不能有。

l  控制结构的开始花括号({)必须写在声明的同一行，而结束花括号(})必须写在主体后自成一行。

l  控制结构的开始左括号后和结束右括号前，都一定不能有空格符。

3.1.1. 例子

以下例子程序简单地展示了以上大部分规范：

 

 

3.2. 通则

3.2.1 基本编码准则

代码必须符合 PSR-1 中的所有规范。

3.2.2 文件

所有PHP文件必须使用Unix LF (linefeed)作为行的结束符。

所有PHP文件必须以一个空白行作为结束。

纯PHP代码文件必须省略最后的 ?> 结束标签。

3.2.3. 行

行的长度一定不能有硬性的约束。

软性的长度约束一定要限制在120个字符以内，若超过此长度，带代码规范检查的编辑器一定要发出警告，不过一定不可发出错误提示。

每行不应该多于80个字符，大于80字符的行应该折成多行。

非空行后一定不能有多余的空格符。

空行可以使得阅读代码更加方便以及有助于代码的分块。

每行一定不能存在多于一条语句。

3.2.4. 缩进

代码必须使用4个空格符的缩进，一定不能用 tab键。

3.2.5. 关键字以及 True/False/Null

PHP所有 关键字必须全部小写。

常量 true 、false 和 null 也必须全部小写。

3.3. namespace 以及 use 声明

namespace 声明后必须插入一个空白行。

所有 use 必须在 namespace 后声明。

每条 use 声明语句必须只有一个 use 关键词。

use 声明语句块后必须要有一个空白行。

例如：

 

 

3.4. 类、属性和方法

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

3.4.1. 扩展与继承

关键词 extends 和 implements必须写在类名称的同一行。

类的开始花括号必须独占一行，结束花括号也必须在类主体后独占一行。

 

 

implements 的继承列表也可以分成多行，这样的话，每个继承接口名称都必须分开独立成行，包括第一个。

 

 

3.4.2. 属性

每个属性都必须添加访问修饰符。

一定不可使用关键字 var 声明一个属性。

每条语句一定不可定义超过一个属性。

不要使用下划线作为前缀，来区分属性是 protected 或 private。

以下是属性声明的一个范例：

 

 

3.4.3. 方法

所有方法都必须添加访问修饰符。

不要使用下划线作为前缀，来区分方法是 protected 或 private。

方法名称后一定不能有空格符，其开始花括号必须独占一行，结束花括号也必须在方法主体后单独成一行。参数左括号后和右括号前一定不能有空格。

一个标准的方法声明可参照以下范例，留意其括号、逗号、空格以及花括号的位置。

 

3.4.4. 方法的参数

参数列表中，每个逗号后面必须要有一个空格，而逗号前面一定不能有空格。

有默认值的参数，必须放到参数列表的末尾。

 

 

参数列表可以分列成多行，这样，包括第一个参数在内的每个参数都必须单独成行。

拆分成多行的参数列表后，结束括号以及方法开始花括号必须写在同一行，中间用一个空格分隔。

 

 

3.4.5. abstract 、 final 、以及 static

需要添加 abstract 或 final 声明时， 必须写在访问修饰符前，而 static 则必须写在其后。

 

 

3.4.6. 方法及函数调用

方法及函数调用时，方法名或函数名与参数左括号之间一定不能有空格，参数右括号前也 一定不能有空格。每个参数前一定不能有空格，但其后必须有一个空格。

 

 

参数可以分列成多行，此时包括第一个参数在内的每个参数都必须单独成行。

 

 

3.5. 控制结构

控制结构的基本规范如下：

l  控制结构关键词后必须有一个空格。

l  左括号 ( 后一定不能有空格。

l  右括号 ) 前也一定不能有空格。

l  右括号 ) 与开始花括号 { 间一定有一个空格。

l  结构体主体一定要有一次缩进。

l  结束花括号 } 一定在结构体主体后单独成行。

每个结构体的主体都必须被包含在成对的花括号之中，这能让结构体更加结构话，以及减少加入新行时，出错的可能性。

3.5.1. if 、 elseif 和 else

标准的 if 结构如下代码所示，留意括号、空格以及花括号的位置，注意 else 和 elseif 都与前面的结束花括号在同一行。

 

 

应该使用关键词 elseif 代替所有 else if ，以使得所有的控制关键字都像是单独的一个词。

3.5.2. switch 和 case

标准的 switch 结构如下代码所示，留意括号、空格以及花括号的位置。 case 语句必须相对 switch 进行一次缩进，而break 语句以及 case 内的其它语句都必须相对 case 进行一次缩进。如果存在非空的 case 直穿语句，主体里必须有类似 // no break 的注释。

 

 

3.5.3. while 和 do while

一个规范的 while 语句应该如下所示，注意其括号、空格以及花括号的位置。

 

 

标准的 do while 语句如下所示，同样的，注意其括号、空格以及花括号的位置。

 

 

3.5.4. for

标准的 for 语句如下所示，注意其括号、空格以及花括号的位置。

 

3.5.5. foreach

标准的 foreach 语句如下所示，注意其括号、空格以及花括号的位置。

 

 

3.5.6. try, catch

标准的 try catch 语句如下所示，注意其括号、空格以及花括号的位置。

 

 

3.6. 闭包

闭包声明时，关键词 function 后以及关键词 use 的前后都必须要有一个空格。

开始花括号必须写在声明的同一行，结束花括号必须紧跟主体结束的下一行。

参数列表和变量列表的左括号后以及右括号前，必须不能有空格。

参数和变量列表中，逗号前必须不能有空格，而逗号后必须要有空格。

闭包中有默认值的参数必须放到列表的后面。

标准的闭包声明语句如下所示，注意其括号、逗号、空格以及花括号的位置。

 

 

参数列表以及变量列表可以分成多行，这样，包括第一个在内的每个参数或变量都必须单独成行，而列表的右括号与闭包的开始花括号必须放在同一行。

以下几个例子，包含了参数和变量列表被分成多行的多情况。

 

 

注意，闭包被直接用作函数或方法调用的参数时，以上规则仍然适用。