PHPCS的安装配置及使用

最新推荐文章于 2024-08-12 08:30:44 发布

梦情与你

最新推荐文章于 2024-08-12 08:30:44 发布

阅读量4k

点赞数 1

分类专栏： php 运维文章标签： php

原文链接：https://www.jianshu.com/p/d888236286e7

版权

php 同时被 2 个专栏收录

27 篇文章

订阅专栏

运维

7 篇文章

订阅专栏

本文介绍PHP代码规范的重要性及常用工具如PHP_CodeSniffer和php-cs-fixer的使用方法，帮助开发团队统一代码风格。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

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

PHP_CodeSniffer 是一个代码风格检测工具。它包含两类脚本，phpcs 和 phpcbf（GitHub地址）

phpcs

phpcs 脚本对 PHP、JavaScript、CSS 文件定义了一系列的代码规范（通常使用官方的代码规范标准，比如 PHP 的
PSR2），能够检测出不符合代码规范的代码并发出警告或报错（可设置报错等级）。

phpcbf

phpcbf 脚本能自动修正代码格式上不符合规范的部分。比如 PSR2 规范中对每一个 PHP
文件的结尾都需要有一行空行，那么运行这个脚本后就能自动在结尾处加上一行空行。

php-cs-fixer 该工具不包含在 PHP_CodeSniffer 中, 是在另一个独立的项目
https://github.com/FriendsOfP…

php-cs-fixer 修复不规范代码作用等同于 phpcbf 只不过规则好像稍有区别

PSR标准

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

PSR-0：自动加载标准，该标准已被废弃，使用PSR-4替代

PSR-1：基本的编码风格

PSR-2：编码风格（更严格）PSR-2中文说明

PSR-3：日志记录器接口

PSR-4：自动加载

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

手动方式使用PHPCS

phpcs  application/controller/Admin.php

phpcs 待检测的文件

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

②配置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

③配置PHPCS的标准

Setting->Editor->Inspections->PHP->Code Sniffer

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

案例对比
改造前

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

查看一下具体错误

修改后

在这里插入图片描述

使用 phpcbf 脚本进行修复

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

常见错误
①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;
请删除语句末尾多余的空格

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

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

使用PHPCS+Git钩子保障团队开发代码风格一致