PHP-PSR現(xiàn)代PHPer的開發(fā)規(guī)范是怎樣的

PHP-PSR現(xiàn)代PHPer的開發(fā)規(guī)范是怎樣的，很多新手對此不是很清楚，為了幫助大家解決這個難題，下面小編將為大家詳細(xì)講解，有這方面需求的人可以來學(xué)習(xí)下，希望你能有所收獲。

PSR是PHP Standards Recommendation的簡稱，意為PHP推薦標(biāo)準(zhǔn)。要想了解PSR，首先得知道制定這一標(biāo)準(zhǔn)的人/組織是誰————PHP-FIG。

PHP-FIG

PHP-FIG全稱為PHP Framework Interop Group,是一個組織，這個組織的成員由一些PHP框架的代表組成，這些人聚在一起“討論框架之間的共性，尋找可以合作的方式”。PHP-FIG制訂了推薦規(guī)范，PHP框架可以自愿實現(xiàn)這些規(guī)范，改進(jìn)其他框架的通信和共享功能。
PHP-FIG的使命是實現(xiàn)框架之間的互操作性。

PSR-1：基本的代碼風(fēng)格

在文章的最開始，我們就已經(jīng)簡單介紹過什么是PSR，PSR是PHP標(biāo)準(zhǔn)，而PSR-1是PHP最基本也是最簡單的標(biāo)準(zhǔn)。

PHP標(biāo)簽

必須把代碼放在 <?php ?>或 <? ?>標(biāo)簽中。不得使用其它的標(biāo)簽句法

這點相信很多PHPer都很容易遵守，而且在現(xiàn)實擼代碼中一般都是采用正常的<?php ?>標(biāo)簽

編碼

所有PHP文件都必須使用UTF-8字符集編碼，而且不能有字節(jié)順序標(biāo)記（Byte Order Mark,BOM）

這個也很常見，就是無BOM和有BOM格式，記得剛開始敲PHP代碼的時候，前輩總是很關(guān)照，一定要用IDE調(diào)成無BOM格式啊，當(dāng)時表示懵懂，然后就跟著做了，現(xiàn)在看到這里，又重新查了資料，找到了為什么不能使用有BOM格式的原因，BOM會產(chǎn)生多余的輸出，就像平白無故多了一個空行：

php在處理BOM頭的時候，有時候存在錯誤，可能造成你在使用 header 或 session_start 之類的函數(shù)時，出現(xiàn) 文件已經(jīng)輸出的錯誤，多數(shù)都是因為BOM頭送出去了。。因為在php看來，成了一個空格。所以使用無BOM的格式

目的

一個PHP文件可以定義符號（類、性狀、函數(shù)、常量等），或者執(zhí)行有副作用的操作（生成結(jié)果或者處理數(shù)據(jù)），但不能同時做兩件事

這個規(guī)定的意思差不多就是一個變量、方法或者一個類，只能相應(yīng)完成一個操作、做一件事情，這樣保證了代碼的清晰易懂，也保證了方法、變量的單一性，各司其職。其實也是為了方便，我們在以后項目/應(yīng)用較大時，可以很好的解耦

自動加載

PHP的命名空間和類必須遵守PSR-4自動加載器標(biāo)準(zhǔn)

后續(xù)看PSR-4的具體解釋

類的名稱

PHP類的名稱必須使用駝峰式，又名標(biāo)題式

駝峰式和分詞式（每個單詞用_隔開）這兩種寫法，記得以前存在很大的爭議，有人支持駝峰(GirlFriend),有人支持分詞式（girl_friend），現(xiàn)在好了，統(tǒng)一規(guī)定出來了，為了PHP更好的發(fā)展，那就委屈支持分詞式的兄弟，統(tǒng)一駝峰了。記得公司的CI2項目，用的就是這種分詞式，不過也是框架規(guī)定，后來在自己的項目中，自己有預(yù)感的使用了駝峰式，哈哈，為自己的眼光點贊~

常量的名稱

PHP的常量名稱必須大寫；

這點應(yīng)該是毋庸置疑的吧，最開始寫PHP的時候，這個寫法已經(jīng)根深蒂固了。

方法的名稱

使用駝峰式(boyFriend)

方法的命名和類的命名方式有些相似，不過還是有些區(qū)別：類的命名規(guī)定首字母大寫（BoyFriendMoney）,而方法的命名規(guī)定首字母小寫（boyFriendMoney）

PSR-2：嚴(yán)格的代碼風(fēng)格

PSR-2 相較于PSR-1是更為嚴(yán)格的代碼規(guī)范。個人和官方都認(rèn)為開發(fā)者應(yīng)該遵循更為嚴(yán)格的代碼標(biāo)準(zhǔn)，在現(xiàn)代的PHP生態(tài)系統(tǒng)中，風(fēng)格統(tǒng)一，可以更好的讓其他開發(fā)者理解PHP代碼。

貫徹PSR-1

使用PSR-2 之前先要貫徹PSR-1

縮進(jìn)

使用四個空格縮進(jìn)。

關(guān)于縮進(jìn)這個問題，相信有很多爭議。我在真正正視這個問題之前，一直使用的都是IDE的tab鍵。然后當(dāng)同事和自己在編寫同一文件的時候，就會出先代碼縮進(jìn)不一的情況，導(dǎo)致代碼結(jié)構(gòu)非常亂。所以在出現(xiàn)這個問題之后，就統(tǒng)一了一下文件縮進(jìn)的標(biāo)準(zhǔn)，以四個空格為縮進(jìn)。這樣的話，就算是用不一致的編輯器打開，效果也是一樣的。
很多IDE都可以設(shè)置tab鍵，百度一下就可以搜到。

文件和代碼行

PHP文件必須使用UNIX風(fēng)格的換行符（LF），最后要有一個空行，而且不能使用PHP關(guān)閉   ?>標(biāo)簽。

最開始我也不懂為什么在純PHP頁面中不使用關(guān)閉 ?> 標(biāo)簽，后來在書中找到了答案

為了避免意料之外的輸出錯誤，如果加上關(guān)閉標(biāo)簽，而且在關(guān)閉標(biāo)簽后有空行，那么這個空行也被當(dāng)成輸出，導(dǎo)致錯誤（例如，設(shè)定http首部時）

關(guān)鍵字

關(guān)鍵字，要使用小寫；

之前不知道在哪兒看的PHP的教程，上面寫的PHP代碼像true、false這樣的關(guān)鍵字都使用的是大寫TRUE、FALSE，我也一直在這樣使用，后來看到PSR-2的規(guī)范，才知道應(yīng)該要使用小寫，心累~

命名空間

每個命名空間語句后必須跟著一個空行。類似的，使用use關(guān)鍵字導(dǎo)入命名空間或為命名空間創(chuàng)建別名時，在一系列use聲明語句后要加一個空行

類似于：

<?php
// 聲明本文件的命名空間
namespace My\Friend;

// 導(dǎo)入命名空間
use Other\Friend;

class GirlFrined
{

}

類

類定義體的起始括號應(yīng)在類名之后另起一行寫；
類定義體的結(jié)束括號必須在定義體之后新起一行寫；

例：

<?php

class Frined
{
    public function getSex()
    {
        // do something
    }
}

方法

方法定義體的起始括號應(yīng)在方法名之后另起一行寫；
方法定義體的結(jié)束括號必須在方法定義體之后新起一行寫；

請參考上面類示例中方法的例子。

可見性

1、類中的每個屬性和方法都要聲明可見性?？梢娦杂蓀ublic、protected或者private指定，其作用是決定在類的內(nèi)部和外部如何訪問屬性的方法。
2、私有方法的名稱前加上下劃線
3、如果類屬性聲明為 abstract和 final，這兩個限定符必須放在可見性關(guān)鍵字之前
4、如果屬性、方法聲明為 static，這個限定符必須放在可見性關(guān)鍵字之后

例子：

// 1、2
public $sex;
private $_sex;
protected $sex;

// 3、
abstract public $sex;
final public $sex;

// 4、
public static $sex;
public static $age;

控制結(jié)構(gòu)

所有控制結(jié)構(gòu)關(guān)鍵字后面都要有一個空格?？刂平Y(jié)構(gòu)關(guān)鍵字包括： if、 elseif、 else、 switch、 case、 while、 do while、 for、 foreach、 try、 catch。如果控制結(jié)構(gòu)關(guān)鍵字后面有一對圓括號，起始圓括號后面不能有空格，結(jié)束圓括號之前不能有空格。與類和方法的定義體不同，控制結(jié)構(gòu)關(guān)鍵字后面的起始括號應(yīng)該和控制機構(gòu)關(guān)鍵字寫在同一行?？刂平Y(jié)構(gòu)關(guān)鍵字后面的結(jié)束括號 必須寫在單獨一行。

例：

/** 
* 錯誤的示例：
* 這里有4個錯誤：
* 1、if關(guān)鍵詞后面和圓括號之前沒有空格
* 2、圓括號前后有空格
* 3、后圓括號和起始括號之前沒有空格
* 4、else關(guān)鍵詞前后沒有空格
**/
if( 1 == true ){
    // do something
}else{
    // do something
}

/** 
* 正確的示例：
**/
if (1 == true) {
    // do something
} else {
    // do something
}

PSR-3：日志記錄器接口

日志記錄器

PHP-FIG發(fā)布的第三個推薦規(guī)范和前兩個不同，這個有點特殊，是一個接口。規(guī)定PHP日志記錄器組件可以實現(xiàn)的方法。

日志記錄器是對象，用于把不同重要程度的消息寫入指定的輸出。記錄的消息用于診斷、檢查和排除應(yīng)用中的操作、穩(wěn)定性和性能方面的問題。例如：開發(fā)的時候把調(diào)試信息寫入到文本文件，把網(wǎng)站的流量統(tǒng)計信息記錄到數(shù)據(jù)庫等。

相信基本上所有的框架中都實現(xiàn)了日志功能，那么如果想要使用PSR-3規(guī)范的日志記錄器，該怎么做呢？首先要滿足兩點：

1. 日志功能委托給第三方庫實現(xiàn)

2. 最終用戶能選擇他們喜歡的日志記錄器組件

編寫PSR-3日志記錄器

符合PSR-3推薦規(guī)范的PHP日志記錄器組件，必須包含一個實現(xiàn)Psr\Log\LoggerInterface接口的PHP類。PSR-3接口復(fù)用了RFC 5424系統(tǒng)日志協(xié)議，規(guī)定要實現(xiàn)9個方法：

下面的代碼是我從PHP-FIG的官網(wǎng)上拿過來的，想了解詳細(xì)信息的可以 點我

<?php

namespace Psr\Log;

interface LoggerInterface
{

    public function emergency($message, array $context = array());
    public function alert($message, array $context = array());    
    public function critical($message, array $context = array());
    public function error($message, array $context = array());
    public function warning($message, array $context = array());
    public function notice($message, array $context = array());
    public function info($message, array $context = array());
    public function debug($message, array $context = array());
    public function log($level, $message, array $context = array());
}

這個類中的每一個方法都對應(yīng)RFC 5424協(xié)議的一個日志級別，而且都接受兩個參數(shù)。第一個參數(shù)必須是一個字符串，或者有一個__toString()方法的對象。第二個參數(shù)為數(shù)組，可選參數(shù)；

如果要編寫符合PSR-3規(guī)范的日志記錄器，那么就要創(chuàng)建一個實現(xiàn)Psr\Log\LoggerInterface接口的PHP類，而且要提供這個接口中每個方法的具體實現(xiàn)

使用PSR-3日志記錄器

PSR-3規(guī)范出來之后，達(dá)到這種效果的組件太多了，這里就不介紹，如何實現(xiàn)這個接口的類了。現(xiàn)在有成熟的日志記錄器組件，推薦monolog/monolog。這個組件完全上線了PSR-3的接口，而且可以使用自定義的消息格式化程序和處理程序擴展功能。
如果monolog滿足不了日常的使用，我們可以在此基礎(chǔ)上拓展自己的方法，也非常簡單；

使用monolog示例：

<?php
use Monolog\Logger;
use Monolog\Handler\StreamHandler;

// 準(zhǔn)備日志記錄器
$logger = new Logger('my_logger');
$logger->pushHandler(new StreamHandler('logs/development.log', Logger::DEBUG));
$logger->pushHandler(new StreamHandler('logs/production.log', Logger::WARNING));
// 使用日志記錄器
$logger->debug('This is debug message');
$logger->debug('This is warning message');

PSR-4：自動加載器

PHP-FIG發(fā)布的第四個推薦規(guī)范描述了一個標(biāo)準(zhǔn)的自動加載器策略；自動加載器的意思就是指在程序運行時按需查找PHP類、接口（interface）或性狀（trait）并將其載入加載器。

自動加載器策略

PSR-4推薦規(guī)范不要求改變代碼的實現(xiàn)方式，只建議如何使用文件系統(tǒng)目錄結(jié)構(gòu)和PHP命名空間組織代碼。PSR-4**依賴**PHP命名空間和文件系統(tǒng)目錄結(jié)構(gòu)查找并加載PHP類、性狀和接口

為什么自動加載器很重要

舉一個很常見的場景，我們引入文件通常都是采用require、include這樣的方法，這樣的方式簡單也可靠，但是如果我們引入一兩個還好說，但是當(dāng)我們一個項目運行時需要引入幾十個文件呢，那我們豈不是要寫幾十個require或者include？這樣既不方便，又不美觀，所以PHP-FIG在此基礎(chǔ)上考慮，規(guī)范了一個統(tǒng)一的自動加載器策略；

如何使用自動加載器

建議使用依賴管理器Composer自動生成的PSR-4自動加載器。
現(xiàn)代的PHP框架，laravel、Yii、TP5等都使用了依賴Composer的自動加載器策略，方便我們下載組件和引入合適的類。

PSR-ME：制定自己的PHP規(guī)范

1. 遵循PSR-1、PSR-2的使用規(guī)范

2. 合適、精簡的變量、方法、類命名。能讓人看一眼就清楚是做什么的

3. 盡量編寫出高內(nèi)聚、低耦合的代碼

4. 保持代碼結(jié)構(gòu)整潔、美觀

PHP-FIG推出的PHP規(guī)范，并不一定說所有的PHP開發(fā)者必須遵守。制定這一規(guī)范的目的就是為了，在全世界的PHP開發(fā)者在查看代碼的時候，能更加簡單和輕松。造出來的組件/輪子可以很容易的就被所有開發(fā)者熟知和使用，同時也減少了我們的工作投入率，得到更大的工作效率，使產(chǎn)出大于投入，效率更高更快。

看完上述內(nèi)容是否對您有幫助呢？如果還想對相關(guān)知識有進(jìn)一步的了解或閱讀更多相關(guān)文章，請關(guān)注億速云行業(yè)資訊頻道，感謝您對億速云的支持。