首先安装phpStan为开发依赖,再创建配置文件并设置检查级别和路径,最后运行分析命令。通过composer require –dev phpstan/phpstan安装后,在项目根目录创建phpstan.neon文件,配置level为5并指定src等分析路径,执行vendor/bin/phpstan analyse进行代码检查,可逐步提升level级别,并将命令集成到composer scripts中,建议在CI流程中自动执行以保障代码质量。

在 PHP 项目中,静态代码分析能帮助你提前发现潜在错误、类型不匹配和代码坏味道。PHPStan 是目前功能强大且使用广泛的静态分析工具之一。通过 Composer 集成 PHPStan 非常简单,下面教你一步步在现有或新创建的 Composer 项目中集成并使用 PHPStan。
安装 PHPStan
进入你的项目根目录(确保有 composer.json 文件),执行以下命令来安装 PHPStan 作为开发依赖:
composer require –dev phpstan/phpstan
这会将 PHPStan 安装到 vendor/bin 目录下,你可以通过 vendor/bin/phpstan 来运行它。
创建 PHPStan 配置文件
在项目根目录创建一个 phpstan.neon 文件,用于配置分析规则。最基础的配置如下:
立即学习“PHP免费学习笔记(深入)”;
parameters: level: 5 paths: – src
说明:
- level:表示检查严格程度,范围从 0 到 9。推荐从 5 开始,逐步提升。
- paths:指定要分析的目录,比如你的源码放在 src 目录下。
如果你的测试代码也需要检查,可以加上:
paths: – src – tests
运行 PHPStan 检查
执行以下命令开始静态分析:
vendor/bin/phpstan analyse
如果一切正常,你会看到类似“[OK] No errors”的提示。如果有问题,PHPStan 会列出文件名、行号和具体错误信息。
提升使用体验的小技巧
- 设置更高 level:当你修复了 level 5 的问题后,可以尝试升级到 level 8 或 9,获得更严格的类型检查。
- 自定义自动加载:如果你的项目没有使用 Composer 自动加载,可以添加 bootstrap 文件:
parameters: autoload_files: – bootstrap.php
- 集成到 composer scripts:在 composer.json 中添加脚本,方便调用:
“scripts”: { “analyse”: “phpstan analyse” }
之后就可以用 composer analyse 来运行检查。
基本上就这些。集成 PHPStan 后,建议在 CI 流程中加入静态分析步骤,保证每次提交的代码都经过检查,提升项目质量。


