PHPStorm在Debian上如何配置代码审查工具

PHPStorm 在 Debian 上配置代码审查工具，这事儿其实没那么复杂。代码审查的核心，无非是把静态分析、风格检查和 Git 钩子这些手段整合到 IDE 里，让它们实时替你盯着代码质量。下面就是在 Debian 系统上一步步配置的方法，涵盖了从安装到实战的完整流程。

一、前置准备：装好基础环境

在动手配置之前，得先把 Debian 上的 PHP 和 Composer 搞定，环境变量也顺手配好。这一步没什么门槛，但缺了哪个后面都会报错。

1. 安装 PHP 及扩展：运行下面这条命令，装上 PHP 核心组件以及常用的扩展（比如 php-xml，因为不少工具依赖 XML 解析）：

   sudo apt update && sudo apt install php php-cli php-xml php-json -y

2. 安装 Composer：通过官方脚本全局安装，后续工具的安装和管理都靠它：

   curl -sS https://getcomposer.org/installer | php
   sudo mv composer.phar /usr/local/bin/composer

   验证一下：composer --version 如果能正常显示版本号，就说明装好了。

二、配置 PHP CodeSniffer：代码风格检查

PHP CodeSniffer（简称 phpcs）是 PHP 项目里最常用的风格检查工具，专门用来校验代码是否遵循 PSR-1、PSR-2、PSR-12 等编码规范。

1. 全局安装 phpcs：用 Composer 一句搞定：

   composer global require "squizlabs/php_codesniffer=*"

   安装后，可执行文件默认在 ~/.composer/vendor/bin/phpcs。建议把这个路径加到系统 PATH 里，或者后面直接写绝对路径。

2. 在 PHPStorm 里配置 phpcs：
   打开 File → Settings → Languages & Frameworks → PHP → Code Sniffer，在“Configuration”栏点击 ...，选择刚才的 phpcs 可执行文件。点一下“Validate”确认，如果显示“Configuration is valid”，就算接上了。

3. 启用实时检查并指定规则集：
   进入 Editor → Inspections，展开“PHP”节点，勾上“PHP Code Sniffer Validation”。然后在“Coding standard”下拉菜单里选一个规范，比如“PSR2”或“PSR12”。这样 IDE 就会实时标记出缩进、命名等风格问题。

三、配置 PHP Mess Detector：代码复杂度分析

PHPMD 是专门用来检测代码复杂度、重复代码、未使用变量之类“坏味道”的工具，能帮你把代码结构优化得更清爽。

1. 全局安装 phpmd：同样用 Composer：

   composer global require "phpmd/phpmd=*"

   可执行文件在 ~/.composer/vendor/bin/phpmd。

2. 在 PHPStorm 里配置 phpmd：
   进入 File → Settings → Languages & Frameworks → PHP → Quality Tools → PHP Mess Detector，同样设置路径并验证。

3. 设置规则集：
   在“Rulesets”栏，你可以选择内置规则集（比如 cleancode、codesize、design），也可以指定自定义的 ruleset.xml 文件，用来精确控制检测哪些项目——比如方法太长、重复代码过多等等。

四、配置 PHPStan / Psalm：静态类型分析

这两个工具是静态类型检查的好手，能发现类型错误、未定义的方法或属性这类运行时才能暴露的问题，提前把坑填上。

1. 全局安装：

   • 安装 PHPStan：composer global require "phpstan/phpstan"，路径 ~/.composer/vendor/bin/phpstan。
   • 安装 Psalm：composer global require "vimeo/psalm"，路径 ~/.composer/vendor/bin/psalm。

2. 在 PHPStorm 里配置：
   进入 File → Settings → Languages & Frameworks → PHP → Code Sniffer（或者根据 PHPStorm 版本不同，可能在“Static Analysis”选项卡下），分别设置 PHPStan 和 Psalm 的可执行文件路径，然后验证。

3. 设置分析级别：
   PHPStan 支持级别 1 到 8，级别越高检查越严格，建议从级别 1 开始，逐步提升。Psalm 也有“strict”“loose”等模式，按项目实际情况选就行。

五、集成 Git Hook：提交前自动拦截

光在 IDE 里做检查还不够，团队协作时最好在代码提交前强制跑一遍检查，防止不合格的代码混进仓库。Git 的 pre-commit 钩子正好干这个。

1. 创建 pre-commit 钩子：
   在项目根目录 .git/hooks 文件夹下新建一个名为 pre-commit 的文件（无后缀），并赋予执行权限：

   cd /path/to/your/project/.git/hooks
   touch pre-commit
   chmod +x pre-commit

2. 编写钩子脚本：
   编辑 pre-commit，贴上下面这段内容（这里以 phpcs 为例，也可以按照需求加入 phpmd、phpstan）：

   #!/bin/bash
   
   # 获取所有将要提交的 PHP 文件
   FILES=$(git diff --cached --name-only --diff-filter=ACMR | grep '.php$')
   
   if [ -z "$FILES" ]; then
       echo "No PHP files to check."
       exit 0
   fi
   
   # 运行 phpcs 检查
   for FILE in $FILES; do
       ~/.composer/vendor/bin/phpcs --standard=PSR2 --colors $FILE
       if [ $? -ne 0 ]; then
           echo "PHP CodeSniffer check failed for $FILE. Please fix the issues and try again."
           exit 1
       fi
   done
   
   echo "All PHP files passed the checks."
   exit 0

   这段脚本会遍历所有暂存的 PHP 文件，如果发现不符合 PSR2 规范的地方，就中断提交，并提示你修改。

六、启用实时代码检查

PHPStorm 默认就开着实时检查功能——你写代码的时候，任何不符合规范或潜在的问题都会用波浪线标出来（红色是错误，黄色是警告）。如果没开，可以到 Editor → Inspections 里勾上“Enable inspections”。鼠标点一下波浪线，还能看到具体问题描述和修复建议，比如“方法名应使用驼峰式”或“缺少文件注释”。

按照上面这些步骤，你就能在 Debian 系统上用 PHPStorm 搭建起一套完整的代码审查体系，覆盖风格规范、复杂度分析、类型安全等多个维度——团队代码质量，也就有了保障。