【PHP开发规范】老生常谈的编码开发规范你懂多少？

这几天看了一下阿里技术发布的一套Java开发规范《阿里巴巴Java开发手册》，里面写了阿里内部的Java开发规范标准，写的很好。这套Java统一规范标准将有助于提高行业编码规范化水平，帮助行业人员提高开发质量和效率、大大降低代码维护成本。

看完我去搜下了一些PHP的一些开发规范标准，其中了解到了PSR规范是PHP行业中常用的一套开发标准。感叹自己学得那么少，标准的规范这么晚才发现。

其实对于新手或者有几年经验的开发者来说，这些规范我们都要掌握的，很多时候我们做好这些规范，在协同开发中，能提高我们的开发质量和效率。

什么是PSR？

PSR 是 PHP Standard Recommendations 的简写，由 PHP FIG 组织制定的 PHP 规范，是 PHP 开发的实践标准。

PHP FIG目前已表决通过了 6 套标准，已经得到大部分 PHP 框架的支持和认可。

其中已经通过的有：

*注：其中PSR-0已被弃用，PSR-5还在起草中，以后再补充

这里先介绍PSR-1 基础编码规范

1. 概览

2. 文件

2.1. PHP标签

PHP代码 必须 使用  长标签 或 = ?> 短输出标签；

一定不可 使用其它自定义标签。

2.2. 字符编码

PHP代码 必须 且只可使用 不带BOM的UTF-8 编码。（这点很重要）

2.3. 副作用

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

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

「副作用」包含却不仅限于：

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

// 「副作用」：修改 ini 配置
ini_set('error_reporting', E_ALL);
// 「副作用」：引入文件
include "file.php";
// 「副作用」：生成输出
echo "n";
// 声明函数
function foo()
{
   // 函数主体部分
}

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

// 声明函数
function foo()
{
   // 函数主体部分
}
// 条件声明 **不** 属于「副作用」
if (! function_exists('bar')) {
   function bar()
   {
       // 函数主体部分
   }
}

3. 命名空间和类

命名空间以及类的命名必须遵循 [PSR-4]()。

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

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

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

例如：

// PHP 5.3及以后版本的写法
namespace VendorModel;
class Foo
{
}

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

// 5.2.x及之前版本的写法
class Vendor_Model_Foo
{
}

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

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

4.1. 常量

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

参照以下代码：

namespace VendorModel;
class Foo
{
   const VERSION = '1.0';
   const DATE_APPROVED = '2012-06-01';
}

4.2. 属性

类的属性命名 可以 遵循：

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

4.3. 方法

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

欢迎关注公众号【php_beginner】获取开发资料