深入解析Psalm静态分析工具的工作原理

深入解析Psalm静态分析工具的工作原理

psalm A static analysis tool for finding errors in PHP applications 项目地址: https://gitcode.com/gh_mirrors/ps/psalm

引言

Psalm是一款强大的PHP静态分析工具，它通过深入分析代码来发现潜在的错误和类型问题。本文将深入探讨Psalm的内部工作机制，帮助开发者理解这个工具如何完成从代码扫描到类型分析的完整过程。

整体架构

Psalm的核心分析入口是ProjectAnalyzer类，它负责协调整个分析流程的两个主要阶段：

1. 扫描阶段（Scanning）
2. 分析阶段（Analysis）

扫描阶段详解

扫描的目的

扫描阶段的主要任务是确定所有可能的依赖关系，并获取它们的函数签名和常量定义。这一阶段为后续的多线程分析奠定基础。

扫描过程

扫描工作由Scanner类完成，其核心流程如下：

1. 代码解析：使用PHP-Parser将PHP代码转换为抽象语法树(AST)
2. 访问者模式处理：使用自定义的ReflectorVisitor遍历AST

深度扫描与浅度扫描

Psalm采用两种扫描策略：

• 浅度扫描：仅获取函数签名、返回类型、常量和继承关系
• 深度扫描：深入函数内部语句获取所有依赖关系

实际应用中，Psalm会对需要分析的文件进行深度扫描，而对vendor目录中的大部分文件仅执行浅度扫描。

类名到文件的映射

Psalm通过以下方式建立类名与文件的映射关系：

• 项目文件：使用PHP反射机制
• 依赖库文件：使用Composer的类映射表

数据存储

扫描过程中收集的信息被存储在多个专用类中：

• FileStorage：存储文件级别的信息
• ClassLikeStorage：存储类、接口、trait的信息
• FunctionLikeStorage：存储函数和方法的信息

扫描阶段结束后，所有收集的信息会被整理并存储在专门的提供者类中，为分析阶段做好准备。

分析阶段详解

文件分析

FileAnalyzer负责分析单个文件，它会识别文件中的顶层组件：

• 类
• trait
• 接口
• 函数
• 命名空间及其内容

组件分析

FileAnalyzer将不同类型的组件分发给专门的解析器：

• ClassAnalyzer：处理类
• InterfaceAnalyzer：处理接口
• FunctionAnalyzer：处理函数

函数分析流程

函数分析是最基础的分析场景，其流程如下：

1. 从扫描阶段获取FunctionLikeStorage对象
2. 创建Context对象存储变量和属性的类型信息
3. 使用StatementsAnalyzer分析函数体中的语句
4. 处理分支语句时的上下文克隆与合并
5. 收集返回类型并与声明类型比较

类型协调机制

Reconciler是Psalm中处理类型协调的核心组件，它能够：

• 接收断言数组（如["$a" => "!null"]）
• 结合现有类型信息（如$a => string|null）
• 返回更新后的类型信息（如$a => string）

技术亮点

1. 多线程支持：通过分离扫描和分析阶段，实现了高效的多线程分析
2. 智能扫描策略：深度/浅度扫描的区分大幅提升了分析效率
3. 上下文感知：通过Context对象精确跟踪代码执行路径中的类型变化
4. 类型系统：强大的类型协调机制能够处理复杂的类型断言和转换

结语

Psalm通过精心设计的架构和算法，实现了对PHP代码的高效静态分析。理解其内部工作原理不仅有助于更好地使用这个工具，也能为开发者设计自己的分析工具提供宝贵参考。无论是扫描阶段的依赖收集，还是分析阶段的类型推断，Psalm都展现了静态代码分析的强大能力和复杂细节。

psalm A static analysis tool for finding errors in PHP applications 项目地址: https://gitcode.com/gh_mirrors/ps/psalm