PHP-PSR現(xiàn)代PHPer的開(kāi)發(fā)規(guī)范是怎樣的,很多新手對(duì)此不是很清楚,為了幫助大家解決這個(gè)難題,下面小編將為大家詳細(xì)講解,有這方面需求的人可以來(lái)學(xué)習(xí)下,希望你能有所收獲。
成都創(chuàng)新互聯(lián)是工信部頒發(fā)資質(zhì)IDC服務(wù)器商,為用戶提供優(yōu)質(zhì)的聯(lián)通機(jī)房服務(wù)器托管服務(wù)
PSR是PHP Standards Recommendation的簡(jiǎn)稱,意為PHP推薦標(biāo)準(zhǔn)。要想了解PSR,首先得知道制定這一標(biāo)準(zhǔn)的人/組織是誰(shuí)————PHP-FIG。
PHP-FIG全稱為PHP Framework Interop Group,是一個(gè)組織,這個(gè)組織的成員由一些PHP框架的代表組成,這些人聚在一起“討論框架之間的共性,尋找可以合作的方式”。PHP-FIG制訂了推薦規(guī)范,PHP框架可以自愿實(shí)現(xiàn)這些規(guī)范,改進(jìn)其他框架的通信和共享功能。
PHP-FIG的使命是實(shí)現(xiàn)框架之間的互操作性。
在文章的最開(kāi)始,我們就已經(jīng)簡(jiǎn)單介紹過(guò)什么是PSR,PSR是PHP標(biāo)準(zhǔn),而PSR-1是PHP最基本也是最簡(jiǎn)單的標(biāo)準(zhǔn)。
必須把代碼放在或
?>
標(biāo)簽中。不得使用其它的標(biāo)簽句法
這點(diǎn)相信很多PHPer都很容易遵守,而且在現(xiàn)實(shí)擼代碼中一般都是采用正常的標(biāo)簽
所有PHP文件都必須使用UTF-8字符集編碼,而且不能有字節(jié)順序標(biāo)記(Byte Order Mark,BOM)
這個(gè)也很常見(jiàn),就是無(wú)BOM和有BOM格式,記得剛開(kāi)始敲PHP代碼的時(shí)候,前輩總是很關(guān)照,一定要用IDE調(diào)成無(wú)BOM格式啊,當(dāng)時(shí)表示懵懂,然后就跟著做了,現(xiàn)在看到這里,又重新查了資料,找到了為什么不能使用有BOM格式的原因,BOM會(huì)產(chǎn)生多余的輸出,就像平白無(wú)故多了一個(gè)空行:
php在處理BOM頭的時(shí)候,有時(shí)候存在錯(cuò)誤,可能造成你在使用 header 或 session_start 之類的函數(shù)時(shí),出現(xiàn) 文件已經(jīng)輸出的錯(cuò)誤,多數(shù)都是因?yàn)锽OM頭送出去了。。因?yàn)樵趐hp看來(lái),成了一個(gè)空格。所以使用無(wú)BOM的格式
一個(gè)PHP文件可以定義符號(hào)(類、性狀、函數(shù)、常量等),或者執(zhí)行有副作用的操作(生成結(jié)果或者處理數(shù)據(jù)),但不能同時(shí)做兩件事
這個(gè)規(guī)定的意思差不多就是一個(gè)變量、方法或者一個(gè)類,只能相應(yīng)完成一個(gè)操作、做一件事情,這樣保證了代碼的清晰易懂,也保證了方法、變量的單一性,各司其職。其實(shí)也是為了方便,我們?cè)谝院箜?xiàng)目/應(yīng)用較大時(shí),可以很好的解耦
PHP的命名空間和類必須遵守PSR-4自動(dòng)加載器標(biāo)準(zhǔn)
后續(xù)看PSR-4的具體解釋
PHP類的名稱必須使用駝峰式,又名標(biāo)題式
駝峰式和分詞式(每個(gè)單詞用_隔開(kāi))這兩種寫(xiě)法,記得以前存在很大的爭(zhēng)議,有人支持駝峰(GirlFriend
),有人支持分詞式(girl_friend
),現(xiàn)在好了,統(tǒng)一規(guī)定出來(lái)了,為了PHP更好的發(fā)展,那就委屈支持分詞式的兄弟,統(tǒng)一駝峰了。記得公司的CI2項(xiàng)目,用的就是這種分詞式,不過(guò)也是框架規(guī)定,后來(lái)在自己的項(xiàng)目中,自己有預(yù)感的使用了駝峰式,哈哈,為自己的眼光點(diǎn)贊~
PHP的常量名稱必須大寫(xiě);
這點(diǎn)應(yīng)該是毋庸置疑的吧,最開(kāi)始寫(xiě)PHP的時(shí)候,這個(gè)寫(xiě)法已經(jīng)根深蒂固了。
使用駝峰式(boyFriend)
方法的命名和類的命名方式有些相似,不過(guò)還是有些區(qū)別:類的命名規(guī)定首字母大寫(xiě)(BoyFriendMoney),而方法的命名規(guī)定首字母小寫(xiě)(boyFriendMoney)
PSR-2 相較于PSR-1是更為嚴(yán)格的代碼規(guī)范。個(gè)人和官方都認(rèn)為開(kāi)發(fā)者應(yīng)該遵循更為嚴(yán)格的代碼標(biāo)準(zhǔn),在現(xiàn)代的PHP生態(tài)系統(tǒng)中,風(fēng)格統(tǒng)一,可以更好的讓其他開(kāi)發(fā)者理解PHP代碼。
使用PSR-2 之前先要貫徹PSR-1
使用四個(gè)空格縮進(jìn)。
關(guān)于縮進(jìn)這個(gè)問(wèn)題,相信有很多爭(zhēng)議。我在真正正視這個(gè)問(wèn)題之前,一直使用的都是IDE的tab鍵。然后當(dāng)同事和自己在編寫(xiě)同一文件的時(shí)候,就會(huì)出先代碼縮進(jìn)不一的情況,導(dǎo)致代碼結(jié)構(gòu)非常亂。所以在出現(xiàn)這個(gè)問(wèn)題之后,就統(tǒng)一了一下文件縮進(jìn)的標(biāo)準(zhǔn),以四個(gè)空格為縮進(jìn)。這樣的話,就算是用不一致的編輯器打開(kāi),效果也是一樣的。
很多IDE都可以設(shè)置tab鍵,百度一下就可以搜到。
PHP文件必須使用UNIX風(fēng)格的換行符(LF),最后要有一個(gè)空行,而且不能使用PHP關(guān)閉
?>
標(biāo)簽。
最開(kāi)始我也不懂為什么在純PHP頁(yè)面中不使用關(guān)閉 ?>
標(biāo)簽,后來(lái)在書(shū)中找到了答案
為了避免意料之外的輸出錯(cuò)誤,如果加上關(guān)閉標(biāo)簽,而且在關(guān)閉標(biāo)簽后有空行,那么這個(gè)空行也被當(dāng)成輸出,導(dǎo)致錯(cuò)誤(例如,設(shè)定http首部時(shí))
關(guān)鍵字,要使用小寫(xiě);
之前不知道在哪兒看的PHP的教程,上面寫(xiě)的PHP代碼像true
、false
這樣的關(guān)鍵字都使用的是大寫(xiě)TRUE
、FALSE
,我也一直在這樣使用,后來(lái)看到PSR-2的規(guī)范,才知道應(yīng)該要使用小寫(xiě),心累~
每個(gè)命名空間語(yǔ)句后必須跟著一個(gè)空行。類似的,使用use關(guān)鍵字導(dǎo)入命名空間或?yàn)槊臻g創(chuàng)建別名時(shí),在一系列use聲明語(yǔ)句后要加一個(gè)空行
類似于:
類
類定義體的起始括號(hào)應(yīng)在類名之后另起一行寫(xiě);
類定義體的結(jié)束括號(hào)必須在定義體之后新起一行寫(xiě);例:
方法
方法定義體的起始括號(hào)應(yīng)在方法名之后另起一行寫(xiě);
方法定義體的結(jié)束括號(hào)必須在方法定義體之后新起一行寫(xiě);請(qǐng)參考上面類示例中方法的例子。
可見(jiàn)性
1、類中的每個(gè)屬性和方法都要聲明可見(jiàn)性??梢?jiàn)性由public、protected或者private指定,其作用是決定在類的內(nèi)部和外部如何訪問(wèn)屬性的方法。
2、私有方法的名稱前加上下劃線
3、如果類屬性聲明為abstract
和final
,這兩個(gè)限定符必須放在可見(jiàn)性關(guān)鍵字之前
4、如果屬性、方法聲明為static
,這個(gè)限定符必須放在可見(jiàn)性關(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)鍵字后面都要有一個(gè)空格??刂平Y(jié)構(gòu)關(guān)鍵字包括:if
、elseif
、else
、switch
、case
、while
、do while
、for
、foreach
、try
、catch
。如果控制結(jié)構(gòu)關(guān)鍵字后面有一對(duì)圓括號(hào),起始圓括號(hào)后面不能有空格,結(jié)束圓括號(hào)之前不能有空格。與類和方法的定義體不同,控制結(jié)構(gòu)關(guān)鍵字后面的起始括號(hào)應(yīng)該和控制機(jī)構(gòu)關(guān)鍵字寫(xiě)在同一行??刂平Y(jié)構(gòu)關(guān)鍵字后面的結(jié)束括號(hào) 必須寫(xiě)在單獨(dú)一行。例:
/** * 錯(cuò)誤的示例: * 這里有4個(gè)錯(cuò)誤: * 1、if關(guān)鍵詞后面和圓括號(hào)之前沒(méi)有空格 * 2、圓括號(hào)前后有空格 * 3、后圓括號(hào)和起始括號(hào)之前沒(méi)有空格 * 4、else關(guān)鍵詞前后沒(méi)有空格 **/ if( 1 == true ){ // do something }else{ // do something } /** * 正確的示例: **/ if (1 == true) { // do something } else { // do something }PSR-3:日志記錄器接口
日志記錄器
PHP-FIG發(fā)布的第三個(gè)推薦規(guī)范和前兩個(gè)不同,這個(gè)有點(diǎn)特殊,是一個(gè)接口。規(guī)定PHP日志記錄器組件可以實(shí)現(xiàn)的方法。
日志記錄器是對(duì)象,用于把不同重要程度的消息寫(xiě)入指定的輸出。記錄的消息用于診斷、檢查和排除應(yīng)用中的操作、穩(wěn)定性和性能方面的問(wèn)題。例如:開(kāi)發(fā)的時(shí)候把調(diào)試信息寫(xiě)入到文本文件,把網(wǎng)站的流量統(tǒng)計(jì)信息記錄到數(shù)據(jù)庫(kù)等。相信基本上所有的框架中都實(shí)現(xiàn)了日志功能,那么如果想要使用PSR-3規(guī)范的日志記錄器,該怎么做呢?首先要滿足兩點(diǎn):
日志功能委托給第三方庫(kù)實(shí)現(xiàn)
最終用戶能選擇他們喜歡的日志記錄器組件
編寫(xiě)PSR-3日志記錄器
符合PSR-3推薦規(guī)范的PHP日志記錄器組件,必須包含一個(gè)實(shí)現(xiàn)
Psr\Log\LoggerInterface
接口的PHP類。PSR-3接口復(fù)用了RFC 5424系統(tǒng)日志協(xié)議,規(guī)定要實(shí)現(xiàn)9個(gè)方法:下面的代碼是我從PHP-FIG的官網(wǎng)上拿過(guò)來(lái)的,想了解詳細(xì)信息的可以 點(diǎn)我
這個(gè)類中的每一個(gè)方法都對(duì)應(yīng)RFC 5424協(xié)議的一個(gè)日志級(jí)別,而且都接受兩個(gè)參數(shù)。第一個(gè)參數(shù)必須是一個(gè)字符串,或者有一個(gè)
__toString()
方法的對(duì)象。第二個(gè)參數(shù)為數(shù)組,可選參數(shù);如果要編寫(xiě)符合PSR-3規(guī)范的日志記錄器,那么就要?jiǎng)?chuàng)建一個(gè)實(shí)現(xiàn)
Psr\Log\LoggerInterface
接口的PHP類,而且要提供這個(gè)接口中每個(gè)方法的具體實(shí)現(xiàn)使用PSR-3日志記錄器
PSR-3規(guī)范出來(lái)之后,達(dá)到這種效果的組件太多了,這里就不介紹,如何實(shí)現(xiàn)這個(gè)接口的類了。現(xiàn)在有成熟的日志記錄器組件,推薦monolog/monolog。這個(gè)組件完全上線了PSR-3的接口,而且可以使用自定義的消息格式化程序和處理程序擴(kuò)展功能。
如果monolog
滿足不了日常的使用,我們可以在此基礎(chǔ)上拓展自己的方法,也非常簡(jiǎn)單;使用monolog示例:
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:自動(dòng)加載器
PHP-FIG發(fā)布的第四個(gè)推薦規(guī)范描述了一個(gè)標(biāo)準(zhǔn)的自動(dòng)加載器策略;自動(dòng)加載器的意思就是指在程序運(yùn)行時(shí)按需查找PHP類、接口(interface)或性狀(trait)并將其載入加載器。
自動(dòng)加載器策略
PSR-4推薦規(guī)范不要求改變代碼的實(shí)現(xiàn)方式,只建議如何使用文件系統(tǒng)目錄結(jié)構(gòu)和PHP命名空間組織代碼。PSR-4
**依賴**
PHP命名空間和文件系統(tǒng)目錄結(jié)構(gòu)查找并加載PHP類、性狀和接口為什么自動(dòng)加載器很重要
舉一個(gè)很常見(jiàn)的場(chǎng)景,我們引入文件通常都是采用
require
、include
這樣的方法,這樣的方式簡(jiǎn)單也可靠,但是如果我們引入一兩個(gè)還好說(shuō),但是當(dāng)我們一個(gè)項(xiàng)目運(yùn)行時(shí)需要引入幾十個(gè)文件呢,那我們豈不是要寫(xiě)幾十個(gè)require或者include?這樣既不方便,又不美觀,所以PHP-FIG在此基礎(chǔ)上考慮,規(guī)范了一個(gè)統(tǒng)一的自動(dòng)加載器策略;如何使用自動(dòng)加載器
建議使用依賴管理器Composer自動(dòng)生成的PSR-4自動(dòng)加載器。
現(xiàn)代的PHP框架,laravel、Yii、TP5等都使用了依賴Composer的自動(dòng)加載器策略,方便我們下載組件和引入合適的類。PSR-ME:制定自己的PHP規(guī)范
遵循PSR-1、PSR-2的使用規(guī)范
合適、精簡(jiǎn)的變量、方法、類命名。能讓人看一眼就清楚是做什么的
盡量編寫(xiě)出高內(nèi)聚、低耦合的代碼
保持代碼結(jié)構(gòu)整潔、美觀
PHP-FIG推出的PHP規(guī)范,并不一定說(shuō)所有的PHP開(kāi)發(fā)者必須遵守。制定這一規(guī)范的目的就是為了,在全世界的PHP開(kāi)發(fā)者在查看代碼的時(shí)候,能更加簡(jiǎn)單和輕松。造出來(lái)的組件/輪子可以很容易的就被所有開(kāi)發(fā)者熟知和使用,同時(shí)也減少了我們的工作投入率,得到更大的工作效率,使產(chǎn)出大于投入,效率更高更快。
看完上述內(nèi)容是否對(duì)您有幫助呢?如果還想對(duì)相關(guān)知識(shí)有進(jìn)一步的了解或閱讀更多相關(guān)文章,請(qǐng)關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道,感謝您對(duì)創(chuàng)新互聯(lián)的支持。
分享文章:PHP-PSR現(xiàn)代PHPer的開(kāi)發(fā)規(guī)范是怎樣的
網(wǎng)址分享:http://weahome.cn/article/jhpegi.html