refactoring - 重构具有太多(6 个以上)参数的方法的最佳方法是什么？

Question

有时我会遇到参数数量过多的方法。通常，他们似乎是 build 者。似乎应该有更好的方法，但我不明白它是什么。

return new Shniz(foo, bar, baz, quux, fred, wilma, barney, dino, donkey)

我曾想过使用结构体来表示参数列表，但这似乎只是将问题从一个地方转移到另一个地方，并在此过程中创建另一种类型。

ShnizArgs args = new ShnizArgs(foo, bar, baz, quux, fred, wilma, barney, dino, donkey)
return new Shniz(args);

所以这看起来并不是一个进步。那么最好的方法是什么？

Answer 1

我假设您指的是C#。其中一些内容也适用于其他语言。

您有多种选择:

从构造函数切换到属性 setter 。这可以使代码更具可读性，因为对于读者来说哪个值对应于哪个参数是显而易见的。对象初始值设定项语法使这看起来很不错。它的实现也很简单，因为您只需使用自动生成的属性并跳过编写构造函数。

class C
{
    public string S { get; set; }
    public int I { get; set; }
}

new C { S = "hi", I = 3 };

但是，您会失去不变性，并且无法确保在编译时使用对象之前设置所需的值。

构建器模式。

想想string之间的关系和StringBuilder 。您可以为自己的类(class)获取此内容。我喜欢将其实现为嵌套类，因此 class C有相关类C.Builder 。我也喜欢构建器上流畅的界面。如果做得好，您可以得到如下语法:

C c = new C.Builder()
    .SetX(4)    // SetX is the fluent equivalent to a property setter
    .SetY("hello")
    .ToC();     // ToC is the builder pattern analog to ToString()

// Modify without breaking immutability
c = c.ToBuilder().SetX(2).ToC();

// Still useful to have a traditional ctor:
c = new C(1, "...");

// And object initializer syntax is still available:
c = new C.Builder { X = 4, Y = "boing" }.ToC();

我有一个 PowerShell 脚本，可让我生成构建器代码来完成所有这些操作，其中输入如下所示:

class C {
    field I X
    field string Y
}

这样我就可以在编译时生成。 partial类让我可以扩展主类和构建器，而无需修改生成的代码。

“引入参数对象”重构。请参阅Refactoring Catalog 。这个想法是，您将传递的一些参数放入新类型中，然后传递该类型的实例。如果你不假思索地这样做，你最终会回到起点:

new C(a, b, c, d);

变成了

new C(new D(a, b, c, d));

但是，这种方法最有可能对您的代码产生积极影响。因此，请继续执行以下步骤:

1. 寻找一起有意义的参数子集。只是漫不经心地将函数的所有参数组合在一起并没有多大帮助；目标是建立有意义的分组。 当新类型的名称显而易见时，您就会知道您做对了。

2. 寻找一起使用这些值的其他地方，并在那里也使用新类型。很有可能，当您为已经在各处使用的一组值找到一个好的新类型时，该新类型在所有这些地方也都有意义。

3. 查找现有代码中但属于新类型的功能。

例如，您可能会看到一些如下所示的代码:

bool SpeedIsAcceptable(int minSpeed, int maxSpeed, int currentSpeed)
{
    return currentSpeed >= minSpeed & currentSpeed < maxSpeed;
}

您可以选择minSpeed和maxSpeed参数并将它们放入新类型中:

class SpeedRange
{
   public int Min;
   public int Max;
}

bool SpeedIsAcceptable(SpeedRange sr, int currentSpeed)
{
    return currentSpeed >= sr.Min & currentSpeed < sr.Max;
}

这更好，但要真正利用新类型，请将比较移到新类型中:

class SpeedRange
{
   public int Min;
   public int Max;

   bool Contains(int speed)
   {
       return speed >= min & speed < Max;
   }
}

bool SpeedIsAcceptable(SpeedRange sr, int currentSpeed)
{
    return sr.Contains(currentSpeed);
}

现在我们已经取得进展: SpeedIsAcceptable() 的实现现在你就明白了你的意思，你就有了一个有用的、可重用的类。 (下一个明显的步骤是将 SpeedRange 变为 Range<Speed> 。)

正如您所看到的，引入参数对象是一个好的开始，但它的真正值(value)在于它帮助我们发现了模型中缺少的有用类型。