RectorPHP 中如何配置规则忽略与类型声明

规则忽略的配置方法

在 RectorPHP 项目中，随着版本迭代，配置方式有所变化。最新版本(1.2.1及以上)推荐使用构建器模式进行配置。要忽略特定规则，可以使用withSkip()方法：

use Rector\Config\RectorConfig;
use Rector\CodeQuality\Rector\If_\SimplifyIfReturnBoolRector;

return RectorConfig::configure()
    ->withSkip([
        SimplifyIfReturnBoolRector::class,
    ]);

这种配置方式更加简洁直观，符合现代PHP开发实践。如果需要忽略多个规则，只需在数组中添加更多规则类名即可。

类型声明规则的配置

RectorPHP 提供了强大的类型声明功能，特别是AddReturnTypeDeclarationRector规则，可以自动为类方法添加返回类型声明。配置示例如下：

use Rector\Config\RectorConfig;
use Rector\TypeDeclaration\Rector\ClassMethod\AddReturnTypeDeclarationRector;
use Rector\TypeDeclaration\ValueObject\AddReturnTypeDeclaration;
use PHPStan\Type\ArrayType;
use PHPStan\Type\MixedType;

$arrayType = new ArrayType(new MixedType(), new MixedType());

return RectorConfig::configure()
    ->withConfiguredRule(AddReturnTypeDeclarationRector::class, [
        new AddReturnTypeDeclaration('SomeClass', 'getData', $arrayType),
    ]);

在这个例子中，我们为SomeClass类的getData方法配置了数组类型的返回声明。PHPStan的类型系统提供了丰富的类型定义能力，包括：

• 基本类型：int, string, bool等
• 复合类型：array, iterable等
• 对象类型：特定类的实例
• 特殊类型：mixed, void等

最佳实践建议

1. 版本兼容性：确保使用最新版本的RectorPHP以获得最佳功能和性能

2. 渐进式迁移：对于大型项目，建议逐步添加规则，而不是一次性应用所有规则

3. 类型安全：优先添加返回类型声明，这可以显著提高代码的可靠性和可维护性

4. 测试验证：在应用重大重构前，确保有充分的测试覆盖

5. 团队协作：将Rector配置纳入版本控制，确保团队成员使用相同的重构规则

通过合理配置RectorPHP，开发者可以自动化许多繁琐的代码重构任务，专注于业务逻辑的实现，同时保持代码库的高质量和一致性。