PHP-PSR-[0-4]代碼規範

PHP-FIG

在說啥是PSR-[0-4]規範的之前，我覺得我們有必要說下它的發明者和規範者：PHP-FIG，它的網站是：www.php-fig.org。就是這個聯盟組織發明和創造了PSR-[0-4]規範，膜拜吧，屌絲們！

FIG 是 Framework Interoperability Group（框架可互用性小組）的縮寫，由幾位開源框架的開發者成立於 2009 年，從那開始也選取了很多其他成員進來，雖然不是 “官方” 組織，但也代表了社區中不小的一塊。組織的目的在於：以最低程度的限制，來統一各個項目的編碼規範，避免各家自行發展的風格阻礙了程序設計師開發的困擾，於是大夥發明和總結了PSR，PSR是Proposing a Standards Recommendation（提出標準建議）的縮寫，截止到目前爲止，總共有5套PSR規範，分別是：

PSR-0 (Autoloading Standard) 自動加載標準 
PSR-1 (Basic Coding Standard) 基礎編碼標準 
PSR-2 (Coding Style Guide) 編碼風格嚮導 
PSR-3 (Logger Interface) 日誌接口 
PSR-4 (Improved Autoloading) 自動加載的增強版，可以替換掉PSR-0了。

 

接下來的篇目，我們會針對這5套，深入瞭解下。仔細學習下受萬千PHPer熱捧的這5套規範到底有啥出衆之處。

PSR-0 規範

PRS-0規範是他們出的第1套規範，主要是制定了一些自動加載標準（Autoloading Standard），如果你英文比較好，可以直接看官網的這個：PSR-0，很短。但是如果，你英語爛成狗，那麼就繼續往下看我的瞎比比講解吧！

我們打開PSR-0的主頁時，發現多了一個警告：

Deprecated - As of 2014-10-21 PSR-0 has been marked as deprecated. PSR-4 is now recommended as an alternative.

英語狗不好的，來，聽我翻譯：

不推薦使用 - 在2014年10月21日PSR-0已被標記爲過時。PSR-4現在推薦作爲替代。

那麼也就是說PSR-0已！經！過！時！了！，別哭，PHP代碼狗。雖說已經過時，但是我們也可以看看嘛，這不影響我們的學習，好了。廢話不說了，開始吧：

PSR-0強制性要求幾點：

1. 一個完全合格的namespace和class必須符合這樣的結構：“\< Vendor Name>(< Namespace>)*< Class Name>”
2. 每個namespace必須有一個頂層的namespace（"Vendor Name"提供者名字）
3. 每個namespace可以有多個子namespace
4. 當從文件系統中加載時，每個namespace的分隔符(/)要轉換成 DIRECTORY_SEPARATOR(操作系統路徑分隔符)
5. 在類名中，每個下劃線(_)符號要轉換成DIRECTORY_SEPARATOR(操作系統路徑分隔符)。在namespace中，下劃線(_)符號是沒有（特殊）意義的。
6. 當從文件系統中載入時，合格的namespace和class一定是以 .php 結尾的
7. verdor name,namespaces,class名可以由大小寫字母組合而成（大小寫敏感的）

是不是有點看不懂啊。什麼namespace啊，什麼autoloading啊。所以，如果你對命名空間還不是特別懂的話，可以google下namespace 和 自動加載相關的php知識。或者看下一篇，我專門來講講他們：namespace 和 autoloading

好，我們接着一條條舉例來分析下：

第1條

比如我的文件 /Doctrine/Common/IsolatedClassLoader.php 這樣子的一個類文件，那麼你的namespace命名就必須聲明稱這樣：

聲明：namespace  \Doctrine\Common\
調用：\Doctrine\Common\IsolatedClassLoader

 

其中，Doctrine 表示一個模塊目錄 Vendor name, common就是namesapce, IsolatedClassLoader是class name。這樣一看就知道這個文件的目錄層次，一目瞭然。

再比如：/path/to/project/lib/vendor/Symfony/Core/Request.php 文件：

聲明：namespace \Symfony\Core
調用：\Symfony\Core\Request

第2，3條

1 2	namespace \Zend\Acl => /path/to/project/lib/vendor/Zend/Acl.php namespace \Zend\Mail\Message => /path/to/project/lib/vendor/Zend/Mail/Message.php

必須有一個頂級的zend的namespace, zend 下面可以有message子命名空間。

第4條

看這個例子，我們需要new 一個這樣的類

1	new \Symfony\Core\Request

那麼我再加載這個類文件時候，就要將分隔符 \ 轉換成 目錄，也就是去 Vendor -> Symfony->Core->Request.php 一層層的目錄找到這個文件。其實也就是和第1,2,3是反過來的對應關係。

第5條

第5條是說namespace命名中的這個 _ 符號 沒有任何用處，就是用來表示目錄分隔符的，但是注意在PRS-4中已經取消了這個_ ，那麼我們還是看一下，這個過時的規定是怎麼樣的：

1 2 3

\namespace\package\Class_Name => /path/to/project/lib/vendor/namespace/package/Class/Name.php   \namespace\package_name\Class_Name => /path/to/project/lib/vendor/namespace/package_name/Class/Name.php

以上2個namespace中的 _ 其實是目錄分隔符。並不是class name就是那樣的。現在PSR-4出來後，確實覺得這樣的規定有點不好。怪怪的。

第6條

第6條不用多說。既然你用php，文件名當然是得用.php 後綴結尾。這個規定的原因，我大致猜一下，估計是有人用 .php3 後綴的。好吧。這個是個神話了。因爲在apache的配置文件中是允許的：

1 2 3

<IfModule dir_module>     DirectoryIndex index.php index.php3 index.html index.htm </IfModule>

所以，老老實實的用.php作爲後綴名吧。

第7條

文件大小寫的問題，這個其實是很重要的。因爲Linux系統下是區分文件名和目錄名大小寫的，而在Windows下是不區分的。所以就會經常出現問題，比如：

1	namespace  \Doctrine\Common\IsolatedClassLoader

在Linux下就去嚴格按照大小寫去找目錄和文件了。但是如果你在Windows下開發，全是小寫也不會報錯，你一發布到Linux上就悲劇了，提示找不到文件。所以，大小寫太重要了。

PSR-1 規範

還是那句話，如果你英文比較好，可以直接看官網的這個：PSR-1，也不長，基本能看懂。但是如果你英語爛成狗，那麼還是請繼續往下看我的瞎比比！

1. PHP源文件必須只使用 <?php 和 <?= 這兩種標籤。
2. 源文件中php代碼的編碼格式必須是不帶字節順序標記(BOM)的UTF-8。
3. 一個源文件建議只用來做聲明（類(class)，函數(function)，常量(constant)等）或者只用來做一些引起副作用的操作（例如：輸出信息，修改.ini配置等），但不建議同時做這兩件事。
4. 命名空間(namespace)和類(class) 必須遵守PSR-0標準。
5. 類名(class name) 必須使用駱駝式(StudlyCaps)寫法 (注：駝峯式(cameCase)的一種變種，後文將直接用StudlyCaps表示)。
6. 類(class)中的常量必須只由大寫字母和下劃線(_)組成。
7. 方法名(method name) 必須使用駝峯式(cameCase)寫法。

好，就是上面的基本7大點，有些很簡單，就不過多說明，第3點需要仔細說下。

第1條

這個基本都是大家都懂得的，PHP代碼必須只使用長標籤(<?php ?>)或者短輸出式標籤(<?= ?>)；而不要使用其他標籤。

之所以說這個，是因爲我們在學習PHP的時候，一般的教材都告訴我們說，php有4種標記風格：php的4種標記風格 所以，很多人就亂來了。瞎雞巴寫。特別是asp風格的兼職是折磨好麼！！！

第2條

這個不多說，保存的時候格式必須是無BOM的UTF-8格式，否則會出現很多無法解釋的千奇百怪的問題。千萬別傻逼的用Windows下的text文本編輯器保存文件啊

第3條

這個通俗的說呢。就是別把一些輸出和修改的操作(副作用) 和 類文件混合在一起，專注一點，這個文件專門來聲明Class, 那個文件專門來修改配置文件，別混在一起寫：

所以，以下的這個文件是有問題的，最好不要這樣：

1 2 3 4 5 6 7 8 9 10 11 12 13 14

// 副作用：修改了ini配置 ini_set('error_reporting', E_ALL);   // 副作用：載入了文件 include "file.php";   // 副作用：產生了輸出 echo "<html>\n";   // 聲明 function function foo() {     // 函數體 }

你看上面看起來多亂啊。最好全部分開來寫:

1 2 3 4 5 6 7 8 9 10 11 12 13 14

namespace Lib;   class Name {     public function __construct()     {         echo __NAMESPACE__ . "<br>";     }       public static function test()     {         echo __NAMESPACE__ . ' static function test <br>';     } }

修改ini:

1	ini_set('error_reporting', E_ALL);

require 文件：

1 2 3

require DIR . '/loading.php';   spl_autoload_register("\\AutoLoading\\loading::autoload");

你看是不是整齊好看多了。當然這個是很難約束的。自己仔細劃分。

第4條

第4條是約束namespace的，前面已經說過，不多說。值得說的是名字要是駝峯方式來

第5條

class name必須要用駝峯方式寫，駝峯又分小駝峯和大駝峯（小駝峯是第一個字母是小寫）這樣寫看着舒服也比較規範，不做要求，反正是駝峯就可以了。我喜歡用小駝峯：

1 2 3

class getUserInfo { }

第6條

是規定類中的常量名(const)聲明必須要全部大寫，如果有多個單詞，就用_分開：

1 2 3 4 5 6 7 8 9 10 11 12 13

class getUserInfo {     // 全部大寫     const NAME = 'phper';       // 用_隔開     const HOUSE_INFO = '已經深圳買房';       public function getUserName()     {         //     } }​

第7條

method name必須要用駝峯方式寫，大小駝峯都可以，不做要求，我喜歡用小駝峯：

1 2 3 4 5 6 7

class getUserInfo {     public function getUserName()     {         //     } }

PRSR-2 規範

PSR-2 規範的官網鏈接在此：PSR-2 這一規範主要是約束代碼風格的，可是說是所有裏面最關鍵最重要的，也是需要好好規範和共同遵守的。

我們一個個來看下，只能我大略的寫一些比較重要的，或者說平時用的最多的。

1、源文件

1. 文件末尾必須空一行。
2. 必須使用Unix LF(換行)作爲行結束符。
3. 純PHP代碼源文件的關閉標籤?>必須省略。

第3點其實是蠻重要的，我之前還老寫閉合，現在不寫了。這可以避免在 PHP 結束標記之後萬一意外加入了空格或者換行符，會導致 PHP 開始輸出這些空白，而腳本中此時並無輸出的意圖。

2、縮進

必須使用4個空格來縮進，不能使用Tab鍵。當然你如果把Tab在編輯器裏手動設置爲4個空格也可以。這樣的目的是因爲：每個人的機器上的Tab鍵都不一樣，有些是4個空格，有些是8個空格，在你的機器上看着很爽的代碼，在別人機器上了就各種噁心了。所以，統一搞成4個空格，不管在哪裏打開都是美觀的。

3、行

一行推薦的是最多寫80個字符，多於這個字符就應該換行了，一般的編輯器是可以設置的。

4、關鍵字和 True/False/Null

php的關鍵字，必須小寫，boolean值：true，false，null 也必須小寫

下面是php的keyword，必須小寫。

'__halt_compiler', 'abstract', 'and', 'array', 'as', 'break', 'callable', 'case', 'catch', 'class', 'clone', 'const', 'continue', 'declare', 'default', 'die', 'do', 'echo', 'else', 'elseif', 'empty', 'enddeclare', 'endfor', 'endforeach', 'endif', 'endswitch', 'endwhile', 'eval', 'exit', 'extends', 'final', 'for', 'foreach', 'function', 'global', 'goto', 'if', 'implements', 'include', 'include_once', 'instanceof', 'insteadof', 'interface', 'isset', 'list', 'namespace', 'new', 'or', 'print', 'private', 'protected', 'public', 'require', 'require_once', 'return', 'static', 'switch', 'throw', 'trait', 'try', 'unset', 'use', 'var', 'while', 'xor'

5、命名空間(Namespace)和導入(Use)聲明

先簡單文字描述下：

1. 命名空間(namespace)的聲明後面必須有一行空行。
2. 所有的導入(use)聲明必須放在命名空間(namespace)聲明的下面。
3. 一句聲明中，必須只有一個導入(use)關鍵字。
4. 在導入(use)聲明代碼塊後面必須有一行空行。

用代碼來說明下：

1 2 3 4 5 6

<?php namespace Lib\Databases; // 下面必須空格一行   class Mysql { }

namespace下空一行，才能使用use，再空一行，才能聲明class

1 2 3 4 5 6 7 8 9 10

<?php namespace Lib\Databases; // 下面必須空格一行   use FooInterface; // use 必須在namespace 後面聲明 use BarClass as Bar; use OtherVendor\OtherPackage\BazClass; // 下面必須空格一行   class Mysql { }

6、類(class)，屬性(property)和方法(method)

（1）、繼承(extends) 和實現(implement) 必須和 class name 寫在一行，切花括號要換行寫。

1 2 3 4 5 6 7

<?php namespace Lib\Databaes;   class Mysql extends ParentClass implements \PDO, \DB // 寫一行 { // 換行寫{       }

（2）、屬性(property)必須聲明其可見性，到底是 public 還是 protected 還是 private，不能省略，也不能使用var, var是php老版本中的什麼方式，等用於public。

1 2 3 4 5 6 7 8 9

<?php namespace Lib\Databaes;   class Mysql extends ParentClass implements \PDO, \DB // 寫一行 {     public $foo = null;     private $name = 'yangyi';     protected $age = '17'; }

（3）、方法(method)，必須 聲明其可見性，到底是 public 還是 protected 還是 private，不能省略。並且，花括號{必須換行寫。如果有多個參數，第一個參數後緊接, ,再加個空格，且函數name和( 之間必須要有個空格：function_name ($par, $par2, $pa3), 如果參數有默認值，也要用左右空格分開。

1 2 3 4 5 6 7 8 9

<?php namespace Lib\Databaes;   class Mysql extends ParentClass implements \PDO, \DB // 寫一行 {     public getInfo ($name, $age, $gender = 1) // 函數名getInfo和(之間有個空格，參數之間也要有空格。默認參數也要左右都有空格     { // 必須換行寫 {     } }

（4）、當用到抽象(abstract)和終結(final)來做類聲明時，它們必須放在可見性聲明 （public 還是protected還是private）的前面。而當用到靜態(static)來做類聲明時，則必須放在可見性聲明的後面。

直接上代碼：

1 2 3 4 5 6 7 8 9 10 11 12 13 14

<?php namespace Vendor\Package;   abstract class ClassName {     protected static $foo; // static放後面       abstract protected function zim(); // abstract放前面       final public static function bar() // final放前面，static放最後。     {         // 方法主體部分     } }

7、控制結構

控制接口，就是 if else while switch等。這一類的寫法規範也是經常容易出現問題的，也要規範一下。

（1）、if，elseif，else寫法，直接上規範代碼吧：

1 2 3 4 5 6 7 8

<?php if ($expr1) { // 左右空格     // if body } elseif ($expr2) { // elesif 連着寫     // elseif body } else {     // else body; }

（2）、switch，case 注意左右空格和換行，還是直接上規範代碼：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

<?php switch ($expr) { // 左右空格     case 0:         echo 'First case, with a break'; // 對齊         break; // 換行寫break，也對齊。     case 1:         echo 'Second case, which falls through';         // no break     case 2:     case 3:     case 4:         echo 'Third case, return instead of break';         return;     default:         echo 'Default case';         break; }

（3）、while，do while 的寫法也是類似，要左右空格，上代碼：

1 2 3 4 5 6 7 8

<?php while ($expr) { // 左右空格     // structure body }   do {     // structure body; // 左右空格 } while ($expr);

（4）、for的寫法

1 2 3 4

<?php for ($i = 0; $i < 10; $i++) { // 注意幾個參數之間的空格     // for body }

（5）、foreach的寫法

1 2 3 4

<?php foreach ($iterable as $key => $value) { // 還是空格問題     // foreach body }

（6）、try catch的寫法

1 2 3 4 5 6 7 8

<?php try {     // try body } catch (FirstExceptionType $e) { // 同樣也是注意空格。     // catch body } catch (OtherExceptionType $e) {     // catch body }

基本用到的就是這些了，其他什麼閉包啥的用的不多就不過多的累述了。

PSR-3 規範

PSR-3規範主要是來規範日誌接口(Logger Interface)的，老實講，其實平常接觸的不是特別多，所以就不說了，可以去看官網的PSR-3

PSR-4 規範

PSR-4規範是剛出沒多久的一條新的規範，它也是規範 自動加載(autoload)的，是對PSR-0的修改，屬於補充規範，

我簡單說下，主要是以下幾點： 

1. 廢除了PSR-0中_就是目錄分割符的寫法，_下劃線在完全限定類名中是沒有特殊含義了。 
2. 類文件名要以 .php 結尾。 
3. 類名必須要和對應的文件名要一模一樣，大小寫也要一模一樣。

 

 

參考：

https://www.zybuluo.com/phper/note/65033

http://segmentfault.com/a/1190000000380008

http://www.4wei.cn/archives/1002186 

http://wenku.baidu.com/view/7a21e44b48d7c1c708a14577.html#10002-tsina-1-87843-e29b4784eda5d1f51fb0c2a97a15da08 

https://github.com/hfcorriez/fig-standards