在 .NET Core 中解析和修改查询字符串

Question

我得到了一个包含查询字符串的绝对 URI。我希望安全地将值附加到查询字符串，并更改现有参数。

我宁愿不使用 &foo=bar，也不要使用正则表达式，URI 转义很棘手。相反，我想使用一种我知道可以正确执行此操作并处理转义的内置机制。

我有 found a ton 个答案都使用了 HttpUtility。然而，这是 ASP.NET 核心，不再有 System.Web 程序集，因此不再有 HttpUtility.

在 ASP.NET Core 中以核心运行时为目标时，以何种适当方式执行此操作？

Answer 1

如果您正在使用 ASP.NET Core 1 或 2，您可以使用 Microsoft.AspNetCore.WebUtilities 包中的 Microsoft.AspNetCore.WebUtilities.QueryHelpers 来实现。

如果您使用 ASP.NET Core 3.0 或更高版本，WebUtilities 现在是 ASP.NET SDK 的一部分，不需要单独的 nuget 包参考。

解析成字典：

var uri = new Uri(context.RedirectUri);
var queryDictionary = Microsoft.AspNetCore.WebUtilities.QueryHelpers.ParseQuery(uri.Query);

请注意，与 System.Web 中的 ParseQueryString 不同，此 returns 是 ASP.NET Core 1.x 中类型 IDictionary<string, string[]> 的字典，或 IDictionary<string, StringValues> 在 ASP.NET Core 2.x 或更高版本中，因此该值是一个字符串集合。这就是字典如何处理具有相同名称的多个查询字符串参数。

如果要在查询字符串上添加参数，可以使用另一种方法 QueryHelpers:

var parametersToAdd = new System.Collections.Generic.Dictionary<string, string> { { "resource", "foo" } };
var someUrl = "http://www.google.com";
var newUri = Microsoft.AspNetCore.WebUtilities.QueryHelpers.AddQueryString(someUrl, parametersToAdd);

使用 .net core 2.2，您可以使用

获取查询字符串

var request = HttpContext.Request;
var query = request.Query;
foreach (var item in query){
   Debug.WriteLine(item) 
}

您将获得 key:value 对的集合 - 像这样

[0] {[companyName, ]}
[1] {[shop, ]}
[2] {[breath, ]}
[3] {[hand, ]}
[4] {[eye, ]}
[5] {[firstAid, ]}
[6] {[eyeCleaner, ]}

Answer 2

HttpRequest has a Query property which exposes the parsed query string via the IReadableStringCollection接口：

/// <summary>
/// Gets the query value collection parsed from owin.RequestQueryString.
/// </summary>
/// <returns>The query value collection parsed from owin.RequestQueryString.</returns>
public abstract IReadableStringCollection Query { get; }

This discussion GitHub 也指向它。

Answer 3

获取绝对 URI 并仅使用 ASP.NET 核心包来操作其查询字符串的最简单、最直观的方法，只需几个简单的步骤即可完成：

安装包

PM> Install-Package Microsoft.AspNetCore.WebUtilities
PM> Install-Package Microsoft.AspNetCore.Http.Extensions

重要类

只是指出它们，以下是我们将使用的两个重要类：QueryHelpers, StringValues, QueryBuilder.

代码

// Raw URI including query string with multiple parameters
var rawurl = "https://bencull.com/some/path?key1=val1&key2=val2&key2=valdouble&key3=";

// Parse URI, and grab everything except the query string.
var uri = new Uri(rawurl);
var baseUri = uri.GetComponents(UriComponents.Scheme | UriComponents.Host | UriComponents.Port | UriComponents.Path, UriFormat.UriEscaped);

// Grab just the query string part
var query = QueryHelpers.ParseQuery(uri.Query);

// Convert the StringValues into a list of KeyValue Pairs to make it easier to manipulate
var items = query.SelectMany(x => x.Value, (col, value) => new KeyValuePair<string, string>(col.Key, value)).ToList();

// At this point you can remove items if you want
items.RemoveAll(x => x.Key == "key3"); // Remove all values for key
items.RemoveAll(x => x.Key == "key2" && x.Value == "val2"); // Remove specific value for key

// Use the QueryBuilder to add in new items in a safe way (handles multiples and empty values)
var qb = new QueryBuilder(items);
qb.Add("nonce", "testingnonce");
qb.Add("payerId", "pyr_");

// Reconstruct the original URL with new query string
var fullUri = baseUri + qb.ToQueryString();

要及时了解任何更改，您可以在此处查看我的博客 post：http://benjii.me/2017/04/parse-modify-query-strings-asp-net-core/

Answer 4

重要的是要注意，自从顶部答案被标记为正确以来，Microsoft.AspNetCore.WebUtilities 进行了主要版本更新（从 1.x.x 到 2.x.x）。

也就是说，如果您针对 netcoreapp1.1 进行构建，则需要运行以下内容，它会安装最新支持的版本 1.1.2:

Install-Package Microsoft.AspNetCore.WebUtilities -Version 1.1.2

Answer 5

此函数return Dictionary<string, string> 不使用 Microsoft.xxx 兼容性

接受双方参数编码

接受重复键（return 最后一个值）

var rawurl = "https://emp.com/some/path?key1.name=a%20line%20with%3D&key2=val2&key2=valdouble&key3=&key%204=44#book1";
var uri = new Uri(rawurl);
Dictionary<string, string> queryString = ParseQueryString(uri.Query);

// queryString return:
// key1.name, a line with=
// key2, valdouble
// key3, 
// key 4, 44

public Dictionary<string, string> ParseQueryString(string requestQueryString)
{
    Dictionary<string, string> rc = new Dictionary<string, string>();
    string[] ar1 = requestQueryString.Split(new char[] { '&', '?' });
    foreach (string row in ar1)
    {
        if (string.IsNullOrEmpty(row)) continue;
        int index = row.IndexOf('=');
        if (index < 0) continue;
        rc[Uri.UnescapeDataString(row.Substring(0, index))] = Uri.UnescapeDataString(row.Substring(index + 1)); // use Unescape only parts          
     }
     return rc;
}

Answer 6

我将其用作扩展方法，适用于任意数量的参数：

public static string AddOrReplaceQueryParameter(this HttpContext c, params string[] nameValues)
    {
        if (nameValues.Length%2!=0)
        {
            throw new Exception("nameValues: has more parameters then values or more values then parameters");
        }
        var qps = new Dictionary<string, StringValues>();
        for (int i = 0; i < nameValues.Length; i+=2)
        {
            qps.Add(nameValues[i], nameValues[i + 1]);
        }
        return c.AddOrReplaceQueryParameters(qps);
    }

public static string AddOrReplaceQueryParameters(this HttpContext c, Dictionary<string,StringValues> pvs)
    {
        var request = c.Request;
        UriBuilder uriBuilder = new UriBuilder
        {
            Scheme = request.Scheme,
            Host = request.Host.Host,
            Port = request.Host.Port ?? 0,
            Path = request.Path.ToString(),
            Query = request.QueryString.ToString()
        };

        var queryParams = QueryHelpers.ParseQuery(uriBuilder.Query);

        foreach (var (p,v) in pvs)
        {
            queryParams.Remove(p);
            queryParams.Add(p, v);
        }

        uriBuilder.Query = "";
        var allQPs = queryParams.ToDictionary(k => k.Key, k => k.Value.ToString());
        var url = QueryHelpers.AddQueryString(uriBuilder.ToString(),allQPs);

        return url;
    }

例如视图中的下一个和上一个链接：

var next = Context.Request.HttpContext.AddOrReplaceQueryParameter("page",Model.PageIndex+1+"");

var prev = Context.Request.HttpContext.AddOrReplaceQueryParameter("page",Model.PageIndex-1+"");

在 .NET Core 中解析和修改查询字符串

Parse and modify a query string in .NET Core

c#

asp.net

asp.net-core

安装包

重要类

代码