web-dev-qa-db-ja.com

.NET Coreでクエリ文字列を解析および変更する

クエリ文字列を含む絶対URIが与えられます。クエリ文字列に値を安全に追加し、既存のパラメーターを変更したいと考えています。

URIエスケープは難しいので、&foo=barを追加したり、正規表現を使用したりするのは好ましくありません。むしろ、これを正しく行い、エスケープを処理することがわかっている組み込みのメカニズムを使用します。

私は foundaton すべての回答がHttpUtilityを使用しています。ただし、これはASP.NET Coreであるため、System.Webアセンブリはもうないため、HttpUtilityはありません。

コアランタイムをターゲットにしながらASP.NET Coreでこれを行う適切な方法は何ですか？

c#asp.netasp.net-core
92
vcsjones

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とは異なり、ASP.NET Core 1.xではIDictionary<string, string[]>、ASP.NET Core 2.x以降ではIDictionary<string, StringValues>型の辞書を返します。そのため、値は文字列のコレクションです。これは、辞書が同じ名前の複数のクエリ文字列パラメーターを処理する方法です。

クエリ文字列にパラメーターを追加する場合は、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) 
}

キーと値のペアのコレクションを取得します-このように

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

ASP.NET Coreパッケージのみを使用して絶対URIを取得し、クエリ文字列を操作する最も簡単で最も直感的な方法は、いくつかの簡単な手順で実行できます。

パッケージをインストールする

PM>インストールパッケージMicrosoft.AspNetCore.WebUtilities
PM> Install-Package Microsoft.AspNetCore.Http.Extensions

重要なクラス

それらを指摘するために、使用する2つの重要なクラスを以下に示します。 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();

変更を最新の状態に保つために、次のブログ投稿をチェックしてください： http://benjii.me/2017/04/parse-modify-query-strings-asp-net-core/

26
Ben Cull

HttpRequest には、 Query インターフェイスを介して解析されたクエリ文字列を公開する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; }

この議論 GitHubでも同様です。

17
Yuval Itzchakov

この関数はDictionary<string, string>を返し、互換性のためにMicrosoft.xxxを使用しません

両側でパラメーターのエンコードを受け入れます

重複キーを受け入れます（最後の値を返します）

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;
}
9
Wagner Pereira

重要なのは、一番上の回答が正しいとフラグ付けされてから、Microsoft.AspNetCore.WebUtilitiesがメジャーバージョンアップデート（1.x.xから2.x.xへ）されたことに注意することです。

ただし、netcoreapp1.1に対してビルドする場合は、次を実行する必要があります。これにより、サポートされている最新バージョン1.1.2がインストールされます。

Install-Package Microsoft.AspNetCore.WebUtilities -Version 1.1.2

1
pim

私はこれを拡張メソッドとして使用し、任意の数のパラメーターで動作します：

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+"");
1
Gabriel Luca