Wie man eine Abfragezeichenfolge für eine URL in C# erstellen?

Question

Eine häufige Aufgabe beim Aufrufen von Webressourcen aus einem Code ist die Erstellung eines Abfrage-Strings, der alle erforderlichen Parameter enthält. Das ist zwar keine Raketenwissenschaft, aber es gibt ein paar raffinierte Details, um die man sich kümmern muss, wie zum Beispiel das Anhängen eines & wenn nicht der erste Parameter, Kodierung der Parameter usw.

Der Code dafür ist sehr einfach, aber ein bisschen mühsam:

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")); }
}

Dies ist eine so häufige Aufgabe, dass man erwarten würde, dass es eine Hilfsklasse gibt, die dies eleganter und lesbarer macht. Beim Durchsuchen von MSDN habe ich keine gefunden, was mich zu der folgenden Frage bringt:

Was ist die eleganteste und sauberste Methode, die Sie kennen, um dies zu tun?

Answer 1

Sie können eine neue beschreibbare Instanz von HttpValueCollection durch den Aufruf System.Web.HttpUtility.ParseQueryString(string.Empty) und verwenden Sie es dann wie jede NameValueCollection . Sobald Sie die gewünschten Werte hinzugefügt haben, können Sie die ToString auf die Sammlung, um eine Abfragezeichenfolge zu erhalten, wie folgt:

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

Le site HttpValueCollection ist intern und Sie können daher nicht direkt eine Instanz erstellen. Sobald Sie jedoch eine Instanz erhalten haben, können Sie sie wie jede andere NameValueCollection . Da das eigentliche Objekt, mit dem Sie arbeiten, ein HttpValueCollection Wenn Sie die Methode ToString aufrufen, wird die überschriebene Methode auf HttpValueCollection die die Sammlung als URL-kodierte Abfragezeichenfolge formatiert.

Nachdem ich SO und im Internet nach einer Antwort auf ein ähnliches Problem gesucht habe, ist dies die einfachste Lösung, die ich finden konnte.

.NET Core

Wenn Sie in .NET Core arbeiten, können Sie die Microsoft.AspNetCore.WebUtilities.QueryHelpers Klasse, die dies stark vereinfacht.

https://docs.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.webutilities.queryhelpers

Beispiel-Code:

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));

Answer 2

Wenn Sie unter die Haube schauen, ist die Eigenschaft QueryString eine NameValueCollection. Wenn ich ähnliche Dinge getan habe, war ich in der Regel daran interessiert, Serialisierung UND Deserialisierung, so dass mein Vorschlag ist, eine NameValueCollection zu bauen und dann zu übergeben:

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);
}

Ich stelle mir vor, dass es eine super elegante Möglichkeit gibt, dies auch in LINQ zu tun...

Answer 3

Inspiriert von Roy Tinkers Kommentar habe ich eine einfache Erweiterungsmethode für die Uri-Klasse verwendet, die meinen Code übersichtlich und sauber hält:

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;
    }
}

Verwendung:

Uri url = new Uri("http://localhost/rest/something/browse").
          AddQuery("page", "0").
          AddQuery("pageSize", "200");

---

Bearbeiten - Normenkonforme Variante

Wie mehrere Personen anmerkten, httpValueCollection.ToString() kodiert Unicode-Zeichen in einem nicht normenkonform Weise. Dies ist eine Variante der gleichen Erweiterungsmethode, die solche Zeichen durch den Aufruf von HttpUtility.UrlEncode Methode anstelle der veralteten HttpUtility.UrlEncodeUnicode Methode.

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;
}

Answer 4

Seltsam, dass niemand QueryBuilder von AspNet.Core erwähnt hat.

Es ist hilfreich, wenn Sie eine Abfrage mit doppeltem Schlüssel haben wie ?filter=a&filter=b

            var qb = new QueryBuilder();
            qb.Add("filter", new string[] {"A", "B"};

Dann fügen Sie einfach qb an den URI an, es wird automatisch in eine Zeichenkette umgewandelt.

https://docs.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.http.extensions.querybuilder?view=aspnetcore-5.0

Answer 5

Flurl (Offenlegung: Ich bin der Autor) unterstützt die Erstellung von Abfragezeichenfolgen über anonyme Objekte (neben anderen Möglichkeiten):

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!"
});

Die optionale Flurl.Http-Begleitlib ermöglicht es Ihnen, HTTP-Aufrufe direkt aus der gleichen fließenden Aufrufkette zu tätigen und sie zu einem vollwertigen REST-Client zu erweitern:

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>();

Das vollständige Paket ist auf NuGet verfügbar:

PM> Install-Package Flurl.Http

oder nur den eigenständigen URL-Builder:

PM> Install-Package Flurl