Intelephense 对 Psalm/PHPStan 注解的支持与优化实践

背景介绍

Intelephense 作为 PHP 开发者广泛使用的代码智能提示工具，在处理现代 PHP 代码中的类型注解时扮演着重要角色。随着静态分析工具如 Psalm 和 PHPStan 的流行，越来越多的项目开始使用这些工具特有的注解语法来增强代码的类型安全性。

问题核心

在 PHPUnit 的 createMock 方法中，开发者通常会遇到一个典型的类型注解场景：

/**
 * @psalm-template RealInstanceType of object
 * @psalm-param class-string<RealInstanceType> $originalClassName
 * @psalm-return MockObject&RealInstanceType
 */
protected function createMock(string $originalClassName): MockObject {}

理想情况下，当调用 createMock(Foo::class) 时，返回类型应该是 Foo&MockObject。然而，Intelephense 默认只会识别原生的 MockObject 返回类型，而忽略了 Psalm 的扩展类型注解。

解决方案

Intelephense 提供了专门的配置项来处理这种情况：

{
    "intelephense.compatibility.preferPsalmPhpstanPrefixedAnnotations": true
}

启用此选项后，Intelephense 会优先解析 @psalm- 和 @phpstan- 前缀的注解，而不是标准的 PHPDoc 注解。需要注意的是，修改此设置后可能需要关闭并重新打开文件才能使类型信息刷新。

进阶应用

在实际项目中，我们可能会遇到更复杂的类型注解场景。例如：

final class Server {
    /**
     * @psalm-template T
     * @psalm-param class-string<T>|string $serviceName
     * @psalm-return ($serviceName is class-string<T> ? T : mixed)
     */
    public static function get(string $serviceName) {
        // ...
    }
}

当调用 Server::get(MyClass::class) 时，Intelephense 应该能正确推断出返回类型为 MyClass。然而，如果注解过于复杂或混合使用了标准注解和 Psalm 注解，可能会导致类型推断失败。

最佳实践

1. 保持注解简洁：避免不必要的复杂注解结构，简化模板定义
2. 统一注解风格：在项目中统一使用 @psalm- 或 @phpstan- 前缀
3. 避免混合使用：不要在同一文档块中混合使用标准注解和 Psalm/PHPStan 注解
4. 配置一致性：确保团队所有成员使用相同的 Intelephense 配置

技术原理

Intelephense 的类型系统支持 PHPDoc 标准中的基本类型注解，但对于更高级的类型系统特性（如条件类型、模板约束等），需要通过专门的配置来启用对 Psalm/PHPStan 扩展注解的支持。这些扩展注解提供了更强大的类型表达能力，能够更精确地描述复杂的类型关系。

总结

通过合理配置 Intelephense 并遵循最佳实践，开发者可以充分利用现代 PHP 静态分析工具提供的强大类型系统，获得更准确的代码提示和类型检查。这不仅提高了开发效率，也增强了代码的可靠性和可维护性。