如何寫出優(yōu)雅耐看的PHP代碼?本篇文章帶大家了解一下PHP代碼的基本書寫規(guī)范和框架規(guī)范,了解它們讓你的PHP代碼優(yōu)雅一個(gè)檔次!
引言
今天老王同學(xué)跟我說,他的代碼好糟糕,像一坨xiang。問我要怎么
提高自己的代碼質(zhì)量,讓自己代碼看得順眼一點(diǎn),舒服一點(diǎn), 就像
看到大長腿MM,兩眼放光那種。
于是我: 你先這樣,然后這樣,然后再那樣。。。。。。
老王同學(xué): 別鬧, 到底是哪樣?
好的, 我要開始裝13了。。。
基本規(guī)范
先說一下最基本的東西:
-
變量名使用駝峰命名。不懂的單詞不要用拼音,而是要查詞典找到對應(yīng)的單詞。
-
常量命名使用大寫下劃線方式命名。如:
SYSTEM_EROOR = 50000
。 -
縮進(jìn)使用Tab鍵,不要打一堆空格做縮進(jìn)。
-
類名首字母大寫駝峰命名,需要見名知其意,注釋說明這個(gè)類的功能。例如:
- 方法名駝峰命名,方法行數(shù)盡量控制在80行左右,注釋說明函數(shù)干嘛用的。
- 花括號獨(dú)占一行,例如:
- foreach慎用引用,例如以下代碼會(huì)有問題:
預(yù)期結(jié)果是輸出: 2 4 6
,實(shí)際結(jié)果是2 4 4
, 至于為什么可 以看我之前的文章: PHP中
&符號你真的了解嗎?。 可以使用
array_walk`方法避免這個(gè)問題, 示例:
- 避免
if
,elese
嵌套過深,很多嵌套可以通過提前終止來消除, 舉個(gè)簡單的例子:
建議使用第二種方式,不符合條件的直接返回,剩下的就是符號條件的,那么避免了在if里面寫很多代碼。
-
多個(gè)
if/else
使用switch來替代,PHP8.0版本可以使用match
更為簡潔。 -
phpstorm
中安裝SonarLint
插件。如果你寫的代碼出現(xiàn)虛線,說明不太理想,那么可以根據(jù)提示修改,相信有強(qiáng)迫癥的同學(xué)一定會(huì)改,久而久之代碼就很規(guī)范了。例如:
方法未使用,方法名不規(guī)范已經(jīng)告訴你了,可以快捷修改,也可以自己修改。
框架規(guī)范
-
前面說得都是比較基礎(chǔ)的東西,接下來才是主要的內(nèi)容。
-
相信很多同學(xué)都用過常用的
thinkphp
丶laravel
丶yii
等流行框架之一。 -
這些框架都是MVC架構(gòu)的,看過很多人的代碼,要么把業(yè)務(wù)邏輯寫在控制器里面,要么寫在Model里面, 寫在Model里面相比寫控制器里面的還相對好一點(diǎn)。其實(shí)對于大型項(xiàng)目都不太友好。
-
下文以Laravel框架為例。
參數(shù)驗(yàn)證
-
API需要進(jìn)行參數(shù)驗(yàn)證,但是參數(shù)驗(yàn)證寫在哪里比較優(yōu)雅呢?可能很多人在controller定義規(guī)則,然后在調(diào)用驗(yàn)證方法,那么驗(yàn)證那段代碼將在每個(gè)API里面出現(xiàn),例如我同事寫的。
-
這段代碼在每個(gè)API里面均會(huì)出現(xiàn)一次,豈不是很啰嗦,那么如何解決呢?
- 在Laravel的http目錄下建立一個(gè)
Requsts
目錄,用于存放請求的參數(shù)驗(yàn)證類。建立一個(gè)BaseRequest
類:
比如登錄需要參數(shù)驗(yàn)證再建立一個(gè)LoginRequest
類繼承這個(gè)BaseRequest
。
- 使用的時(shí)候只要在Controller的方法中注入這個(gè)請求類即可。
這里獲取請求參數(shù)的時(shí)候會(huì)對表單進(jìn)行驗(yàn)證,否則參數(shù)驗(yàn)證失敗會(huì)調(diào)用剛剛Request積累定義的方法拋Json異常,返回信息給客戶端。
控制器
控制器的主要工作負(fù)載獲取請求數(shù)據(jù)和返回內(nèi)容,不應(yīng)做