为什么 StringValues 用于 Request.Query 值？

Question

假设我有一些如下所示的网址：www.myhost.com/mypage?color=blue

在 Asp.Net Core 中，我希望通过执行以下操作来获取颜色查询参数值：

string color = Request.Query["color"];

但事实证明Request.Query["color"] 返回的值类型为StringValues 而不是string。这是为什么呢？

显然StringValues 类型可以保存一个字符串数组，并且支持隐式转换为string[]，这很酷，但是为什么查询参数值需要它呢？

必须得到这样的值似乎很奇怪：

string color = Request.Query["color"].ToString();

更糟糕的是，无法再像这样检查一个值以查看是否指定了查询参数

  if(Request.Query["color"] == null) { 
      //param was not specified
  }

但必须像这样检查

 if(Request.Query["color"].Count == 0) { 
      //param was not specified
 }

既然单个查询参数不能有多个值（据我所知），为什么Request.Query["color"] 返回一个StringValues 对象而不是一个字符串？

Answer 1

Request.Query["color"] 返回StringValues，因为可以传递string 值的集合。所以，我建议你把它当作动作参数，模型绑定来处理。

public ActionResult SaveColor([FromUri] string[] color);

Answer 2

只是为好奇的灵魂发帖，可能与问题无关。只是警告。

我发现自己遇到了类似的问题。这种类型还有其他几个问题。

1. 如果您有没有值的查询参数。例如：/products?pageNo=1&pageSize=

   您会发现自己在pageSize 参数中抛出异常Count StringValues 上的属性将为您提供值 1，但基础 _value 是 ""（空 字符串）和_values 是null。注意 - 您尝试转换时发生异常或 从 IQueryCollection 访问值）

2. 使用TryGetValue 将使您安全地摆脱StringValues 的价值，但如果它为空 （就像上面的pageSize 参数一样），您将很难弄清楚原因 你不能将StringValues 转换为简单的String 或者为什么不能与null 比较 对其进行进一步的操作，例如验证等。

3. 要对StringValues 类型进行任何检查，请使用该类型提供的方法。

检查 null 或空使用 - StringValues.IsNullOrEmpty(StringValues value)

Answer 3

正如其他人已经提到的，类型是StringValues 对象，因为从技术上讲，允许多个值。虽然通常的做法是只设置一个值，但 URI 规范不允许多次设置值。由应用程序决定如何处理。

话虽如此，StringValues 隐式转换为string，因此您实际上不需要在其上调用ToString()，您可以像使用字符串一样使用它。所以像Request.Query["color"] == "red" 这样的操作，或者将它传递给一个需要字符串的方法就可以了。

更糟糕的是，不能再像 Request.Query["color"] == null 那样检查值以查看是否指定了查询参数，而是必须像 Request.Query["color"].Count == 0 那样检查

这只是对了一半。是的，为了检查StringValues 对象是否为空，您可以检查其Count 属性。你也可以对照StringValues.Empty：

Request.Query["color"] == StringValues.Empty

然而，最初的“问题”是Request.Query[x] 将总是返回一个非空的StringValues 对象（因此检查任何值都是安全的）。如果要检查查询参数中是否存在键，则应使用ContainsKey：

if (Request.Query.ContainsKey("color"))
{
    // only now actually retrieve the value
    string colorValue = Request.Query["color"];
}

或者，使用TryGetValue:

if (Request.Query.TryGetValue("color", out var colorValue))
{
    DoSomething(colorValue);
}

---

话虽如此，大多数时候访问Request.Query 并不是必需的。您应该只使用 model binding 来代替，它会自动为您提供所需的查询参数，只需将它们放在操作的签名中即可：

public ActionResult MyAction(string color)
{
    DoSomething(color);
}

Answer 4

因为您的查询可能如下所示：

www.myhost.com/mypage?color=blue&color=red&color=yellow

然后您从一个 Request.Query["color"] 参数中获得所有这些 color 值