RectorPHP 中如何为属性添加类型声明

在 PHP 项目中，为类属性添加类型声明是一个重要的代码质量改进措施。RectorPHP 提供了多种规则来自动化这一过程，本文将详细介绍这些规则的使用场景和注意事项。

从构造函数参数推断属性类型

对于通过构造函数参数初始化的属性，RectorPHP 提供了 TypedPropertyFromStrictConstructorRector 规则。这个规则能够分析构造函数参数的类型，并自动为对应的属性添加类型声明。

// 转换前
class SomeObject {
    private $name;
    
    public function __construct(string $name) {
        $this->name = $name;
    }
}

// 转换后
class SomeObject {
    private string $name;
    
    public function __construct(string $name) {
        $this->name = $name;
    }
}

从初始赋值推断属性类型

对于在类中直接赋值的属性，可以使用 TypedPropertyFromAssignsRector 规则。这个规则能够分析属性的初始值或构造函数中的赋值操作，自动推断并添加类型声明。

// 转换前
class SomeObject {
    private $name = 'default';
}

// 转换后
class SomeObject {
    private string $name = 'default';
}

处理 Doctrine 实体属性

对于 Doctrine 实体类，RectorPHP 提供了专门的 TypedPropertyFromColumnTypeRector 规则。这个规则会根据 @ORM\Column 注解或属性的类型信息来推断属性类型。

// 转换前
/**
 * @ORM\Entity
 */
class User {
    /**
     * @var string
     * @ORM\Column(type="string", nullable=false)
     */
    private $username;
}

// 转换后
/**
 * @ORM\Entity
 */
class User {
    /**
     * @ORM\Column(type="string", nullable=false)
     */
    private string $username;
}

注意事项

1. Doctrine 属性的特殊性：由于 Doctrine 属性可能通过反射或魔术方法访问，RectorPHP 默认会谨慎处理这些属性，通常会保持它们为可空类型。

2. nullable 配置的重要性：在 Doctrine 中，必须显式设置 nullable=false 才能确保属性被推断为非空类型。

3. 数组类型的处理：当前对于 @ORM\Column(type="json") 的数组类型属性，可能需要手动添加类型声明。

4. 魔术方法的影响：包含 __get() 或 __call() 魔术方法的类，其属性类型推断会被跳过，以避免潜在问题。

最佳实践

1. 使用完整的类型声明预设：

   return RectorConfig::configure()
       ->withPreparedSets(typeDeclarations: true);
   

2. 对于 Doctrine 项目，建议结合使用 TypedPropertyFromColumnTypeRector 规则。

3. 在重要属性上添加明确的 PHPDoc 类型注释，以帮助 Rector 更准确地推断类型。

通过合理配置这些规则，开发者可以显著提高代码的类型安全性，同时保持自动化的代码改进流程。