RectorPHP 中如何将自定义注解转换为属性

在 PHP 8.0 及以上版本中，属性(Attribute)已经成为了替代传统文档块注解(DocBlock Annotation)的现代方式。RectorPHP 作为一个强大的代码重构工具，提供了将传统注解转换为属性的功能。

注解转换的基本原理

RectorPHP 的 AnnotationToAttributeRector 类专门负责将 PHP 文档块中的注解转换为 PHP 8.0 引入的属性语法。这种转换不仅使代码更加简洁，还能获得更好的IDE支持和类型检查。

自定义注解转换配置

默认情况下，RectorPHP 只包含一些常见框架(如Symfony、Doctrine)的注解转换规则。对于自定义注解，如示例中的 @Inject，需要手动配置转换规则。

use Rector\Config\RectorConfig;
use Rector\Php80\Rector\Class_\AnnotationToAttributeRector;
use Rector\Php80\ValueObject\AnnotationToAttribute;

return static function (RectorConfig $rectorConfig): void {
    $rectorConfig
        ->ruleWithConfiguration(AnnotationToAttributeRector::class, [
            new AnnotationToAttribute('Inject', 'Inject'),
        ]);
};

处理命名空间导入

转换后的属性可能会带有不必要的反斜杠(如 #[\Inject])，这是因为没有正确导入命名空间。RectorPHP 提供了自动导入命名空间的功能：

$rectorConfig->importNames();

启用此配置后，Rector 会自动为转换后的属性添加正确的 use 语句，使属性保持简洁形式 #[Inject]。

实际应用场景

这种转换特别适用于：

1. 依赖注入框架中的注入点标记
2. 自定义的路由注解
3. 权限控制注解
4. 数据验证注解
5. 缓存相关注解

最佳实践建议

1. 在转换前确保项目已升级到 PHP 8.0 或更高版本
2. 先进行 --dry-run 测试查看转换效果
3. 为团队自定义的注解建立统一的转换规则
4. 转换后运行测试确保功能不受影响
5. 考虑将常用注解的转换规则封装为可复用的配置

通过合理配置 RectorPHP，开发者可以轻松地将遗留的注解系统迁移到现代的属性系统，提升代码质量和开发体验。