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

时间 2019-12-07

原文原文链接

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

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

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

其实对于新手或者有几年经验的开发者来讲，这些规范咱们都要掌握的，不少时候咱们作好这些规范，在协同开发中，能提升咱们的开发质量和效率。缓存

什么是PSR？

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

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

其中已经经过的有：函数

PSR-1 基础编码规范

PSR-2 编码风格规范

PSR-3 日志接口规范

PSR-4 自动加载规范

PSR-6 缓存接口规范

PSR-7 HTTP 消息接口规范

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

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

1. 概览

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

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

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

命名空间以及类必须符合 PSR 的自动加载规范：[PSR-4]() 中的一个；

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

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

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

2. 文件

2.1. PHP标签

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

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

2.2. 字符编码

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

2.3. 反作用

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

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

「反作用」包含却不只限于：

生成输出

直接的 require 或 include

链接外部服务

修改 ini 配置

抛出错误或异常

修改全局或静态变量

读或写文件等

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

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

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

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

3. 命名空间和类

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

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

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

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

例如：

<?php
// PHP 5.3及之后版本的写法
namespace Vendor\Model;
class Foo
{
}

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

<?php
// 5.2.x及以前版本的写法
class Vendor_Model_Foo
{
}

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

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

4.1. 常量

类的常量中全部字母都必须大写，词间如下划线分隔。

参照如下代码：

<?php
namespace Vendor\Model;
class Foo
{
   const VERSION = '1.0';
   const DATE_APPROVED = '2012-06-01';
}

4.2. 属性

类的属性命名能够遵循：

大写开头的驼峰式 ($StudlyCaps)

小写开头的驼峰式 ($camelCase)

下划线分隔式 ($under_score)

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

4.3. 方法

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

参考资料：

https://psr.phphub.org/

------------------------------------------------------------------------------

欢迎关注个人公众号【phper的进阶之路】，将不断更新各类技术心得，免费提供各类学习资源！！！