深入理解Rector项目中--only参数的正确使用方式

Rector作为一款强大的PHP代码重构工具，提供了丰富的功能来帮助开发者自动化代码升级和重构。其中--only参数是一个非常有用的功能，但很多开发者对其使用方式存在误解。本文将详细介绍这个参数的正确用法和实际应用场景。

--only参数的本质

--only参数并非用于临时加载规则，而是用于从已配置的规则集中筛选执行特定规则。这意味着：

1. 目标规则必须已经在rector.php配置文件中声明
2. 参数值需要提供规则的完整类名
3. 它主要用于在已配置的多条规则中筛选执行特定规则

常见误解解析

很多开发者（包括本文作者最初）误以为--only可以：

• 绕过配置文件直接加载规则
• 临时测试某个规则的效果
• 不需要预先配置就能运行特定规则

实际上，这些理解都是不正确的。--only只是一个过滤器，而非规则加载器。

正确使用方式

要使用--only参数，必须首先在rector.php中配置相应规则：

use Rector\Config\RectorConfig;
use Rector\Php70\Rector\ClassMethod\Php4ConstructorRector;

return RectorConfig::configure()
    ->withRules([
        Php4ConstructorRector::class,
        // 其他规则...
    ]);

然后才能使用完整类名来指定规则：

vendor/bin/rector process --only="Rector\Php70\Rector\ClassMethod\Php4ConstructorRector"

实际应用价值

虽然不能绕过配置直接使用规则，但--only在实际工作中仍然非常有用：

1. 渐进式重构：当配置了多个规则但想逐步应用时，可以逐个规则执行
2. 问题排查：当重构结果不符合预期时，可以单独运行某个规则进行测试
3. 风险控制：对高风险规则可以先单独运行，确认无误后再批量执行

例如，当Rector报告要修改327个文件时，开发者可以：

# 先只运行构造函数属性提升规则
vendor/bin/rector process --only ClassPropertyAssignToConstructorPromotionRector

# 确认无误后，再运行其他规则...

最佳实践建议

1. 始终在配置文件中声明要使用的规则
2. 使用--dry-run参数先预览修改效果
3. 结合版本控制系统，便于回退修改
4. 复杂的重构任务可以分解为多个小步骤，使用--only逐个执行

通过正确理解和使用--only参数，开发者可以更安全、更高效地利用Rector进行代码重构工作。