RectorPHP 中如何将非属性 @var 注解转换为 assert() 验证

在 PHP 开发中，类型安全是一个重要的话题。RectorPHP 项目提供了一个名为 InlineVarDocTagToAssertRector 的规则，它能够将代码中的非属性 @var 注解转换为运行时类型验证的 assert() 语句。

转换机制的作用

传统上，开发者使用 @var 注解来标注变量的预期类型，但这只是文档级别的提示，不会在运行时进行任何验证。通过转换为 assert() 语句，可以在运行时实际检查变量类型，提高代码的健壮性。

转换示例

原始代码：

/**
 * @var string
 */
$foo = strtok($foo, '/');

转换后：

$foo = strtok($foo, '/');
assert(is_string($foo));

支持的类型

该规则主要支持以下类型的转换：

• 基本类型：int、string、bool 等
• 数组类型：如 string[]
• 对象类型：如 @var ClassName，会转换为 instanceof 检查

注意事项

1. 这种转换可能会使原本能运行的代码在类型不匹配时抛出异常
2. 需要确保服务器的 php.ini 中 assert 配置正确
3. 建议在开发环境或严格模式下使用此规则

高级用法

对于更复杂的类型检查，如：

• 非空字符串
• 非空数组
• 数组结构定义

可以考虑扩展或自定义规则来实现这些高级验证。

总结

将文档注释转换为运行时验证是提高 PHP 代码质量的有效手段。RectorPHP 的这项功能为开发者提供了一种自动化实现方式，但使用时需要权衡其对现有代码的影响。