良好的代碼規(guī)范可以提高代碼可讀性嗤军,降低團(tuán)隊(duì)溝通維護(hù)成本
1.PSR標(biāo)準(zhǔn)
PSR是PHP Standards Recommendation的簡(jiǎn)稱(chēng),這個(gè)是[php-fig](PHP Framework Interop Group)(https://github.com/php-fig)組織制定的一套規(guī)范梯找。至今,php-fig已經(jīng)發(fā)布了五個(gè)規(guī)范:
PSR-0:自動(dòng)加載標(biāo)準(zhǔn)录肯,該標(biāo)準(zhǔn)已被廢棄溉仑,使用PSR-4替代
PSR-1:基本的編碼風(fēng)格
PSR-2:編碼風(fēng)格(更嚴(yán)格)PSR-2中文說(shuō)明
PSR-3:日志記錄器接口
PSR-4:自動(dòng)加載
2.什么是PHPCS github地址
PHP Code Sniffer 是PEAR中的一個(gè)用PHP5寫(xiě)的一個(gè)PHP的代碼風(fēng)格檢測(cè)器,它根據(jù)預(yù)先設(shè)定好的PHP編碼風(fēng)格和規(guī)則姚淆,去檢查應(yīng)用中的代碼風(fēng)格情況是否有違反一組預(yù)先設(shè)置好的編碼標(biāo)準(zhǔn)孕蝉,內(nèi)置了ZEND,PEAR的編碼風(fēng)格規(guī)則腌逢,當(dāng)然也支持自己定制。PHP CodeSniffer 是確保代碼簡(jiǎn)潔一致的必不可少的開(kāi)發(fā)工具超埋,還可以幫助程序員減少一些語(yǔ)義錯(cuò)誤搏讶。
3.安裝PHPCS
①通過(guò)pear方式:
pear下載phpcs地址
pear install PHP_CodeSniffer-3.4.2
如果php版本小于php7,不要安裝最新版本的phpcs霍殴,php5.6建議安裝phpcs3.0.0
②通過(guò)composer方式:
composer global require "squizlabs/php_codesniffer=*"
③通過(guò)brew方式(mac推薦此種方式):
brew install php-code-sniffer
4.手動(dòng)方式使用PHPCS
phpcs application/controller/Admin.php
phpcs 待檢測(cè)的文件
5.PHPStorm配置PHPCS(推薦此種方式媒惕,畢竟自動(dòng)的省事)
①打開(kāi)Phpstorm的設(shè)置頁(yè)(File->Setting或者Ctrl+Alt+s)
到Code Sniffer頁(yè)Setting->Languages and Frameworks->PHP->Code Sniffer
Mac配置的地址為Setting->Languages and Frameworks->PHP->Quality Tools
②配置development environment,path就是php路徑下的phpcs.bat来庭,按下 Validate進(jìn)行驗(yàn)證妒蔚,驗(yàn)證成功后會(huì)有綠色文字提示。
PS:Mac電腦上是沒(méi)有bat文件滴月弛,正確的路徑為which phpcs命令找到的路徑肴盏。Mac版本如果在安裝后沒(méi)有移動(dòng)phpcs的位置,則可執(zhí)行文件的位置一般在/usr/local/Cellar/php-code-sniffer/3.4.2/bin/phpcs
③配置PHPCS的標(biāo)準(zhǔn)
Setting->Editor->Inspections->PHP->Code Sniffer
Mac版本的配置位置為
Setting->Editor->Inspections->PHP->Quality tools->Code Sniffer
在右邊的 Coding standard 按下刷新按鈕帽衙,成功的話(huà)菜皂,點(diǎn)擊下拉按鈕就會(huì)有可供選擇的標(biāo)準(zhǔn)。
6.案例對(duì)比
改造前
$validate = Validate::make($rule);
$result = $validate->check($params);
if(!$result)
return parent::returnData($params, $validate->getError(), ParamsConsts::STATUS_REQ_PARAM_MISSING);
$dbSelect = Db::name('table_name')->where('is_del', ParamsConsts::DELETE_FALSE)->field(' name, email, tel, remark');
$dbCount = clone $dbSelect;
$resCount = $dbCount->count('aid'); unset($dbCount);
配置了PHPCS后的phpstorm界面
查看一下具體錯(cuò)誤
修改后
7.使用 phpcbf 腳本進(jìn)行修復(fù)
phpcbf 腳本修復(fù) 使用方式和phpcs一致
phpcbf 文件名
PS:只能處理代碼風(fēng)格等方式厉萝,不能處理命名與代碼實(shí)現(xiàn)規(guī)則恍飘,所以少部分需要人為去更正
8.常見(jiàn)錯(cuò)誤
①End of line character is invalid; expected "\n" but found "\r\n"
換行符錯(cuò)誤榨崩,請(qǐng)切換成LF
②Expected 1 newline at end of file; 0 found
請(qǐng)?jiān)谖募┪苍O(shè)置空白的新行
③Inline control structures are not allowed
請(qǐng)修改語(yǔ)句的結(jié)構(gòu),比如if后面加上{},不要直接在if后一行直接寫(xiě)代碼
④Line exceeds 120 characters;
請(qǐng)將語(yǔ)句長(zhǎng)度限制在120字節(jié)以?xún)?nèi)
⑤Expected 1 space after IF keyword;
請(qǐng)刪除語(yǔ)句末尾多余的空格
9. 在命令行執(zhí)行以下兩條命令章母,設(shè)置默認(rèn)的代碼規(guī)范
phpcs --config-set default_standard PSR2
phpcbf --config-set default_standard PSR2
使用PHPCS+Git鉤子保障團(tuán)隊(duì)開(kāi)發(fā)代碼風(fēng)格一致
https://segmentfault.com/a/1190000015971297