(转)[PHP]PHPCS的安装配置及使用

最新推荐文章于 2025-06-03 09:02:50 发布

转载最新推荐文章于 2025-06-03 09:02:50 发布 · 609 阅读

0 ·

CC 4.0 BY-SA版权

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

文章标签：

#phpcs

PHP 专栏收录该内容

11 篇文章

订阅专栏

本文介绍PHP代码规范的重要性，详细解析PSR标准，包括PSR-1至PSR-4，并介绍如何使用PHPCodeSniffer(PHPCS)来确保代码遵循这些规范。涵盖PHPCS的安装、配置及在PHPStorm中的应用，通过案例展示规范前后代码的对比，以及如何利用phpcbf脚本自动修复代码风格问题。

转自: https://www.jianshu.com/p/d888236286e7

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

1.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：自动加载

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.案例对比

改造前

配置了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;
  请删除语句末尾多余的空格