Строка запроса сборки для System.Net.HttpClient get

Если я хочу отправить запрос http get с помощью System.Net.HttpClient, кажется, что нет api для добавления параметров, это правильно?

Есть ли простой API, доступный для создания строки запроса, которая не включает создание коллекции значений имени и URL, кодирующих их, а затем, наконец, объединяет их? Я надеялся использовать что-то вроде API RestSharp (т.е. AddParameter (..))

Если я хочу отправить запрос http get с помощью System.Net.HttpClient, кажется, что нет api для добавления параметров, это правильно?

Да.

Есть ли простой API, доступный для создания строки запроса, которая не включает создание коллекции значений имени и URL, кодирующих их, а затем, наконец, объединяет их?

Конечно:

var query = HttpUtility.ParseQueryString(string.Empty);
query["foo"] = "bar<>&-baz";
query["bar"] = "bazinga";
string queryString = query.ToString();

даст вам ожидаемый результат:

foo=bar%3c%3e%26-baz&bar=bazinga

Вы также можете найти UriBuilderкласс полезным:

var builder = new UriBuilder("http://example.com");
builder.Port = -1;
var query = HttpUtility.ParseQueryString(builder.Query);
query["foo"] = "bar<>&-baz";
query["bar"] = "bazinga";
builder.Query = query.ToString();
string url = builder.ToString();

даст вам ожидаемый результат:

http://example.com/?foo=bar%3c%3e%26-baz&bar=bazinga

что вы могли бы более чем безопасно кормить свой HttpClient.GetAsyncметод.

Для тех, кто не хочет включать System.Webв проекты, которые еще не используют его, вы можете использовать FormUrlEncodedContentиз System.Net.Httpи сделать что-то вроде следующего:

версия ключевой пары

string query;
using(var content = new FormUrlEncodedContent(new KeyValuePair<string, string>[]{
    new KeyValuePair<string, string>("ham", "Glazed?"),
    new KeyValuePair<string, string>("x-men", "Wolverine + Logan"),
    new KeyValuePair<string, string>("Time", DateTime.UtcNow.ToString()),
})) {
    query = content.ReadAsStringAsync().Result;
}

словарная версия

string query;
using(var content = new FormUrlEncodedContent(new Dictionary<string, string>()
{
    { "ham", "Glaced?"},
    { "x-men", "Wolverine + Logan"},
    { "Time", DateTime.UtcNow.ToString() },
})) {
    query = content.ReadAsStringAsync().Result;
}

TL; DR: не использовать принятую версию, так как она полностью не работает с обработкой символов Юникода и никогда не использует внутренний API

На самом деле я обнаружил странную проблему двойного кодирования с принятым решением:

Итак, если вы имеете дело с символами, которые необходимо кодировать, то принятое решение приводит к двойному кодированию:

• параметры запроса автоматически кодируются с помощью NameValueCollectionиндексатора ( и это использует UrlEncodeUnicode, а не обычное ожидание UrlEncode(!) )
• Затем при вызове uriBuilder.Uriон создает новый Uriконструктор using, который выполняет кодирование еще раз (обычное кодирование URL).
• Этого нельзя избежать, выполнивuriBuilder.ToString() (даже если это вернёт правильно, Uriчто IMO - это как минимум несоответствие, может быть, ошибка, но это другой вопрос), а затем с помощью HttpClientметода, принимающего строку - клиент все равно создает Uriиз переданной вами строки вот так:new Uri(uri, UriKind.RelativeOrAbsolute)

Небольшое, но полное воспроизведение:

var builder = new UriBuilder
{
    Scheme = Uri.UriSchemeHttps,
    Port = -1,
    Host = "127.0.0.1",
    Path = "app"
};

NameValueCollection query = HttpUtility.ParseQueryString(builder.Query);

query["cyrillic"] = "кирилиця";

builder.Query = query.ToString();
Console.WriteLine(builder.Query); //query with cyrillic stuff UrlEncodedUnicode, and that's not what you want

var uri = builder.Uri; // creates new Uri using constructor which does encode and messes cyrillic parameter even more
Console.WriteLine(uri);

// this is still wrong:
var stringUri = builder.ToString(); // returns more 'correct' (still `UrlEncodedUnicode`, but at least once, not twice)
new HttpClient().GetStringAsync(stringUri); // this creates Uri object out of 'stringUri' so we still end up sending double encoded cyrillic text to server. Ouch!

Вывод:

?cyrillic=%u043a%u0438%u0440%u0438%u043b%u0438%u0446%u044f

https://127.0.0.1/app?cyrillic=%25u043a%25u0438%25u0440%25u0438%25u043b%25u0438%25u0446%25u044f

Как вы можете видеть, независимо от того, что вы делаете uribuilder.ToString()+ httpClient.GetStringAsync(string)или uriBuilder.Uri+, httpClient.GetStringAsync(Uri)вы в конечном итоге отправляете двойной кодированный параметр

Исправленный пример может быть:

var uri = new Uri(builder.ToString(), dontEscape: true);
new HttpClient().GetStringAsync(uri);

Но это использует устаревший Uri конструктор

PS в моем последнем .NET на Windows Server Uriконструктор с комментарием bool doc говорит: «устарел, dontEscape всегда ложен», но на самом деле работает как положено (пропускает экранирование)

Так что похоже на еще одну ошибку ...

И даже это совершенно неправильно - он отправляет UrlEncodedUnicode на сервер, а не только UrlEncoded, что ожидает сервер

Обновление: еще одна вещь, NameValueCollection фактически делает UrlEncodeUnicode, который больше не должен использоваться и несовместим с обычным url.encode / decode (см. NameValueCollection для URL Query? ).

Итак, суть в том, что никогда не используйте этот хак,NameValueCollection query = HttpUtility.ParseQueryString(builder.Query); поскольку он испортит параметры вашего запроса в Юникоде. Просто создайте запрос вручную и назначьте его, UriBuilder.Queryкоторый будет выполнять необходимую кодировку, а затем получите Uri, используя UriBuilder.Uri.

Яркий пример причинения себе вреда при использовании кода, который не должен использоваться таким образом

В проекте ASP.NET Core вы можете использовать класс QueryHelpers.

// using Microsoft.AspNetCore.WebUtilities;
var query = new Dictionary<string, string>
{
    ["foo"] = "bar",
    ["foo2"] = "bar2",
    // ...
};

var response = await client.GetAsync(QueryHelpers.AddQueryString("/api/", query));

Возможно, вы захотите проверить Flurl [раскрытие: я автор], беглый конструктор URL с опциональной дополнительной библиотекой, которая расширяет его до полноценного REST-клиента.

var result = await "https://api.com"
    // basic URL building:
    .AppendPathSegment("endpoint")
    .SetQueryParams(new {
        api_key = ConfigurationManager.AppSettings["SomeApiKey"],
        max_results = 20,
        q = "Don't worry, I'll get encoded!"
    })
    .SetQueryParams(myDictionary)
    .SetQueryParam("q", "overwrite q!")

    // extensions provided by Flurl.Http:
    .WithOAuthBearerToken("token")
    .GetJsonAsync<TResult>();

Проверьте документы для более подробной информации. Полный пакет доступен на NuGet:

PM> Install-Package Flurl.Http

или просто автономный построитель URL:

PM> Install-Package Flurl

По аналогии с постом Ростова, если вы не хотите включать ссылку System.Webв свой проект, вы можете использовать FormDataCollectionfrom System.Net.Http.Formattingи сделать что-то вроде следующего:

С помощью System.Net.Http.Formatting.FormDataCollection

var parameters = new Dictionary<string, string>()
{
    { "ham", "Glaced?" },
    { "x-men", "Wolverine + Logan" },
    { "Time", DateTime.UtcNow.ToString() },
}; 
var query = new FormDataCollection(parameters).ReadAsNameValueCollection().ToString();

Дарин предложил интересное и умное решение, и вот что может быть другим вариантом:

public class ParameterCollection
{
    private Dictionary<string, string> _parms = new Dictionary<string, string>();

    public void Add(string key, string val)
    {
        if (_parms.ContainsKey(key))
        {
            throw new InvalidOperationException(string.Format("The key {0} already exists.", key));
        }
        _parms.Add(key, val);
    }

    public override string ToString()
    {
        var server = HttpContext.Current.Server;
        var sb = new StringBuilder();
        foreach (var kvp in _parms)
        {
            if (sb.Length > 0) { sb.Append("&"); }
            sb.AppendFormat("{0}={1}",
                server.UrlEncode(kvp.Key),
                server.UrlEncode(kvp.Value));
        }
        return sb.ToString();
    }
}

и поэтому, используя его, вы можете сделать это:

var parms = new ParameterCollection();
parms.Add("key", "value");

var url = ...
url += "?" + parms;

Или просто используя мое расширение Uri

Код

public static Uri AttachParameters(this Uri uri, NameValueCollection parameters)
{
    var stringBuilder = new StringBuilder();
    string str = "?";
    for (int index = 0; index < parameters.Count; ++index)
    {
        stringBuilder.Append(str + parameters.AllKeys[index] + "=" + parameters[index]);
        str = "&";
    }
    return new Uri(uri + stringBuilder.ToString());
}

использование

Uri uri = new Uri("http://www.example.com/index.php").AttachParameters(new NameValueCollection
                                                                           {
                                                                               {"Bill", "Gates"},
                                                                               {"Steve", "Jobs"}
                                                                           });

результат

http://www.example.com/index.php?Bill=Gates&Steve=Jobs

RFC 6570 URI Библиотека шаблонов Я разрабатываю способен выполнять эту операцию. Вся кодировка обрабатывается для вас в соответствии с этим RFC. На момент написания этой статьи доступна бета-версия, и единственная причина, по которой она не считается стабильной версией 1.0, заключается в том, что документация не полностью соответствует моим ожиданиям (см. Проблемы № 17 , № 18 , № 32 , № 43 ).

Вы можете создать только строку запроса:

UriTemplate template = new UriTemplate("{?params*}");
var parameters = new Dictionary<string, string>
  {
    { "param1", "value1" },
    { "param2", "value2" },
  };
Uri relativeUri = template.BindByName(parameters);

Или вы можете создать полный URI:

UriTemplate template = new UriTemplate("path/to/item{?params*}");
var parameters = new Dictionary<string, string>
  {
    { "param1", "value1" },
    { "param2", "value2" },
  };
Uri baseAddress = new Uri("http://www.example.com");
Uri relativeUri = template.BindByName(baseAddress, parameters);

Поскольку мне пришлось использовать это немного раз, я придумал этот класс, который просто помогает абстрагироваться от составления строки запроса.

public class UriBuilderExt
{
    private NameValueCollection collection;
    private UriBuilder builder;

    public UriBuilderExt(string uri)
    {
        builder = new UriBuilder(uri);
        collection = System.Web.HttpUtility.ParseQueryString(string.Empty);
    }

    public void AddParameter(string key, string value) {
        collection.Add(key, value);
    }

    public Uri Uri{
        get
        {
            builder.Query = collection.ToString();
            return builder.Uri;
        }
    }

}

Использование будет упрощено до чего-то вроде этого:

var builder = new UriBuilderExt("http://example.com/");
builder.AddParameter("foo", "bar<>&-baz");
builder.AddParameter("bar", "second");
var uri = builder.Uri;

который вернет URI: http://example.com/?foo=bar%3c%3e%26-baz&bar=second

Чтобы избежать проблемы двойного кодирования, описанной в ответе taras.roshko, и сохранить возможность легко работать с параметрами запроса, вы можете использовать uriBuilder.Uri.ParseQueryString()вместо HttpUtility.ParseQueryString().

Хорошая часть принятого ответа, измененная для использования UriBuilder.Uri.ParseQueryString () вместо HttpUtility.ParseQueryString ():

var builder = new UriBuilder("http://example.com");
var query = builder.Uri.ParseQueryString();
query["foo"] = "bar<>&-baz";
query["bar"] = "bazinga";
builder.Query = query.ToString();
string url = builder.ToString();

Благодаря «Дарину Димитрову», это методы расширения.

 public static partial class Ext
{
    public static Uri GetUriWithparameters(this Uri uri,Dictionary<string,string> queryParams = null,int port = -1)
    {
        var builder = new UriBuilder(uri);
        builder.Port = port;
        if(null != queryParams && 0 < queryParams.Count)
        {
            var query = HttpUtility.ParseQueryString(builder.Query);
            foreach(var item in queryParams)
            {
                query[item.Key] = item.Value;
            }
            builder.Query = query.ToString();
        }
        return builder.Uri;
    }

    public static string GetUriWithparameters(string uri,Dictionary<string,string> queryParams = null,int port = -1)
    {
        var builder = new UriBuilder(uri);
        builder.Port = port;
        if(null != queryParams && 0 < queryParams.Count)
        {
            var query = HttpUtility.ParseQueryString(builder.Query);
            foreach(var item in queryParams)
            {
                query[item.Key] = item.Value;
            }
            builder.Query = query.ToString();
        }
        return builder.Uri.ToString();
    }
}

Я не мог найти лучшего решения, чем создание метода расширения для преобразования словаря в QueryStringFormat. Решение, предложенное Waleed AK, также хорошо.

Следуйте моему решению:

Создайте метод расширения:

public static class DictionaryExt
{
    public static string ToQueryString<TKey, TValue>(this Dictionary<TKey, TValue> dictionary)
    {
        return ToQueryString<TKey, TValue>(dictionary, "?");
    }

    public static string ToQueryString<TKey, TValue>(this Dictionary<TKey, TValue> dictionary, string startupDelimiter)
    {
        string result = string.Empty;
        foreach (var item in dictionary)
        {
            if (string.IsNullOrEmpty(result))
                result += startupDelimiter; // "?";
            else
                result += "&";

            result += string.Format("{0}={1}", item.Key, item.Value);
        }
        return result;
    }
}

И им:

var param = new Dictionary<string, string>
          {
            { "param1", "value1" },
            { "param2", "value2" },
          };
param.ToQueryString(); //By default will add (?) question mark at begining
//"?param1=value1&param2=value2"
param.ToQueryString("&"); //Will add (&)
//"&param1=value1&param2=value2"
param.ToQueryString(""); //Won't add anything
//"param1=value1&param2=value2"