PHP静态分析工具：Psalm与PHPStan - 智猿学院-IT界的百科全书

嘿，PHP 老铁们，是时候给你的代码做个体检啦！—— Psalm vs. PHPStan，静态分析工具大乱斗！

各位屏幕前的 PHP 战士们，早上好/下午好/晚上好！我是你们的老朋友，一个在代码世界里摸爬滚打了多年的老司机。今天，咱们不聊框架，不谈设计模式，而是要来一场关于代码健康的深度探讨。

你有没有过这样的经历？深夜苦战，终于搞定了项目，信心满满地 push 到服务器，结果第二天早上，线上炸了！😱

原因嘛，千奇百怪，但往往是一些低级错误，比如：

类型错误： 传递了错误的参数类型给函数，导致程序崩溃。
未定义变量： 粗心大意，忘记定义某个变量，导致程序报错。
死代码： 写了一段永远不会执行的代码，浪费资源，污染代码。
潜在的安全漏洞： 没有正确处理用户输入，导致 SQL 注入或者 XSS 攻击。

这些错误，有些在开发阶段就能发现，但有些却像潜伏的幽灵，只有在线上环境才会显形，让你猝不及防。

难道我们就只能靠肉眼 debug，靠运气上线吗？

当然不！科技改变生活，工具拯救程序员！今天，我要给大家介绍两位能帮你揪出代码里各种疑难杂症的 "神医" —— Psalm 和 PHPStan。它们都是 PHP 静态分析工具，能在代码运行之前，帮你检查代码中的各种错误，提高代码质量，减少线上事故。

一、啥是静态分析？它和动态分析有啥区别？

在深入了解 Psalm 和 PHPStan 之前，我们先来聊聊静态分析的概念。

静态分析，顾名思义，就是在不运行代码的情况下，对代码进行分析。它就像一个经验丰富的医生，通过查看你的病历、体检报告，就能判断你可能存在的健康问题。

与静态分析相对的是动态分析，也叫运行时分析。动态分析需要运行代码，通过观察代码的执行过程，来发现错误。这就像医生通过观察你的行为、反应，来判断你的健康问题。

用一个表格来对比一下：

特性	静态分析	动态分析
执行代码	否	是
检测时机	编译时/开发时	运行时
优点	提前发现错误，无需运行代码，覆盖范围广	可以发现运行时才能出现的错误，更贴近实际
缺点	可能存在误报，无法检测运行时错误	需要运行代码，覆盖范围有限，可能影响性能

二、 Psalm 和 PHPStan：两位代码医生的性格大 PK！

Psalm 和 PHPStan 都是优秀的 PHP 静态分析工具，但它们也有各自的特点和侧重点。就像两位医生的性格不同，擅长的领域也不同。

Psalm：严谨的老教授，追求极致的准确性！

Psalm 的目标是提供最准确的类型分析，尽可能减少误报。它就像一位严谨的老教授，对代码的每一个细节都一丝不苟，力求找出所有潜在的问题。
- 优点：
  - 高精度： Psalm 的类型推断能力非常强大，能准确分析复杂代码中的类型信息。
  - 可配置性强： Psalm 提供了丰富的配置选项，可以根据项目的具体需求进行定制。
  - 增量分析： Psalm 支持增量分析，可以只分析修改过的代码，提高分析速度。
  - 支持泛型： Psalm 对 PHP 的泛型（Generics）提供了良好的支持。
- 缺点：
  - 学习曲线较陡峭： Psalm 的配置比较复杂，需要花费一些时间学习。
  - 速度相对较慢： 由于追求高精度，Psalm 的分析速度相对较慢。
  - 对代码规范要求高： Psalm 对代码规范要求比较严格，如果代码不规范，可能会出现较多的误报。
PHPStan：务实的急诊医生，快速找出常见问题！

PHPStan 的目标是快速发现代码中的常见错误，提高开发效率。它就像一位务实的急诊医生，能迅速判断出代码中的主要问题，并给出解决方案。
- 优点：
  - 易于上手： PHPStan 的配置非常简单，几乎不需要任何配置就能开始使用。
  - 速度快： PHPStan 的分析速度非常快，适合大型项目。
  - 错误提示友好： PHPStan 的错误提示非常详细，能帮助开发者快速定位问题。
  - 生态丰富： PHPStan 拥有丰富的插件生态，可以扩展其功能。
- 缺点：
  - 精度相对较低： PHPStan 的类型推断能力不如 Psalm，可能会出现一些漏报。
  - 配置选项较少： PHPStan 的配置选项相对较少，定制性不如 Psalm。

用一个表格来总结一下：

特性	Psalm	PHPStan
目标	高精度，减少误报	快速发现常见错误
精度	高	较高
速度	较慢	快
易用性	较难	简单
配置	复杂	简单
泛型支持	支持	部分支持
适用场景	对代码质量要求高的项目，需要深度分析的代码	快速提高代码质量的项目，需要快速发现错误的代码

三、实战演练：让 Psalm 和 PHPStan 给你把把脉！

光说不练假把式！接下来，我们通过一些实际的例子，来看看 Psalm 和 PHPStan 是如何工作的。

假设我们有这样一段 PHP 代码：

<?php

/**
 * @param int $a
 * @param int $b
 * @return int
 */
function add(int $a, int $b): int
{
    return $a + $b;
}

$result = add(1, "2");

echo "Result: " . $result . PHP_EOL;

function sayHello(string $name = null): void
{
    echo "Hello, " . $name . "!" . PHP_EOL;
}

sayHello();

$user = new stdClass();
echo $user->name; // Potentially undefined property stdClass::$name

这段代码包含了几个潜在的问题：

add() 函数的第二个参数类型错误，应该传递整数，却传递了字符串。
sayHello() 函数的参数允许为 null，但没有处理 null 的情况。
访问了 stdClass 对象的未定义属性。

接下来，我们分别使用 Psalm 和 PHPStan 来分析这段代码。

1. 使用 Psalm 分析

首先，我们需要安装 Psalm：

composer require vimeo/psalm --dev

然后，运行 Psalm：

./vendor/bin/psalm

Psalm 会输出如下错误信息：

src/example.php:13:5 - InvalidArgument - Argument 2 of add expects int, but string given (see https://psalm.dev/1)
src/example.php:18:1 - NullableReturnStatement - Method sayHello has parameter $name with type string|null, but doesn't check for null anywhere (see https://psalm.dev/2)
src/example.php:23:5 - PossiblyUndefinedPropertyFetch - Property $name is not defined on object of type stdClass (see https://psalm.dev/4)

可以看到，Psalm 准确地发现了代码中的三个问题，并给出了详细的错误提示和链接，方便我们了解更多信息。

2. 使用 PHPStan 分析

首先，我们需要安装 PHPStan：

composer require phpstan/phpstan --dev

然后，运行 PHPStan：

./vendor/bin/phpstan analyse src

PHPStan 会输出如下错误信息：

 ------ ------------------------------------------------------------------------------------
  Line   src/example.php
 ------ ------------------------------------------------------------------------------------
  13     Parameter #2 $b of function add expects int, 'string' given.
  18     Parameter $name of method sayHello() is declared as string|null but is missing a
         default value.
  23     Access to an undefined property stdClass::$name.
 ------ ------------------------------------------------------------------------------------

PHPStan 也发现了代码中的三个问题，并给出了简洁明了的错误提示。

四、如何选择？听听我的建议！

Psalm 和 PHPStan 都是优秀的工具，选择哪个取决于你的具体需求。

如果你对代码质量要求非常高，希望尽可能减少误报，并且愿意花费一些时间学习和配置，那么 Psalm 是一个不错的选择。 就像你想打造一辆极致性能的跑车，需要精心调校每一个部件。
如果你希望快速提高代码质量，快速发现常见错误，并且不想花费太多时间配置，那么 PHPStan 是一个更适合的选择。 就像你想购买一辆经济实用的家用车，不需要太多配置，只要能安全舒适地行驶就行。
或者，你也可以同时使用 Psalm 和 PHPStan，取长补短，让你的代码更加健壮！ 就像你同时拥有跑车和家用车，可以根据不同的场景选择不同的交通工具。

五、总结：代码体检，刻不容缓！

各位老铁们，代码质量是软件开发的基础，而静态分析工具则是提高代码质量的利器。无论是 Psalm 还是 PHPStan，都能帮助我们提前发现代码中的问题，避免线上事故，提高开发效率。

所以，不要再犹豫了，赶紧给你的代码做个体检吧！让 Psalm 和 PHPStan 成为你的代码医生，守护你的项目健康！

希望这篇文章能帮助你更好地了解 Psalm 和 PHPStan，并在你的项目中选择合适的工具。记住，代码质量不是一蹴而就的，需要持续的投入和改进。让我们一起努力，写出更健壮、更优雅的 PHP 代码！💪

最后，祝大家编码愉快，永不宕机！🎉

嘿，PHP 老铁们，是时候给你的代码做个体检啦！—— Psalm vs. PHPStan，静态分析工具大乱斗！

发表回复 取消回复

发表回复取消回复