在“params object[]”参数之后添加可选参数以函数

Question

我在一个 API 中有一个函数，许多其他库都在使用它，但我想将它调整为一个新特性，以采用一个添加的可选参数。方法签名是：

protected Task EnvGetJsonAsync<TReceive>(string endpointName, params object[] pathArgs)

并且我想在 pathArgs 之后添加“string key = null”，因为我有 37 个对用于此格式的函数的引用。这样我就不必更改所有 37 个引用（而且大多数引用不需要可选参数），我只想在最后添加一个可选参数。

我尝试将“params object[]”更改为“object[]”，但它导致所有引用出错。所以它看起来像这样

protected Task EnvGetJsonAsync<TReceive>(string endpointName, params object[] pathArgs, string id = null)

然后是这个

protected Task EnvGetJsonAsync<TReceive>(string endpointName, object[] pathArgs, string id = null)

但两者都引起了问题。我想要一种方法来允许函数采用可选参数而不破坏其他 37 个引用。谢谢！

Answer 1

您可以将可选参数移到param 之前。根据MSDN

a 中的 params 关键字后面不允许有其他参数 方法声明，并且只允许一个 params 关键字在 方法声明。

最好为新输入创建新方法，并根据输入从那里调用现有方法。

重载不适用于param。您不会收到任何编译时错误。它将在运行时调用最后一个方法。您可以查看此fiddler 了解更多信息。

Answer 2

只需创建一个新方法，将实现移到那里并使用旧方法调用新方法。这样一来，您的 37 个调用者将永远不会注意到变化：

protected Task EnvGetJsonAsync<TReceive>(string endpointName, params object[] pathArgs)
{
  // this is the original method. Here we just call the new one
  return EnvGetJsonoAsync<TReceive>(endpointName, null, pathArgs);
}

protected Task EnvGetJsonAsync<TReceive>(string endpointName, string id, params object[] pathArgs) 
{
  .. the code implementation
}

Answer 3

根据文档，params 之后不能有可选参数：

方法声明中params关键字后面不允许有附加参数，方法声明中只允许一个params关键字。

https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/params

您可以在params 之前放置可选参数，但是因为您的params 数组类型是object，如果您第一次选择错误的方法，您可能会遇到运行时错误pathArgs 类型是 string。

最好的方法是使用您的可选参数添加一个新方法，使用稍微不同的名称。然后，您的参考方法可以使用适当的方法，无论它们是否具有密钥。然后，您可以使用 null 或 key 的默认值从旧方法调用新方法：

protected Task EnvGetJsonAsync<TReceive>(string endpointName, params object[] pathArgs)
{
    return EnvGetJsonWithKeyAsync<TReceive>(endpointName, null, pathArgs);
}

protected Task EnvGetJsonWithKeyAsync<TReceive>(string endpointName, string key, params object[] pathArgs)
{
    // your method here
}