如何更改公共方法签名以及有哪些风险？

Question

我有一个很少被第三方客户使用的旧方法，我想更改它的签名（主要是重命名）。

我该怎么做？有什么风险？有什么真正的优势吗？

一个简单的例子：

Class Program
{
    public void OldMethodName(var oldVarName)
    {
        //Do something
    }
}

改成

Class Program    
{
    public void NewMethodName(var newVarName)
    {
        //Do the same thing
    }
}

Answer 1

当您的 API 被公开使用时，您应该分两个阶段对其进行重构：

• 发布两个 API 都可用的版本 - 此版本的 API 应该提供新方法，并弃用旧方法。这将使您的客户有时间进行迁移。
• 等待一段时间后，发布一个删除了已弃用方法的版本 - 如果可能，请与您的客户协调此版本，以确保他们已迁移到使用新方法。

有关如何弃用方法的信息，请参阅 this Q&A。

除了修复当前或潜在的命名冲突之外，更改公共方法的签名没有任何好处。