Як побудувати рядок запиту для URL-адреси в C #?


473

Загальне завдання під час виклику веб-ресурсів з коду - це побудова рядка запиту з включенням усіх необхідних параметрів. Хоча явно не маю ракетних наук, є кілька чудових деталей, про які потрібно подбати, додавши &якщо не перший параметр, кодуючи параметри тощо.

Код зробити це дуже просто, але трохи нудно:

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, я не зміг знайти одного, що приводить мене до наступного питання:

Який найелегантніший чистий спосіб ви знаєте, як робити вищезазначене?


26
Це трохи сумно, що навіть у поточний момент часу, мабуть, немає прямого способу впоратися із запитами. І під прямим розумінням я маю на увазі OOB, не внутрішній, стандартний стандартний клас. А може, я щось пропускаю?
Гримаса відчаю

5
Ти нічого не пропускаєш. Будівництво запитів - це головна прогалина в рамках, яку я намагався заповнити Flurl .
Тод Меньє


Ви щойно задумали мене створити один .. новий UrlBuilder (існуючий) .AddQuery ("ключ", "значення"). ToString ()
Demetris Leptos

Відповіді:


293

Якщо ви заглянете під капот, властивість 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 ...


22
Специфікація HTTP (RFC 2616) нічого не говорить про те, що рядки запитів можуть містити. Також не використовується RFC 3986, який визначає загальний формат URI. Формат пари ключ / значення, який зазвичай використовується, називається application/x-www-form-urlencodedі фактично визначається HTML для подання даних форми як частини GETзапиту. HTML 5 не забороняє кілька значень на ключ у цьому форматі, і насправді він вимагає, щоб браузер видав кілька значень на ключ у випадку, якщо сторінка (неправильно) містить кілька полів з одним nameатрибутом. Дивіться goo.gl/uk1Ag
Даніель Кассіді

14
@annakata: Я знаю, що мій коментар старший рік (а відповідь - понад два роки!), але NameValueCollection дуже підтримує декілька значень на ключ, використовуючи метод GetValues ​​(ключ).
Маурісіо Шеффер

4
@MauricioScheffer: Але NameValueCollection не перетворюється на рядок запитів "правильно". Наприклад, якщо ви встановите параметр QueryString в WebClient, де один і той же ключ присутній кілька разів, він перетворюється на "шлях? Ключ = значення1, значення2" замість "шлях? Ключ = значення1 і ключ = значення2", що є загальним (стандартним ?) візерунок.
Давид Папа

8
Щодо кількох значень на ключ, я вважаю, що у HTML, якщо у вас є вікно списку з декількома виборами з декількома елементами, вибраними та поданими, вони надсилаються у форматі множинних значень, згаданому Девідом.
Сем

10
Ви можете використовувати Uri.EscapeDataString замість HttpUtility.UrlEncode, який є більш портативним. Дивіться stackoverflow.com/questions/2573290/…
PEK

687

Ви можете створити новий примірник для запису HttpValueCollection, зателефонувавши System.Web.HttpUtility.ParseQueryString(string.Empty), а потім використовувати його як будь-який 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-адресою.

Після пошуку SO та Інтернету для відповіді на подібне питання, це найпростіше рішення, яке я міг знайти.

.NET Core

Якщо ви працюєте в .NET Core, ви можете використовувати Microsoft.AspNetCore.WebUtilities.QueryHelpersклас, який значно спрощує це.

https://docs.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));

6
Можливо, ви могли б створити метод розширення під назвою ToURLQueryString для інтерфейсу IDictionary:public static string ToURLQueryString(this IDictionary dict) { ... }
Roy Tinker

65
Цей метод не відповідає стандарту для багатобайтових символів. Він буде кодувати їх як% uXXXX замість% XX% XX. Отримані рядки запитів можуть бути неправильно інтерпретовані веб-серверами. Це навіть задокументовано у внутрішньому рамковому класі HttpValueCollection, який повертається HttpUtility.ParseQueryString (). Коментар каже, що вони зберігають таку поведінку з міркувань відсталості.
алекс

25
Зауважте, що між HttpUtilityPraseQueryString ("") та новим NameValueCollection () є важлива різниця - лише результат HttpUtility перекриє ToString () для створення належного запиту
Frank Schwieterman

7
А як щодо випадків, коли вам потрібно кілька примірників імені в рядку запиту? Наприклад, "type = 10 & type = 21".
Фінстер

7
@Finster Ви можете додати кілька екземплярів імені до рядка запиту за допомогою Addметоду. Тобто, queryString.Add("type", "1"); queryString.Add("type", "2"); використовуючи Addметод, мабуть, кращий спосіб робити це весь час насправді.
jeremysawesome

94

Маючи натхнення з коментаря Роя Тінкера, я в кінцевому підсумку застосував простий метод розширення для класу 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;
}

3
Ідеально. Додано до моєї власної бібліотеки. :)
Енді

1
Вам також слід кодувати значення URL. queryString.Add (ім'я, Uri.EscapeDataString (значення));
Ufuk Hacıoğulları

2
Дякуємо за вдосконалення цієї відповіді. Виправлена ​​проблема з багатобайтовими символами.
Ufuk Hacıoğulları

9
Бічна примітка, це не працює з відносними URL-адресами, оскільки ви не можете створити UriBuilder від відносного Uri.
Юрій Факторович

1
Я додав ключ видалення, щоб дублікат не міг бути доданий. dotnetfiddle.net/hTlyAd
Пол Тоцке

29

Я відповів на подібне запитання деякий час тому. В основному, найкращим способом було б використання класу HttpValueCollection, яким Request.QueryStringвласне є ASP.NET, але, на жаль, він є внутрішнім у рамках .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&paramA=A&paramB=B

Дякую ... я помітив, що NameValueCollection, яку він повертає, має ToString (), який діє інакше, але не міг зрозуміти, чому.
calebt

httpValueCollection.ToString()насправді дзвінки, httpValueCollection.ToString(true)тому додавання trueексплікації не потрібно.
dav_i

5
HttpValueCollection - це внутрішній клас, тому ви не можете його ініціювати.
ozba

29

Ось вільний / лямбда-іш спосіб як метод розширення (поєднання понять у попередніх публікаціях), який підтримує кілька значень для одного ключа. Моє особисте вподобання - це розширення над фантиками для виявлення інших членів команди для виявлення таких предметів. Зауважте, що навколо методів кодування є суперечки, чимало публікацій про неї на стеку 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;
}

1
Це не вдається, якщо будь-яке значення недійсне
Josh Noe

це неправильно, він генерує багато рядків запитів для кожної пари ключових значень
Gayan

@GayanRanasinghe: Що це навіть означає?
Матті Вірккунен

22

Flurl [розкриття: я автор] підтримує створення рядків запитів через анонімні об'єкти (серед інших способів):

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

Повний пакет доступний на NuGet:

PM> Install-Package Flurl.Http

або просто окремий конструктор URL-адрес:

PM> Install-Package Flurl


20

Ось мій пізній запис. Мені не сподобалося жодне з інших з різних причин, тому я написав свою власну.

Ця версія має:

  • Використання лише StringBuilder. Немає викликів ToArray () або інших методів розширення. Це виглядає не так красиво, як деякі інші відповіді, але я вважаю, що це основна функція, тому ефективність важливіша, ніж наявність "вільного", "однолінійного" коду, який приховує неефективність.

  • Обробляє кілька значень на ключ. (Мені це не потрібно було мені, а просто мовчати Маурісіо;)

    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

Мені подобається, що це не використовує HttpUtility, який знаходиться під System.Web і доступний не скрізь.
Кугель

+1 за те, що не використовується linq та не використовується HttpUtility. Я б створив порожній sb і вирив змінну "bool first", а потім у циклі просто мати sb.Append (sb.Length == 0? "?": "&") Перед sb.AppendFormat (). Тепер, якщо nvc порожній, метод поверне порожню рядок замість самотнього "?".
Меттью Легер

Ця відповідь обробляє окремі параметри з декількома значеннями. наприклад? id = 1 & id = 3 & id = 2 & id = 9
Математики

12

Як щодо створення методів розширення, які дозволяють додавати параметри у вільному стилі, як це?

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

: +1: для простого методу розширення на основі рядків. Деякі інші відповіді можуть охоплювати більш крайні випадки, але це досить для моєї ситуації, і це не вимагає , щоб я побудувати NameValueCollection, HttpValueCollectionабо Uriперший. Дякую!
Стенлі Г.

11

Мені потрібно було вирішити ту саму проблему для бібліотеки портативних класів (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;

Це метод, який я використовую, і на який я посилався в іншому запитанні http://stackoverflow.com/a/26744471/2108310 Єдина відмінність полягає в тому, що я використовую масив пар KeyValue ... окрім необхідності посилання на System. Чистий (який доступний в PCL, як ви заявили), це IMHO найпростіший спосіб зробити це, не включаючи якийсь сторонній пакет, або не намагаючись поплескувати якусь хатню спагетті з домашнього кави.
Ростов

9
    public static string ToQueryString(this Dictionary<string, string> source)
    {
        return String.Join("&", source.Select(kvp => String.Format("{0}={1}", HttpUtility.UrlEncode(kvp.Key), HttpUtility.UrlEncode(kvp.Value))).ToArray());
    }

    public static string ToQueryString(this NameValueCollection source)
    {
        return String.Join("&", source.Cast<string>().Select(key => String.Format("{0}={1}", HttpUtility.UrlEncode(key), HttpUtility.UrlEncode(source[key]))).ToArray());
    }

1
Приємно! Але тобі не потрібні .ToArray().
квітня 1313

7

Додайте цей клас до свого проекту

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;

public class QueryStringBuilder
{
    private readonly List<KeyValuePair<string, object>> _list;

    public QueryStringBuilder()
    {
        _list = new List<KeyValuePair<string, object>>();
    }

    public void Add(string name, object value)
    {
        _list.Add(new KeyValuePair<string, object>(name, value));
    }

    public override string ToString()
    {
        return String.Join("&", _list.Select(kvp => String.Concat(Uri.EscapeDataString(kvp.Key), "=", Uri.EscapeDataString(kvp.Value.ToString()))));
    }
}

І використовуйте його так:

var actual = new QueryStringBuilder {
    {"foo", 123},
    {"bar", "val31"},
    {"bar", "val32"}
};

actual.Add("a+b", "c+d");

actual.ToString(); // "foo=123&bar=val31&bar=val32&a%2bb=c%2bd"

Тепер це має бути прийнятою відповіддю; прекрасно працює для масивів типу "foo [] = 1, foo [] = 2", а також дотримується порядку параметрів, що дуже важливо, до речі.
Соруш Фалахаті

6

Моя пропозиція:

public static Uri AddQuery(this Uri uri, string name, string value)
{
    // this actually returns HttpValueCollection : NameValueCollection
    // which uses unicode compliant encoding on ToString()
    var query = HttpUtility.ParseQueryString(uri.Query);

    query.Add(name, value);

    var uriBuilder = new UriBuilder(uri)
    {
        Query = query.ToString()
    };

    return uriBuilder.Uri;
}

Використання:

var uri = new Uri("http://stackoverflow.com").AddQuery("such", "method")
                                             .AddQuery("wow", "soFluent");

// http://stackoverflow.com?such=method&wow=soFluent

Я вважаю за краще ваш підхід простий та елегантний, однак, HttpUtility вимагає System.Web
Ody

5

Неперевірений, але я думаю, що щось у цьому напрямку спрацювало б чудово

public class QueryString
{
    private Dictionary<string,string> _Params = new Dictionary<string,string>();

    public overide ToString()
    {
        List<string> returnParams = new List<string>();

        foreach (KeyValuePair param in _Params)
        {
            returnParams.Add(String.Format("{0}={1}", param.Key, param.Value));
        }

        // return String.Format("?{0}", String.Join("&", returnParams.ToArray())); 

        // credit annakata
        return "?" + String.Join("&", returnParams.ToArray());
    }

    public void Add(string key, string value)
    {
        _Params.Add(key, HttpUtility.UrlEncode(value));
    }
}

QueryString query = new QueryString();

query.Add("param1", "value1");
query.Add("param2", "value2");

return query.ToString();

чудово капсульований, але цей формат на "? {0}" - це
щось

змінив назву класу на QueryString .. Запит трохи неоднозначний
Нік Аллен

4

Версія на основі методу швидкого розширення:

class Program
{
    static void Main(string[] args)
    {
        var parameters = new List<KeyValuePair<string, string>>
                             {
                                 new KeyValuePair<string, string>("A", "AValue"),
                                 new KeyValuePair<string, string>("B", "BValue")
                             };

        string output = "?" + string.Join("&", parameters.ConvertAll(param => param.ToQueryString()).ToArray());
    }
}

public static class KeyValueExtensions
{
    public static string ToQueryString(this KeyValuePair<string, string> obj)
    {
        return obj.Key + "=" + HttpUtility.UrlEncode(obj.Value);
    }
}

Ви можете використовувати пункт де для вибору параметрів, що додаються до рядка.


3

Припускаючи, що ви хочете зменшити залежність від інших збірок і зробити прості речі, ви можете зробити:

var sb = new System.Text.StringBuilder();

sb.Append("a=" + HttpUtility.UrlEncode("TheValueOfA") + "&");
sb.Append("b=" + HttpUtility.UrlEncode("TheValueOfB") + "&");
sb.Append("c=" + HttpUtility.UrlEncode("TheValueOfC") + "&");
sb.Append("d=" + HttpUtility.UrlEncode("TheValueOfD") + "&");

sb.Remove(sb.Length-1, 1); // Remove the final '&'

string result = sb.ToString();

Це добре працює і з петлями. Остаточне видалення амперсанда повинно вийти за межі петлі.

Зауважте, що оператор конкатенації використовується для поліпшення читабельності. Вартість його використання порівняно з витратами на використання StringBuilder мінімальна (я думаю, що Джефф Етвуд розмістив щось на цю тему).


3

Об’єднав основні відповіді, щоб створити анонімну версію об'єкта :

var queryString = HttpUtility2.BuildQueryString(new
{
    key2 = "value2",
    key1 = "value1",
});

Це породжує це:

key2 = value2 & key1 = value1

Ось код:

public static class HttpUtility2
{
    public static string BuildQueryString<T>(T obj)
    {
        var queryString = HttpUtility.ParseQueryString(string.Empty);

        foreach (var property in TypeDescriptor.GetProperties(typeof(T)).Cast<PropertyDescriptor>())
        {
            var value = (property.GetValue(obj) ?? "").ToString();
            queryString.Add(property.Name, value);
        }

        return queryString.ToString();
    }
}

2

Те саме, що прийняте рішення, але переведено на "крапковий" синтаксис LINQ ...

private string ToQueryString(NameValueCollection nvc)
{
    if (nvc == null) return String.Empty;
    var queryParams = 
          string.Join("&", nvc.AllKeys.Select(key => 
              string.Join("&", nvc.GetValues(key).Select(v => string.Format("{0}={1}", HttpUtility.UrlEncode(key), HttpUtility.UrlEncode(v))))));
    return "?" + queryParams;
}

2

У мене є метод розширення для Uri, який:

  • Приймає анонімні об'єкти: uri.WithQuery(new { name = "value" })
  • Приймає колекції string/stringпар (наприклад, словник`2 ).
  • Приймає колекції string/objectпар (наприклад, RouteValueDictionary ).
  • Приймає NameValueCollection s.
  • Сортуйте значення запиту за ключовими словами, щоб ті самі значення давали рівні URI.
  • Підтримує кілька значень на ключ, зберігаючи їх початковий порядок.

Задокументовану версію можна знайти тут .

Розширення:

public static Uri WithQuery(this Uri uri, object values)
{
    if (uri == null)
        throw new ArgumentNullException(nameof(uri));

    if (values != null)
    {
        var query = string.Join(
            "&", from p in ParseQueryValues(values)
                 where !string.IsNullOrWhiteSpace(p.Key)
                 let k = HttpUtility.UrlEncode(p.Key.Trim())
                 let v = HttpUtility.UrlEncode(p.Value)
                 orderby k
                 select string.IsNullOrEmpty(v) ? k : $"{k}={v}");

        if (query.Length != 0 || uri.Query.Length != 0)
            uri = new UriBuilder(uri) { Query = query }.Uri;
    }

    return uri;
}

Аналізатор запитів:

private static IEnumerable<KeyValuePair<string, string>> ParseQueryValues(object values)
{
    // Check if a name/value collection.
    var nvc = values as NameValueCollection;
    if (nvc != null)
        return from key in nvc.AllKeys
               from val in nvc.GetValues(key)
               select new KeyValuePair<string, string>(key, val);

    // Check if a string/string dictionary.
    var ssd = values as IEnumerable<KeyValuePair<string, string>>;
    if (ssd != null)
        return ssd;

    // Check if a string/object dictionary.
    var sod = values as IEnumerable<KeyValuePair<string, object>>;
    if (sod == null)
    {
        // Check if a non-generic dictionary.
        var ngd = values as IDictionary;
        if (ngd != null)
            sod = ngd.Cast<dynamic>().ToDictionary<dynamic, string, object>(
                p => p.Key.ToString(), p => p.Value as object);

        // Convert object properties to dictionary.
        if (sod == null)
            sod = new RouteValueDictionary(values);
    }

    // Normalize and return the values.
    return from pair in sod
           from val in pair.Value as IEnumerable<string>
            ?? new[] { pair.Value?.ToString() }
           select new KeyValuePair<string, string>(pair.Key, val);
}

Ось тести:

var uri = new Uri("https://stackoverflow.com/yo?oldKey=oldValue");

// Test with a string/string dictionary.
var q = uri.WithQuery(new Dictionary<string, string>
{
    ["k1"] = string.Empty,
    ["k2"] = null,
    ["k3"] = "v3"
});

Debug.Assert(q == new Uri(
    "https://stackoverflow.com/yo?k1&k2&k3=v3"));

// Test with a string/object dictionary.
q = uri.WithQuery(new Dictionary<string, object>
{
    ["k1"] = "v1",
    ["k2"] = new[] { "v2a", "v2b" },
    ["k3"] = null
});

Debug.Assert(q == new Uri(
    "https://stackoverflow.com/yo?k1=v1&k2=v2a&k2=v2b&k3"));

// Test with a name/value collection.
var nvc = new NameValueCollection()
{
    ["k1"] = string.Empty,
    ["k2"] = "v2a"
};

nvc.Add("k2", "v2b");

q = uri.WithQuery(nvc);
Debug.Assert(q == new Uri(
    "https://stackoverflow.com/yo?k1&k2=v2a&k2=v2b"));

// Test with any dictionary.
q = uri.WithQuery(new Dictionary<int, HashSet<string>>
{
    [1] = new HashSet<string> { "v1" },
    [2] = new HashSet<string> { "v2a", "v2b" },
    [3] = null
});

Debug.Assert(q == new Uri(
    "https://stackoverflow.com/yo?1=v1&2=v2a&2=v2b&3"));

// Test with an anonymous object.
q = uri.WithQuery(new
{
    k1 = "v1",
    k2 = new[] { "v2a", "v2b" },
    k3 = new List<string> { "v3" },
    k4 = true,
    k5 = null as Queue<string>
});

Debug.Assert(q == new Uri(
    "https://stackoverflow.com/yo?k1=v1&k2=v2a&k2=v2b&k3=v3&k4=True&k5"));

// Keep existing query using a name/value collection.
nvc = HttpUtility.ParseQueryString(uri.Query);
nvc.Add("newKey", "newValue");

q = uri.WithQuery(nvc);
Debug.Assert(q == new Uri(
    "https://stackoverflow.com/yo?newKey=newValue&oldKey=oldValue"));

// Merge two query objects using the RouteValueDictionary.
var an1 = new { k1 = "v1" };
var an2 = new { k2 = "v2" };

q = uri.WithQuery(
    new RouteValueDictionary(an1).Concat(
        new RouteValueDictionary(an2)));

Debug.Assert(q == new Uri(
    "https://stackoverflow.com/yo?k1=v1&k2=v2"));

2

Клас для обгортки з можливістю ланцюга для HttpValueCollection:

namespace System.Web.Mvc {
    public class QueryStringBuilder {
        private NameValueCollection collection;
        public QueryStringBuilder() {
            collection = System.Web.HttpUtility.ParseQueryString(string.Empty);
        }
        public QueryStringBuilder Add(string key, string value) {
            collection.Add(key, value);
            return this;
        }
        public QueryStringBuilder Remove(string key) {
            collection.Remove(key);
            return this;
        }
        public string this[string key] {
            get { return collection[key]; }
            set { collection[key] = value; }
        }
        public string ToString() {
            return collection.ToString();
        }
    }
}

Приклад використання:

QueryStringBuilder parameters = new QueryStringBuilder()
    .Add("view", ViewBag.PageView)
    .Add("page", ViewBag.PageNumber)
    .Add("size", ViewBag.PageSize);
string queryString = parameters.ToString();

1

Я додав наступний метод до свого класу PageBase.

protected void Redirect(string url)
    {
        Response.Redirect(url);
    }
protected void Redirect(string url, NameValueCollection querystrings)
    {
        StringBuilder redirectUrl = new StringBuilder(url);

        if (querystrings != null)
        {
            for (int index = 0; index < querystrings.Count; index++)
            {
                if (index == 0)
                {
                    redirectUrl.Append("?");
                }

                redirectUrl.Append(querystrings.Keys[index]);
                redirectUrl.Append("=");
                redirectUrl.Append(HttpUtility.UrlEncode(querystrings[index]));

                if (index < querystrings.Count - 1)
                {
                    redirectUrl.Append("&");
                }
            }
        }

        this.Redirect(redirectUrl.ToString());
    }

Дзвонити:

NameValueCollection querystrings = new NameValueCollection();    
querystrings.Add("language", "en");
querystrings.Add("id", "134");
this.Redirect("http://www.mypage.com", querystrings);

1

Я написав кілька методів розширення, які вважаю дуже корисними під час роботи з QueryStrings. Часто я хочу почати з поточного QueryString і змінити його перед його використанням. Щось на зразок,

var res = Request.QueryString.Duplicate()
  .ChangeField("field1", "somevalue")
  .ChangeField("field2", "only if following is true", true)
  .ChangeField("id", id, id>0)
  .WriteLocalPathWithQuery(Request.Url)); //Uses context to write the path

Докладніше та джерело: http://www.charlesrcook.com/archive/2008/07/23/c-extension-methods-for-asp.net-query-string-operations.aspx

Це базовий, але мені подобається стиль.


1

Просто хотів кинути свої 2 копійки:

public static class HttpClientExt
{
    public static Uri AddQueryParams(this Uri uri, string query)
    {
        var ub = new UriBuilder(uri);
        ub.Query = string.IsNullOrEmpty(uri.Query) ? query : string.Join("&", uri.Query.Substring(1), query);
        return ub.Uri;
    }

    public static Uri AddQueryParams(this Uri uri, IEnumerable<string> query)
    {
        return uri.AddQueryParams(string.Join("&", query));
    } 

    public static Uri AddQueryParams(this Uri uri, string key, string value)
    {
        return uri.AddQueryParams(string.Join("=", HttpUtility.UrlEncode(key), HttpUtility.UrlEncode(value)));
    }

    public static Uri AddQueryParams(this Uri uri, params KeyValuePair<string,string>[] kvps)
    {
        return uri.AddQueryParams(kvps.Select(kvp => string.Join("=", HttpUtility.UrlEncode(kvp.Key), HttpUtility.UrlEncode(kvp.Value))));
    }

    public static Uri AddQueryParams(this Uri uri, IDictionary<string, string> kvps)
    {
        return uri.AddQueryParams(kvps.Select(kvp => string.Join("=", HttpUtility.UrlEncode(kvp.Key), HttpUtility.UrlEncode(kvp.Value))));
    }

    public static Uri AddQueryParams(this Uri uri, NameValueCollection nvc)
    {
        return uri.AddQueryParams(nvc.AllKeys.SelectMany(nvc.GetValues, (key, value) => string.Join("=", HttpUtility.UrlEncode(key), HttpUtility.UrlEncode(value))));
    }
}

Документи говорять, що uri.Queryпочнеться з атрибуту, ?якщо він не порожній, і слід обрізати його, якщо ви збираєтесь його змінити.

Зверніть увагу, що HttpUtility.UrlEncodeзнайдено в System.Web.

Використання:

var uri = new Uri("https://api.del.icio.us/v1/posts/suggest").AddQueryParam("url","http://stackoverflow.com")

1

Хоча це не елегантно, я вибрав більш просту версію, яка не використовується NameValueCollecitons- просто шаблон для будівельників, який обгорнувся StringBuilder.

public class UrlBuilder
{
    #region Variables / Properties

    private readonly StringBuilder _builder;

    #endregion Variables / Properties

    #region Constructor

    public UrlBuilder(string urlBase)
    {
        _builder = new StringBuilder(urlBase);
    }

    #endregion Constructor

    #region Methods

    public UrlBuilder AppendParameter(string paramName, string value)
    {
        if (_builder.ToString().Contains("?"))
            _builder.Append("&");
        else
            _builder.Append("?");

        _builder.Append(HttpUtility.UrlEncode(paramName));
        _builder.Append("=");
        _builder.Append(HttpUtility.UrlEncode(value));

        return this;
    }

    public override string ToString()
    {
        return _builder.ToString();
    }

    #endregion Methods
}

За наявними відповідями я обов’язково використовував HttpUtility.UrlEncodeдзвінки. Він використовується так:

string url = new UrlBuilder("http://www.somedomain.com/")
             .AppendParameter("a", "true")
             .AppendParameter("b", "muffin")
             .AppendParameter("c", "muffin button")
             .ToString();
// Result: http://www.somedomain.com?a=true&b=muffin&c=muffin%20button

1
// USAGE
[TestMethod]
public void TestUrlBuilder()
{
    Console.WriteLine(
        new UrlBuilder("http://www.google.com?A=B")
            .AddPath("SomePathName")
            .AddPath("AnotherPathName")
            .SetQuery("SomeQueryKey", "SomeQueryValue")
            .AlterQuery("A", x => x + "C"));
}

Вихід:

http://www.google.com/SomePathName/AbodyPathName?A=BC&SomeQueryKey=SomeQueryValue

Код; ви можете десь подякувати мені якось: D

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;

// By Demetris Leptos
namespace TheOperator.Foundation.Web
{
    public class UrlBuilder
    {
        public string Scheme { get; set; }

        public string Host { get; set; }

        public int? Port { get; set; }

        public List<string> Paths { get; set; }

        public SortedDictionary<string, string> QueryPairs { get; set; }

        public UrlBuilder(string url)
        {
            this.Paths = new List<string>();
            this.QueryPairs = new SortedDictionary<string, string>();

            string path = null;
            string query = null;
            Uri relativeUri = null;
            if (!Uri.TryCreate(url, UriKind.Relative, out relativeUri))
            {
                var uriBuilder = new UriBuilder(url);
                this.Scheme = uriBuilder.Scheme;
                this.Host = uriBuilder.Host;
                this.Port = uriBuilder.Port;
                path = uriBuilder.Path;
                query = uriBuilder.Query;
            }
            else
            {
                var queryIndex = url.IndexOf('?');
                if (queryIndex >= 0)
                {
                    path = url.Substring(0, queryIndex);
                    query = url.Substring(queryIndex + 1);
                }
                else
                {
                    path = url;
                }
            }
            this.Paths.AddRange(path.Split(new char[] { '/' }, StringSplitOptions.RemoveEmptyEntries));
            if (query != null)
            {
                var queryKeyValuePairs = HttpUtility.ParseQueryString(query);
                foreach (var queryKey in queryKeyValuePairs.AllKeys)
                {
                    this.QueryPairs[queryKey] = queryKeyValuePairs[queryKey];
                }
            }
        }

        public UrlBuilder AddPath(string value)
        {
            this.Paths.Add(value);
            return this;
        }

        public UrlBuilder SetQuery(string key, string value)
        {
            this.QueryPairs[key] = value;
            return this;
        }

        public UrlBuilder RemoveQuery(string key)
        {
            this.QueryPairs.Remove(key);
            return this;
        }

        public UrlBuilder AlterQuery(string key, Func<string, string> alterMethod, bool removeOnNull = false)
        {
            string value;
            this.QueryPairs.TryGetValue(key, out value);
            value = alterMethod(value);
            if (removeOnNull && value == null)
            {
                return this.RemoveQuery(key);
            }
            else
            {
                return this.SetQuery(key, value);
            }
        }

        public override string ToString()
        {
            var path = !string.IsNullOrWhiteSpace(this.Host)
                ? string.Join("/", this.Host, string.Join("/", this.Paths))
                : string.Join("/", this.Paths);
            var query = string.Join("&", this.QueryPairs.Select(x => string.Concat(x.Key, "=", HttpUtility.UrlEncode(x.Value))));
            return string.Concat(
                !string.IsNullOrWhiteSpace(this.Scheme) ? string.Concat(this.Scheme, "://") : null,
                path,
                !string.IsNullOrWhiteSpace(query) ? string.Concat("?", query) : null);
        }
    }
}

1

Я пішов із рішенням, запропонованим DSO (відповів 2 серпня 1111 о 7:29), його рішення не потребує використання HttpUtility. Однак, відповідно до статті, розміщеної в Dotnetpearls , використання словника швидше (у виконанні), ніж використання NameValueCollection. Ось рішення DSO, модифіковане для використання словника замість NameValueCollection.

    public static Dictionary<string, string> QueryParametersDictionary()
    {
        var dictionary = new Dictionary<string, string>();
        dictionary.Add("name", "John Doe");
        dictionary.Add("address.city", "Seattle");
        dictionary.Add("address.state_code", "WA");
        dictionary.Add("api_key", "5352345263456345635");

        return dictionary;
    }

    public static string ToQueryString(Dictionary<string, string> nvc)
    {
        StringBuilder sb = new StringBuilder();

        bool first = true;

        foreach (KeyValuePair<string, string> pair in nvc)
        {
                if (!first)
                {
                    sb.Append("&");
                }

                sb.AppendFormat("{0}={1}", Uri.EscapeDataString(pair.Key), Uri.EscapeDataString(pair.Value));

                first = false;
        }

        return sb.ToString();
    }

1

Рядок запиту може бути доданий до URL за допомогою:

  1. створити об'єкт збору значень імен
  2. додайте до цього об’єкта елементи рядка запиту та їх значення
  3. кодуйте цей об'єкт збору значень імені до URL-коду, який надається за посиланням нижче

https://blog.codingnovice.com/blog

public ActionResult Create()
{
    //declaring name value collection object
    NameValueCollection collection = new NameValueCollection();

    //adding new value to the name value collection object
    collection.Add("Id1", "wwe323");
    collection.Add("Id2", "454w");
    collection.Add("Id3", "tyt5656");
    collection.Add("Id4", "343wdsd");

    //generating query string
    string url = GenerateQueryString(collection);

    return View();
}

private string GenerateQueryString(NameValueCollection collection)
{
    var querystring = (
        from key in collection.AllKeys
        from value in collection.GetValues(key)
        select string.Format("{0}={1}",
            HttpUtility.UrlEncode(key),
            HttpUtility.UrlEncode(value))
    ).ToArray();
    return "?" + string.Join("&", querystring);
}

0

Я написав помічника для свого проекту бритви, використовуючи деякі підказки з інших відповідей.

Бізнес ParseQueryString необхідний, оскільки нам не дозволяється підробляти об'єкт QueryString поточного запиту.

@helper GetQueryStringWithValue(string key, string value) {
    var queryString = System.Web.HttpUtility.ParseQueryString(HttpContext.Current.Request.QueryString.ToString());
    queryString[key] = value;
    @Html.Raw(queryString.ToString())
}

Я використовую це так:

location.search = '?@Helpers.GetQueryStringWithValue("var-name", "var-value")';

Якщо ви хочете, щоб він прийняв більше одного значення, просто змініть параметри до словника та додайте пари до рядка запиту.


0

Код нижче знімається з HttpValueCollectionреалізаціїToString через ILSpy, що дає вам ім'я = значення запиту.

На жаль, HttpValueCollection - це внутрішній клас, до якого ви повертаєтеся лише тоді, коли використовуєте HttpUtility.ParseQueryString(). Я видалив усі частини перегляду, і він за замовчуванням кодує:

public static class HttpExtensions
{
    public static string ToQueryString(this NameValueCollection collection)
    {
        // This is based off the NameValueCollection.ToString() implementation
        int count = collection.Count;
        if (count == 0)
            return string.Empty;

        StringBuilder stringBuilder = new StringBuilder();

        for (int i = 0; i < count; i++)
        {
            string text = collection.GetKey(i);
            text = HttpUtility.UrlEncodeUnicode(text);
            string value = (text != null) ? (text + "=") : string.Empty;
            string[] values = collection.GetValues(i);
            if (stringBuilder.Length > 0)
            {
                stringBuilder.Append('&');
            }
            if (values == null || values.Length == 0)
            {
                stringBuilder.Append(value);
            }
            else
            {
                if (values.Length == 1)
                {
                    stringBuilder.Append(value);
                    string text2 = values[0];
                    text2 = HttpUtility.UrlEncodeUnicode(text2);
                    stringBuilder.Append(text2);
                }
                else
                {
                    for (int j = 0; j < values.Length; j++)
                    {
                        if (j > 0)
                        {
                            stringBuilder.Append('&');
                        }
                        stringBuilder.Append(value);
                        string text2 = values[j];
                        text2 = HttpUtility.UrlEncodeUnicode(text2);
                        stringBuilder.Append(text2);
                    }
                }
            }
        }

        return stringBuilder.ToString();
    }
}

0

Це ідентично прийнятої відповіді, за винятком трохи більш компактного:

private string ToQueryString(NameValueCollection nvc)
{
    return "?" + string.Join("&", nvc.AllKeys.Select(k => string.Format("{0}={1}", 
        HttpUtility.UrlEncode(k), 
        HttpUtility.UrlEncode(nvc[k]))));
}

0

Просто для тих, хто потребує версії VB.NET верхньої відповіді:

Public Function ToQueryString(nvc As System.Collections.Specialized.NameValueCollection) As String
    Dim array As String() = nvc.AllKeys.SelectMany(Function(key As String) nvc.GetValues(key), Function(key As String, value As String) String.Format("{0}={1}", System.Web.HttpUtility.UrlEncode(key), System.Web.HttpUtility.UrlEncode(value))).ToArray()
    Return "?" + String.Join("&", array)
End Function

І версія без LINQ:

Public Function ToQueryString(nvc As System.Collections.Specialized.NameValueCollection) As String
    Dim lsParams As New List(Of String)()

    For Each strKey As String In nvc.AllKeys
        Dim astrValue As String() = nvc.GetValues(strKey)

        For Each strValue As String In astrValue
            lsParams.Add(String.Format("{0}={1}", System.Web.HttpUtility.UrlEncode(strKey), System.Web.HttpUtility.UrlEncode(strValue)))
        Next ' Next strValue
    Next ' strKey
    Dim astrParams As String() = lsParams.ToArray()
    lsParams.Clear()
    lsParams = Nothing

    Return "?" + String.Join("&", astrParams)
End Function ' ToQueryString

І версія C # без LINQ:

    public static string ToQueryString(System.Collections.Specialized.NameValueCollection nvc)
    {
        List<string> lsParams = new List<string>();

        foreach (string strKey in nvc.AllKeys)
        {
            string[] astrValue = nvc.GetValues(strKey);

            foreach (string strValue in astrValue)
            {
                lsParams.Add(string.Format("{0}={1}", System.Web.HttpUtility.UrlEncode(strKey), System.Web.HttpUtility.UrlEncode(strValue)));
            } // Next strValue

        } // Next strKey

        string[] astrParams =lsParams.ToArray();
        lsParams.Clear();
        lsParams = null;

        return "?" + string.Join("&", astrParams);
    } // End Function ToQueryString
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.