System.Net.HttpClientのクエリ文字列を作成する

System.Net.HttpClientを使用してhttp getリクエストを送信したい場合、パラメーターを追加するAPIがないようですが、これは正しいですか？

クエリ文字列を作成するために利用できる簡単なAPIはありますか？名前値コレクションの作成とそれらをURLエンコードしてからそれらを最終的に連結することは含まれていませんか？RestSharpのapi（AddParameter（..）など）を使用したいと思っていました。

System.Net.HttpClientを使用してhttp getリクエストを送信したい場合、パラメーターを追加する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まだ使用していないプロジェクトに含めたくない場合は、FormUrlEncodedContentfrom 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を行うコンストラクタを使用して新しいものが作成されます（通常のURLエンコーディング）
• それはやってすることで回避することはできませんuriBuilder.ToString()（このリターンは修正にもかかわらず、UriIMO多分少なくとも矛盾、バグであるが、それは別の問題だ）してから使用して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コンストラクタを使用しています

Windows Server上の私の最新の.NET上のPS Uri、ブールドキュメンテーションコメント付きのコンストラクターは「廃止され、dontEscapeは常にfalseです」と述べていますが、実際には期待どおりに機能します（エスケープをスキップします）。

別のバグのようです...

そしてこれは明らかに間違っています-サーバーが期待するUrlEncodedだけでなく、UrlEncodedUnicodeをサーバーに送信します

更新：もう1つあります。NameValueCollectionは実際にはUrlEncodeUnicodeを実行しますが、これはもう使用される予定ではなく、通常のurl.encode / decodeと互換性がありません（NameValueCollection to URL Query？を参照）。

したがって、最終的にはNameValueCollection query = HttpUtility.ParseQueryString(builder.Query);、このハックを使用しないでください。Unicodeクエリパラメータが混乱するためです。クエリを手動で作成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));

フル機能のRESTクライアントに拡張するオプションのコンパニオンライブラリを備えた流暢なURLビルダーであるFlurl [開示：私は作者です] をチェックしてみてください。

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

Rostovの投稿と同じよう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()。

受け入れられた回答の大部分は、HttpUtility.ParseQueryString（）の代わりにUriBuilder.Uri.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();

「Darin Dimitrov」のおかげで、これは拡張メソッドです。

 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"