PHP前端开发

PHPStan:通过静态分析提高 PHP 代码质量

百变鹏仔 2天前 #PHP
文章标签 静态

在动态类型盛行的 php 生态系统中,管理代码质量并确保无错误开发可能具有挑战性。 phpstan 是一款专为 php 定制的静态分析工具,旨在帮助开发人员在运行代码之前捕获错误和潜在问题。通过静态分析,phpstan 允许开发人员通过在开发早期捕获错误来编写更可靠、可维护和健壮的代码。在这篇文章中,我们将探讨 phpstan 是什么、谁应该使用它、如何将其合并到您的开发工作流程中,以及 phpstan 2.0 中的一些令人兴奋的更新。


什么是 phpstan?

phpstan 是 php 的静态分析工具,可以检查代码并识别问题而不执行代码。与运行时测试不同,静态分析不需要您的代码运行,这使得 phpstan 可以在您编写代码时实时发现问题和潜在的错误。这在 php 中特别有用,其中动态类型系统有时会让问题在运行时才被注意到。

phpstan 通过分析类型、变量、函数调用和其他代码模式来运行,以发现不一致或潜在的错误。它有助于识别错误,例如:

虽然这些问题可能会在运行时被发现(如果被发现的话),但 phpstan 在开发过程中会捕获它们,为开发人员创建更快的反馈循环,并生成更干净、更健壮的代码。

立即学习“PHP免费学习笔记(深入)”;


为什么使用 phpstan?

使用 phpstan 带来许多好处,包括:

  1. 早期检测错误:phpstan 可以帮助您在问题进入生产环境之前识别问题,防止运行时错误影响应用程序的可靠性和性能。
  2. 提高代码质量:通过执行更严格的类型检查和编码实践,phpstan 可以生成更易于维护、可读的代码。
  3. 对重构的信心:当您有像 phpstan 这样的工具来验证您的更改,确保您不会引入新问题时,重构代码就会变得不那么令人生畏。
  4. 跨团队的一致性:phpstan 强制执行编码标准和最佳实践,这可以帮助团队创建更一致的代码库,尤其是在协作环境中。

谁应该使用 phpstan?

phpstan 对于各个级别的 php 开发人员来说都是一个很棒的工具。然而,它对于以下方面特别有价值:

虽然 phpstan 有一个学习曲线,并且最初可能感觉很严格,但它通过提高任何 php 项目的质量和可维护性而很快得到回报。


如何使用 phpstan

phpstan 在项目中设置和开始使用相对简单。以下是快速入门指南:

  1. 安装 phpstan:您可以通过 php 依赖管理器 composer 安装 phpstan:
   composer require --dev phpstan/phpstan
  1. 配置 phpstan:
    可以使用 phpstan.neon 或 phpstan.neon.dist 文件配置 phpstan,您可以在其中指定分析设置、级别和规则。配置文件允许自定义以满足您的项目需求,包括分析路径以及忽略规则和扩展。

  2. 设置分析级别:
    phpstan 提供不同的分析级别(从 0 到 8),其中 0 是最不严格的,8 是最严格的。通常建议从较低级别开始,并随着代码库的改进逐渐增加。

   phpstan analyse --level max src
  1. 运行 phpstan:要分析您的代码库,只需运行:
   phpstan analyse src

phpstan 将输出警告和错误以及在代码中找到它们的上下文,允许您在继续之前解决它们。

  1. 与 ci/cd 集成:phpstan 可以添加到您的 ci/cd 管道中,以确保代码质量检查自动化。许多 ci 服务,例如 github actions、gitlab ci 和 travis ci,都提供了轻松集成 phpstan 的选项。

通过让 phpstan 成为您的开发和审核流程的一部分,您可以减少出现错误的可能性,提高代码质量,并增强对 php 代码的信心。


关于 laravel 项目

1:如果您正在开发 laravel 项目,则可以利用 larastan 软件包,该软件包专为 laravel 应用程序量身定制,并提供特定于 laravel 的附加功能和检查。要安装 larastan,请运行:

composer require --dev "larastan/larastan:^2.0"

2:然后,在应用程序的根目录中创建 phpstan.neon 或 phpstan.neon.dist 文件。它可能看起来像这样:

includes:    - vendor/larastan/larastan/extension.neonparameters:    paths:        - app/    # level 9 is the highest level    level: 5#    ignoreerrors:#        - '#phpdoc tag @var#'##    excludepaths:#        - ./*/*/filetobeexcluded.php##    checkmissingiterablevaluetype: false

有关所有可用选项,请查看 phpstan 文档:https://phpstan.org/config-reference

3:最后,您可以使用 phpstan 控制台命令开始分析代码:

如果您收到错误“允许的内存大小已耗尽”,那么您可以使用 --memory-limit 选项解决问题:

./vendor/bin/phpstan analyse --memory-limit=2g

忽略错误

忽略特定错误可以通过 php 注释或配置文件来完成:

// @phpstan-ignore-next-line$test->badmethod();$test->badmethod(); // @phpstan-ignore-line

忽略 phpstan 配置文件中的错误时,通过根据错误消息编写正则表达式来忽略它们:

parameters:    ignoreerrors:        - '#call to an undefined method .*badmethod()#'

基线文件
在较旧的代码库中,可能很难花时间修复所有代码以通过高 phpstan 级别。

为了解决这个问题,可以生成一个基线文件。基线文件将创建一个包含所有当前错误的配置文件,因此可以按照比旧代码更高的标准编写新代码。 (phpstan 文档)

./vendor/bin/phpstan analyse --generate-baseline

phpstan 2.0 有什么新功能?

在 phpstan 2.0 中,该工具引入了多项强大的新功能,增强了其功能并使其对开发人员更加有效。

  1. 增强的类型推断:phpstan 2.0 提供改进的类型推断,这意味着它可以更准确地理解代码中的复杂类型关系。这样可以更好地检测问题并进行更可靠的分析。

  2. 对泛型的支持:phpstan 2.0 显着增强了对 php 中泛型的支持,为泛型代码模式提供了更准确的类型检查,尤其是在框架和库中。此更新允许使用更少的样板代码实现更清晰的代码,从而更轻松地编写通用类和函数。

  3. 更好地处理遗留代码:phpstan 2.0 已经过优化,可以更有效地分析遗留代码库,帮助开发人员实现旧项目的现代化,而不会因错误而不堪重负。

  4. 性能提高:最新版本的 phpstan 速度更快,使其能够更有效地分析更大的代码库,这在速度至关重要的 ci/cd 环境中特别有益。

  5. 新规则自定义:使用 phpstan 2.0,开发人员可以更好地控制执行哪些规则和检查。这对于具有特定编码标准或偏好的团队特别有用。

phpstan 2.0 代表了 php 静态分析的重大飞跃,提供了更深入的洞察、更大的灵活性和更好的性能,以简化代码质量工作。


最大化 phpstan 影响力的技巧

要充分利用 phpstan,请考虑以下提示:


结论

phpstan 改变了 php 开发人员的静态分析,带来了一组强大的工具来在开发过程的早期识别和解决问题。随着 phpstan 2.0 的发布,它比以往任何时候都更强大,拥有增强的类型推断、对泛型的更好支持以及性能改进,使其成为现代 php 开发的重要工具。

通过将 phpstan 集成到您的开发工作流程中,您可以投资于代码质量、减少错误,并最终创建更可靠和可维护的代码库。无论您是从事大型协作项目还是只是想改进个人项目,phpstan 都是每个 php 开发人员都应该考虑的宝贵资产。