PHPCS的安装配置及使用


良好的代码规范可以提高代码可读性,降低团队沟通维护成本

1.PSR标准

PSR是PHP Standards Recommendation的简称,这个是[php-fig](PHP Framework Interop Group)(https://github.com/php-fig)组织制定的一套规范。至今,php-fig已经发布了五个规范:

2.什么是PHPCS github地址

PHP Code Sniffer 是PEAR中的一个用PHP5写的一个PHP的代码风格检测器,它根据预先设定好的PHP编码风格和规则,去检查应用中的代码风格情况是否有违反一组预先设置好的编码标准,内置了ZEND,PEAR的编码风格规则,当然也支持自己定制。PHP CodeSniffer 是确保代码简洁一致的必不可少的开发工具,还可以帮助程序员减少一些语义错误。

3.安装PHPCS

①通过pear方式:
pear下载phpcs地址

pear install PHP_CodeSniffer-3.4.2
如果php版本小于php7,不要安装最新版本的phpcs,php5.6建议安装phpcs3.0.0

②通过composer方式:

composer global require "squizlabs/php_codesniffer=*"

③通过brew方式(mac推荐此种方式):

brew install php-code-sniffer

4.手动方式使用PHPCS

phpcs  application/controller/Admin.php
phpcs  待检测的文件

5.PHPStorm配置PHPCS(推荐此种方式,毕竟自动的省事)

①打开Phpstorm的设置页(File->Setting或者Ctrl+Alt+s)
到Code Sniffer页Setting->Languages and Frameworks->PHP->Code Sniffer
Mac配置的地址为Setting->Languages and Frameworks->PHP->Quality Tools

step1.png

②配置development environment,path就是php路径下的phpcs.bat,按下 Validate进行验证,验证成功后会有绿色文字提示。
PS:Mac电脑上是没有bat文件滴,正确的路径为which phpcs命令找到的路径。Mac版本如果在安装后没有移动phpcs的位置,则可执行文件的位置一般在/usr/local/Cellar/php-code-sniffer/3.4.2/bin/phpcs

step2.png

③配置PHPCS的标准
Setting->Editor->Inspections->PHP->Code Sniffer
Mac版本的配置位置为Setting->Editor->Inspections->PHP->Quality tools->Code Sniffer
在右边的 Coding standard 按下刷新按鈕,成功的话,点击下拉按钮就会有可供选择的标准。

step3.png

6.案例对比

改造前

        $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界面

example.png

查看一下具体错误

example.png

修改后

example.png

7.使用 phpcbf 脚本进行修复

phpcbf 脚本修复  使用方式和phpcs一致
phpcbf  文件名
PS:只能处理代码风格等方式,不能处理命名与代码实现规则,所以少部分需要人为去更正

8.常见错误

①End of line character is invalid; expected "\n" but found "\r\n"
  换行符错误,请切换成LF

②Expected 1 newline at end of file; 0 found
  请在文件末尾设置空白的新行

③Inline control structures are not allowed
  请修改语句的结构,比如if后面加上{},不要直接在if后一行直接写代码

④Line exceeds 120 characters; 
  请将语句长度限制在120字节以内

⑤Expected 1 space after IF keyword;
  请删除语句末尾多余的空格

9. 在命令行执行以下两条命令,设置默认的代码规范

phpcs --config-set default_standard PSR2
phpcbf --config-set default_standard PSR2

使用PHPCS+Git钩子保障团队开发代码风格一致
https://segmentfault.com/a/1190000015971297

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,907评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,987评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,298评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,586评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,633评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,488评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,275评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,176评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,619评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,819评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,932评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,655评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,265评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,871评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,994评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,095评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,884评论 2 354

推荐阅读更多精彩内容