Phan 静态分析器使用教程

Phan 静态分析器使用教程

phan Phan is a static analyzer for PHP. Phan prefers to avoid false-positives and attempts to prove incorrectness rather than correctness. 项目地址: https://gitcode.com/gh_mirrors/ph/phan

1. 项目介绍

Phan 是一个专为 PHP 设计的静态分析器，旨在减少误报，更倾向于证明代码的不正确性而非正确性。它可以检测常见的代码问题，并在有类型信息或可推断类型信息的情况下，验证类型兼容性。Phan 对流程控制有很好的理解（尽管不是全面的），能够追踪数组、整数和字符串等值的流向。

2. 项目快速启动

要使用 Phan，最简单的方式是借助 Composer 安装。

composer require phan/phan

安装 Phan 后，需要在项目中创建一个 .phan/config.php 配置文件，以告诉 Phan 如何分析您的源代码。配置完成后，可以通过以下命令运行 Phan：

./vendor/bin/phan

Phan 5 需要 PHP 7.2 或更高版本，以及 php-ast 扩展（推荐版本 1.1.1 或更高）。Phan 支持 PHP 7.0 到 8.2 的语法分析。

如果不安装 php-ast 扩展，也可以通过 CLI 选项 --allow-polyfill-parser 使用 Phan，但文档注释的解析会有细微差异。

3. 应用案例和最佳实践

案例一：检测类型不安全

假设有以下 PHP 代码：

function add($a, $b) {
    return $a + $b;
}

echo add("1", "2"); // 这将导致类型不安全的警告

Phan 会警告这种类型不安全的操作。

案例二：检测未使用的变量

function example() {
    $ unused = 42; // Phan 将报告此变量未使用
    return 42;
}

Phan 会检测到 $unused 变量未使用，并发出警告。

最佳实践

• 在大型项目中逐步启用更多的分析选项，以逐渐提高分析的严格性。
• 定期运行 Phan，以检测新引入的问题。
• 利用 Phan 的配置选项来排除特定的误报。

4. 典型生态项目

Phan 作为一个静态分析工具，在 PHP 开发生态中具有重要地位。以下是一些与 Phan 相关的典型生态项目：

• PHPStan：另一个流行的 PHP 静态分析工具。
• Psalm：PHP 的静态类型检查器。
• ESLint：JavaScript 的静态分析工具，与 Phan 类似，但用于不同的编程语言。

以上教程介绍了 Phan 的基本使用方法和最佳实践，希望对您的 PHP 项目开发有所帮助。

phan Phan is a static analyzer for PHP. Phan prefers to avoid false-positives and attempts to prove incorrectness rather than correctness. 项目地址: https://gitcode.com/gh_mirrors/ph/phan