【PHP開發(fā)規(guī)范】老生常談的編碼開發(fā)規(guī)范你懂多少？
這幾天看了一下阿里技術(shù)發(fā)布的一套Java開發(fā)規(guī)范《阿里巴巴Java開發(fā)手冊》，里面寫了阿里內(nèi)部的Java開發(fā)規(guī)范標(biāo)準(zhǔn)，寫的很好。這套Java統(tǒng)一規(guī)范標(biāo)準(zhǔn)將有助于提高行業(yè)編碼規(guī)范化水平，幫助行業(yè)人員提高開發(fā)質(zhì)量和效率、大大降低代碼維護(hù)成本。
看完我去搜下了一些PHP的一些開發(fā)規(guī)范標(biāo)準(zhǔn)，其中了解到了PSR規(guī)范是PHP行業(yè)中常用的一套開發(fā)標(biāo)準(zhǔn)。感嘆自己學(xué)得那么少，標(biāo)準(zhǔn)的規(guī)范這么晚才發(fā)現(xiàn)。
其實對于新手或者有幾年經(jīng)驗的開發(fā)者來說，這些規(guī)范我們都要掌握的，很多時候我們做好這些規(guī)范，在協(xié)同開發(fā)中，能提高我們的開發(fā)質(zhì)量和效率。
什么是PSR？
PSR 是 PHP Standard Recommendations 的簡寫，由 PHP FIG 組織制定的 PHP 規(guī)范，是 PHP 開發(fā)的實踐標(biāo)準(zhǔn)。
PHP FIG目前已表決通過了 6 套標(biāo)準(zhǔn)，已經(jīng)得到大部分 PHP 框架的支持和認(rèn)可。
其中已經(jīng)通過的有：
PSR-1 基礎(chǔ)編碼規(guī)范
PSR-2 編碼風(fēng)格規(guī)范
PSR-3 日志接口規(guī)范
PSR-4 自動加載規(guī)范
PSR-6 緩存接口規(guī)范
PSR-7 HTTP 消息接口規(guī)范
*注：其中PSR-0已被棄用，PSR-5還在起草中，以后再補(bǔ)充
這里先介紹PSR-1 基礎(chǔ)編碼規(guī)范
1. 概覽
PHP代碼文件?必須?以?<?php?或?<?=?標(biāo)簽開始；
PHP代碼文件?必須?以?不帶 BOM 的 UTF-8?編碼；
PHP代碼中?應(yīng)該?只定義類、函數(shù)、常量等聲明，或其他會產(chǎn)生?副作用?的操作（如：生成文件輸出以及修改 .ini 配置文件等），二者只能選其一；
命名空間以及類?必須?符合 PSR 的自動加載規(guī)范：[PSR-4]() 中的一個；
類的命名?必須?遵循?StudlyCaps?大寫開頭的駝峰命名規(guī)范；
類中的常量所有字母都?必須?大寫，單詞間用下劃線分隔；
方法名稱?必須?符合?camelCase?式的小寫開頭駝峰命名規(guī)范。
2. 文件
2.1. PHP標(biāo)簽
PHP代碼?必須?使用?<?php ?>?長標(biāo)簽 或?<?= ?>?短輸出標(biāo)簽；
一定不可?使用其它自定義標(biāo)簽。
2.2. 字符編碼
PHP代碼?必須?且只可使用?不帶BOM的UTF-8?編碼。（這點很重要）
2.3. 副作用
一份 PHP 文件中?應(yīng)該?要不就只定義新的聲明，如類、函數(shù)或常量等不產(chǎn)生?副作用?的操作，要不就只書寫會產(chǎn)生?副作用?的邏輯操作，但?不該?同時具有兩者。
「副作用」(side effects) 一詞的意思是，僅僅通過包含文件，不直接聲明類、函數(shù)和常量等，而執(zhí)行的邏輯操作。
「副作用」包含卻不僅限于：
生成輸出
直接的?require?或?include
連接外部服務(wù)
修改 ini 配置
拋出錯誤或異常
修改全局或靜態(tài)變量
讀或?qū)懳募?/p>
以下是一個?反例，一份包含「函數(shù)聲明」以及產(chǎn)生「副作用」的代碼：
<?php
//?「副作用」：修改?ini?配置
ini_set('error_reporting',?E_ALL);
//?「副作用」：引入文件
include?"file.php";
//?「副作用」：生成輸出
echo?"<html>\n";
//?聲明函數(shù)
function?foo()
{
???//?函數(shù)主體部分
}
下面是一個范例，一份只包含聲明不產(chǎn)生「副作用」的代碼：
<?php
//?聲明函數(shù)
function?foo()
{
???//?函數(shù)主體部分
}
//?條件聲明?**不**?屬于「副作用」
if?(!?function_exists('bar'))?{
???function?bar()
???{
???????//?函數(shù)主體部分
???}
}
3. 命名空間和類
命名空間以及類的命名必須遵循 [PSR-4]()。
根據(jù)規(guī)范，每個類都獨(dú)立為一個文件，且命名空間至少有一個層次：頂級的組織名稱（vendor name）。
類的命名?必須?遵循?StudlyCaps?大寫開頭的駝峰命名規(guī)范。
PHP 5.3 及以后版本的代碼?必須?使用正式的命名空間。
例如：
<?php
//?PHP?5.3及以后版本的寫法
namespace?Vendor\Model;
class?Foo
{
}
5.2.x 及之前的版本?應(yīng)該?使用偽命名空間的寫法，約定俗成使用頂級的組織名稱（vendor name）如?Vendor_?為類前綴。
<?php
//?5.2.x及之前版本的寫法
class?Vendor_Model_Foo
{
}
4. 類的常量、屬性和方法
此處的「類」指代所有的類、接口以及可復(fù)用代碼塊（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)
本規(guī)范不做強(qiáng)制要求，但無論遵循哪種命名方式，都?應(yīng)該?在一定的范圍內(nèi)保持一致。這個范圍可以是整個團(tuán)隊、整個包、整個類或整個方法。
4.3. 方法
方法名稱?必須?符合?camelCase()?式的小寫開頭駝峰命名規(guī)范。
