PhpStorm集成PSR2代码自动检查

我们写代码要遵循一定的规范, 但是我们有时候会犯错，所以需要有一个检查机制。当我们犯错的时候检查机制会发挥作用。下面介绍一下如何在phpstrom上设置代码检查。

代码规范

php有很多规范，现代Php要求遵循的是PSR规范。PSR是PHP通用性框架小组FIG（PHP Framework Interop Group） 制定的PHP规范，是PHP开发的事实标准。关于PSR的中文文档，可以参考https://github.com/PizzaLiu/PHP-FIG

让phpstrom支持基于PSR2的代码检查的步骤

环境： windows10 操作系统， PhpStrom版本2017.1.4

安装phpcs

  使用composer全局安装
     composer global require "squizlabs/php_codesniffer=*"

  *注*：windows系统,会在C:\Users\{user name}\AppData\Roaming\Composer\vendor\bin下生成一个phpcs.bat 文        件,这个是PhpStorm后续设置需要用到的文件。

PhpStorm设置
● 步骤1：打开PhpStorm点击 File->Settings
● 步骤2：接着点击Languages & Frameworks->PHP->Code Sniffer点击Configuration右侧的按钮，
● 步骤3：选择PHP Code Sniffer (phpcs) path:的路径，就是刚才composer之后生成的那个phpcs.bat的路径。
● 步骤4：选择之后点击Validate验证成功
● 步骤5：节点点击Editor->Inspections展开点击右侧的PHP
● 步骤6：勾选PHP Code Sniffer Validation 选择右侧的PSR2
● 步骤7：点击验证成功 大功告成！！

看看效果

当写的代码不符合PSR2规范的时候该行代码下会有波浪线,点击波浪线可以查看提示信息，根据提醒进行代码规范修改。

集成 PHP-CS-Fixer

一般我们都是使用 PHP_CodeSniffer 来检查代码并手动更改， 显得比较麻烦，PHP-CS-Fixer 这个工具可以在不破坏代码相容性的情况下，自动帮我们把 PHP 代码修改为符合 PSR-2 规范的代码。集成操作如下：
1. 下载 php-cs-fixer.phar，下载地址为：
     http://cs.sensiolabs.org/download/php-cs-fixer-v2.phar
2. File->Settings->Tools->External Tool 下新建一个外部工具，配置如下：
     Name             : PHP-CS-FIX
     Program          : Directory\php.exe
     Parameters       : Directory\php-cs-fixer-v2.phar --verbose fix "$FilePath$"
     Working directory: $ProjectFileDir$
3. 保存上面设置之后，我们就可以在任意目录或者文件或者项目里面运行 PHP-CS-FIX：
   选中需要执行PHP-CS-FIX 的目录或文件，然后右键 External Tool->PHP-CS-FIX,这样php-cs-fixer
   就会把选中的目录下的所有PHP代码或者选中的代码文件按规范进行修正。
      

以上是PhpStorm 2017.1.4 配置代码检查工具的通用步骤，基于windows的环境用的。不同的版本可能设置上会有差异。在linux/mac环境下的步骤是一样的，区别就在步骤3中选择phpcs文件的路径不同，还有就是windows下是用的phpcs.bat文件，linux/mac下是phpcs文件。下面提供了一份图文结合的文档，可下载下面PDF文档查看：

PhpStorm集成PSR2代码自动检查.pdf