在代码中从网络资源获取数据时，常见的任务是构建查询字符串以包含所有必要的参数。虽然这并不是什么高深技术，但您需要注意一些巧妙的细节，例如：如果不是第一个参数，则附加&，对参数进行编码等。
执行此操作的代码非常简单，但有点繁琐：
StringBuilder SB = new StringBuilder();
if (NeedsToAddParameter A)
{
SB.Append("A="); SB.Append(HttpUtility.UrlEncode("TheValueOfA"));
}
if (NeedsToAddParameter B)
{
if (SB.Length>0) SB.Append("&");
SB.Append("B="); SB.Append(HttpUtility.UrlEncode("TheValueOfB")); }
}
这是一个非常普遍的任务，人们期望存在一个实用程序类使其更加优雅和易读。浏览 MSDN，我未能找到一个—这就引出了以下问题：
你知道最优雅且清晰的方法是什么吗？
您可以通过调用System.Web.HttpUtility.ParseQueryString(string.Empty)来创建一个新的可写的HttpValueCollection实例，然后将其用作任何NameValueCollection。一旦您添加了所需的值，您可以调用集合上的ToString方法来获取查询字符串，如下所示：
NameValueCollection queryString = System.Web.HttpUtility.ParseQueryString(string.Empty);
queryString.Add("key1", "value1");
queryString.Add("key2", "value2");
return queryString.ToString(); // Returns "key1=value1&key2=value2", all URL-encoded
HttpValueCollection是内部类，因此您无法直接构造实例。不过，一旦获取到实例，您可以像任何其他NameValueCollection一样使用它。由于您要处理的实际对象是一个HttpValueCollection，因此调用ToString方法将调用HttpValueCollection上重写的方法，该方法将集合格式化为URL编码的查询字符串。Microsoft.AspNetCore.WebUtilities.QueryHelpers类，这将大大简化操作。
https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.webutilities.queryhelpers
示例代码：const string url = "https://customer-information.azure-api.net/customers/search/taxnbr";
var param = new Dictionary<string, string>() { { "CIKey", "123456789" } };
var newUrl = new Uri(QueryHelpers.AddQueryString(url, param));
public static string ToURLQueryString(this IDictionary dict) { ... }。 - Roy TinkerAdd方法可以将多个名称实例添加到查询字符串中。例如：queryString.Add("type", "1");
queryString.Add("type", "2");实际上，始终使用Add方法可能是更好的做法。 - jeremysawesome如果你深入了解QueryString属性，你会发现它是一个NameValueCollection。当我做类似的事情时，通常都对序列化和反序列化感兴趣，因此我的建议是构建一个NameValueCollection并将其传递给：
using System.Linq;
using System.Web;
using System.Collections.Specialized;
private string ToQueryString(NameValueCollection nvc)
{
var array = (
from key in nvc.AllKeys
from value in nvc.GetValues(key)
select string.Format(
"{0}={1}",
HttpUtility.UrlEncode(key),
HttpUtility.UrlEncode(value))
).ToArray();
return "?" + string.Join("&", array);
}
我想在 LINQ 中也有一种超级优雅的方法可以做到这一点...
在受到Roy Tinker评论的启发后，我最终使用Uri类的一个简单扩展方法来保持我的代码简洁和清晰：
using System.Web;
public static class HttpExtensions
{
public static Uri AddQuery(this Uri uri, string name, string value)
{
var httpValueCollection = HttpUtility.ParseQueryString(uri.Query);
httpValueCollection.Remove(name);
httpValueCollection.Add(name, value);
var ub = new UriBuilder(uri);
ub.Query = httpValueCollection.ToString();
return ub.Uri;
}
}
用法：
Uri url = new Uri("http://localhost/rest/something/browse").
AddQuery("page", "0").
AddQuery("pageSize", "200");
编辑 - 符合标准的变体
正如一些人指出的那样，httpValueCollection.ToString()以一种不符合标准 的方式对 Unicode 字符进行编码。这是同一扩展方法的另一种变体，它通过调用 HttpUtility.UrlEncode 方法而不是已弃用的 HttpUtility.UrlEncodeUnicode 方法来处理这些字符。
using System.Web;
public static Uri AddQuery(this Uri uri, string name, string value)
{
var httpValueCollection = HttpUtility.ParseQueryString(uri.Query);
httpValueCollection.Remove(name);
httpValueCollection.Add(name, value);
var ub = new UriBuilder(uri);
// this code block is taken from httpValueCollection.ToString() method
// and modified so it encodes strings with HttpUtility.UrlEncode
if (httpValueCollection.Count == 0)
ub.Query = String.Empty;
else
{
var sb = new StringBuilder();
for (int i = 0; i < httpValueCollection.Count; i++)
{
string text = httpValueCollection.GetKey(i);
{
text = HttpUtility.UrlEncode(text);
string val = (text != null) ? (text + "=") : string.Empty;
string[] vals = httpValueCollection.GetValues(i);
if (sb.Length > 0)
sb.Append('&');
if (vals == null || vals.Length == 0)
sb.Append(val);
else
{
if (vals.Length == 1)
{
sb.Append(val);
sb.Append(HttpUtility.UrlEncode(vals[0]));
}
else
{
for (int j = 0; j < vals.Length; j++)
{
if (j > 0)
sb.Append('&');
sb.Append(val);
sb.Append(HttpUtility.UrlEncode(vals[j]));
}
}
}
}
}
ub.Query = sb.ToString();
}
return ub.Uri;
}
奇怪的是没有人提到AspNet.Core中的QueryBuilder。
当您有一个带有重复键的查询时，例如?filter=a&filter=b，它非常有用。
var qb = new QueryBuilder();
qb.Add("filter", new string[] {"A", "B"});
然后你只需将qb添加到URI中，它会自动转换为字符串。
netstandard2.0，因此对我的类库没有用处。 - AuspexQueryString：https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.http.querystring.create?view=aspnetcore-6.0 - somedotnetguyFlurl 【披露：我是作者】支持使用匿名对象（以及其他方式）构建查询字符串：
var url = "http://www.some-api.com".SetQueryParams(new
{
api_key = ConfigurationManager.AppSettings["SomeApiKey"],
max_results = 20,
q = "Don't worry, I'll get encoded!"
});
可选的Flurl.Http伴侣库允许您直接从同一流畅调用链进行HTTP调用，将其扩展为全面的REST客户端：
T result = await "https://api.mysite.com"
.AppendPathSegment("person")
.SetQueryParams(new { ap_key = "my-key" })
.WithOAuthBearerToken("MyToken")
.PostJsonAsync(new { first_name = firstName, last_name = lastName })
.ReceiveJson<T>();
PM> Install-Package Flurl.Http
PM> Install-Package Flurl
HttpValueCollection，它实际上是ASP.NET的Request.QueryString属性，但不幸的是它在.NET框架中是内部的。您可以使用Reflector获取它（并将其放入您的Utils类中）。这样，您就可以像使用NameValueCollection一样操作查询字符串，但所有url编码/解码问题都已经为您处理了。
HttpValueCollection扩展了NameValueCollection，并具有一个构造函数，该函数接受一个编码的查询字符串（包括&和？），并覆盖了ToString()方法以稍后从底层集合重新构建查询字符串。 var coll = new HttpValueCollection();
coll["userId"] = "50";
coll["paramA"] = "A";
coll["paramB"] = "B";
string query = coll.ToString(true); // true means use urlencode
Console.WriteLine(query); // prints: userId=50¶mA=A¶mB=B
httpValueCollection.ToString() 实际上调用了 httpValueCollection.ToString(true)，因此不需要显式添加 true。 - dav_i以下是一种扩展方法的流畅/lambda式写法（结合了之前帖子中的概念），支持同一键的多个值。我个人倾向于使用扩展方法而非包装器，因为其他团队成员可以更容易地发现这样的东西。请注意，在编码方法方面存在争议，Stack Overflow上有很多帖子（其中一个）和MSDN博客（如此示例）。
public static string ToQueryString(this NameValueCollection source)
{
return String.Join("&", source.AllKeys
.SelectMany(key => source.GetValues(key)
.Select(value => String.Format("{0}={1}", HttpUtility.UrlEncode(key), HttpUtility.UrlEncode(value))))
.ToArray());
}
编辑: 支持空值，但您可能需要根据您的特定情况进行调整
public static string ToQueryString(this NameValueCollection source, bool removeEmptyEntries)
{
return source != null ? String.Join("&", source.AllKeys
.Where(key => !removeEmptyEntries || source.GetValues(key)
.Where(value => !String.IsNullOrEmpty(value))
.Any())
.SelectMany(key => source.GetValues(key)
.Where(value => !removeEmptyEntries || !String.IsNullOrEmpty(value))
.Select(value => String.Format("{0}={1}", HttpUtility.UrlEncode(key), value != null ? HttpUtility.UrlEncode(value) : string.Empty)))
.ToArray())
: string.Empty;
}
这是我提交的晚期作品。因为各种原因，我都不喜欢其他人写的代码，所以我自己写了一个。
这个版本特点如下:
仅使用StringBuilder。没有ToArray()调用或其他扩展方法。虽然它看起来不像其他响应那样美观，但我认为这是一项核心功能，因此效率比具有“流畅”、“单行”代码的隐藏inefficiencies更重要。
处理每个键的多个值。(我自己不需要，但只是为了让Mauricio安心 ;)
public string ToQueryString(NameValueCollection nvc)
{
StringBuilder sb = new StringBuilder("?");
bool first = true;
foreach (string key in nvc.AllKeys)
{
foreach (string value in nvc.GetValues(key))
{
if (!first)
{
sb.Append("&");
}
sb.AppendFormat("{0}={1}", Uri.EscapeDataString(key), Uri.EscapeDataString(value));
first = false;
}
}
return sb.ToString();
}
var queryParams = new NameValueCollection()
{
{ "x", "1" },
{ "y", "2" },
{ "foo", "bar" },
{ "foo", "baz" },
{ "special chars", "? = &" },
};
string url = "http://example.com/stuff" + ToQueryString(queryParams);
Console.WriteLine(url);
http://example.com/stuff?x=1&y=2&foo=bar&foo=baz&special%20chars=%3F%20%3D%20%26
我需要解决一个便携式类库（PCL）中的相同问题。 在这种情况下，我无法访问System.Web，因此无法使用ParseQueryString。
相反，我使用了System.Net.Http.FormUrlEncodedContent，如下所示：
var url = new UriBuilder("http://example.com");
url.Query = new FormUrlEncodedContent(new Dictionary<string,string>()
{
{"param1", "val1"},
{"param2", "val2"},
{"param3", "val3"},
}).ReadAsStringAsync().Result;
那么创建一些扩展方法如何？这些方法允许您以流畅的方式添加参数，就像这样：
string a = "http://www.somedomain.com/somepage.html"
.AddQueryParam("A", "TheValueOfA")
.AddQueryParam("B", "TheValueOfB")
.AddQueryParam("Z", "TheValueOfZ");
string b = new StringBuilder("http://www.somedomain.com/anotherpage.html")
.AddQueryParam("A", "TheValueOfA")
.AddQueryParam("B", "TheValueOfB")
.AddQueryParam("Z", "TheValueOfZ")
.ToString();
以下是使用string重载的函数：
public static string AddQueryParam(
this string source, string key, string value)
{
string delim;
if ((source == null) || !source.Contains("?"))
{
delim = "?";
}
else if (source.EndsWith("?") || source.EndsWith("&"))
{
delim = string.Empty;
}
else
{
delim = "&";
}
return source + delim + HttpUtility.UrlEncode(key)
+ "=" + HttpUtility.UrlEncode(value);
}
这里是使用StringBuilder的重载方法：
public static StringBuilder AddQueryParam(
this StringBuilder source, string key, string value)
{
bool hasQuery = false;
for (int i = 0; i < source.Length; i++)
{
if (source[i] == '?')
{
hasQuery = true;
break;
}
}
string delim;
if (!hasQuery)
{
delim = "?";
}
else if ((source[source.Length - 1] == '?')
|| (source[source.Length - 1] == '&'))
{
delim = string.Empty;
}
else
{
delim = "&";
}
return source.Append(delim).Append(HttpUtility.UrlEncode(key))
.Append("=").Append(HttpUtility.UrlEncode(value));
}
NameValueCollection、HttpValueCollection或Uri。谢谢！ - Stanley G.