在不破坏向后兼容性的情况下更改参数名称

Question

我正在开发一个 c# 库，所以我们担心破坏向后兼容性，但我想知道是否可以只更改参数的名称并保持向后兼容性，因为能够使用命名参数？下面是我正在尝试做的一个例子

[Obsolete("use ChangeSpecificFoo(SpecificFoo specificFoo)")]
public void ChangeSpecificFoo(SpecificFoo foo)
{
    _specificFoo = foo;
}

//Compile error ... already defines a member called 'ChangeSpecificFoo' with the same parameter types
public void ChangeSpecificFoo(SpecificFoo specificFoo)
{
    _specificFoo = specificFoo;
}

仅更改参数名称存在破坏向后兼容性的潜在风险，因为有人可能会使用 ChangeSpecificFoo(foo: someSpecificFoo) 等命名参数调用该方法，但我们不能通过添加新方法来弃用该方法正确的参数名称，因为参数名称未包含在方法签名中，因此编译器将其视为重复项。

有什么办法解决这个问题吗？我看到的唯一替代方法是更改方法名称，使其不重复，然后弃用旧方法，或者等到我们从参数列表中添加或删除参数，然后更改参数名称（这可能永远不会发生，因为该方法是非常稳定），或者只是进行更改并修复我们发现的使用此库的代码可能遇到的任何中断。

Answer 1

我的第一个倾向很简单：不要。您的参数名称在方法主体之外无关紧要。您认为人们会直呼其名，因此可能会破坏它，这是对的。然而，仅仅改变参数的名称并没有真正的好处。

更改名称的唯一可能原因是重新定义方法的作用，因为旧名称会导致混淆。在那种情况下，方法的名称也应该更改，以免引入另一种形式的混淆。（方法签名相同的事实是不更改参数名称的第一个也是更重要的原因。但是，这可能会解释 为什么 您可能想要这样做。）

但是，如果您仍然坚持保留相同的方法签名，但更改名称，则可以这样做。（再次，我强烈建议您要么根本不更改它，要么重命名该方法以继续消除混淆。）

解决此问题的一种方法是使该方法具有两个参数，但使第二个参数可选。让最后一个参数使用旧名称，然后在方法中分配给它。

我也高度建议记录命名参数的任何使用，以查看您对人们将其称为命名参数的担忧是否有效。

public void ChangeSpecificFoo(SpecificFoo specificFoo = null, SpecificFoo foo = null)
{
    if (foo != null && specificFoo == null)
    {
        // Add any other details you can, especially 
        // to figure out who is calling this.
        Log("Someone used a name parameter!!");
    }
    _specificFoo = specificFoo ?? foo;
}

正如 Dmitry Bychenko 在评论中指出的那样，这不会阻止任何人像这样调用此方法：ChangeSpecificFoo(null, new SpecificFoo())，这将触发日志记录。

他的观察介绍了为什么这是一个坏主意的另一个原因：您现在正在引入另一种方式让人们 "incorrectly" 调用您的方法。因此，我将从我的答案顶部重复我的建议：不要这样做，除非你真的真的真的需要改变它参数名称.

在不破坏向后兼容性的情况下更改参数名称

Change parameter name without breaking backwards compatibility

c#

backwards-compatibility

named-parameters