C#でURLのクエリ文字列を作成する方法


473

コードからWebリソースを呼び出すときの一般的なタスクは、クエリ文字列を作成して、必要なすべてのパラメーターを含めることです。決してロケットサイエンスではあり&ませんが、最初のパラメータでない場合は、パラメータのエンコードなど、気にする必要がある気の利いた詳細事項があります。

それを行うコードは非常に単純ですが、少し面倒です:

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をスキャンしましたが、MSDNを見つけることができませんでした。これにより、次の質問が表示されます。

上記を行う上で最もエレガントでクリーンな方法は何ですか?


26
現時点でもクエリ文字列を処理する簡単な方法がないように見えるのは少し悲しいです。そして簡単に言うと、OOBの非内部の、標準に準拠したフレームワーククラスです。それとも私は何かを逃していますか?
絶望の

5
何も不足していません。クエリ文字列の構築は、私がFlurlで埋めようとしたフレームワークの大きなギャップです
Todd Menier、2014年


新しいUrlBuilder(existing).AddQuery( "key"、 "value")。ToString()
Demetris Leptos 2017年

回答:


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)は、クエリ文字列に含めることができるものについて何も述べていません。一般的なURI形式を定義するRFC 3986もしません。application/x-www-form-urlencodedフォームデータをGETリクエストの一部として送信するために、一般的に使用されるキーと値のペアの形式はと呼ばれ、実際にはHTMLによって定義されます。HTML 5では、この形式ではキーごとに複数の値を禁止していません。実際、ページに同じname属性の複数のフィールドが(誤って)含まれている場合、ブラウザはキーごとに複数の値を生成する必要があります。goo.gl/uk1Agを
Daniel Cassidy

14
@アンナカタ:私のコメントは1年以上前(そして2年以上前の答えです!)ですが、NameValueCollectionはGetValues(key)メソッドを使用して、キーごとに複数の値をサポートしています。
Mauricio Scheffer、2011

4
@MauricioScheffer:しかし、NameValueCollectionは「正しく」クエリ文字列に変換されません。たとえば、同じキーが複数回存在するWebClientでQueryStringパラメータを設定すると、一般的な(標準の( ?)パターン。
デビッドポープ

8
キーごとの複数の値に関して、HTMLでは、複数の項目を選択して送信する複数選択リストボックスがある場合、Davidによって言及された複数の値の形式で送信されると思います。
サム

10
より移植性の高いHttpUtility.UrlEncodeの代わりにUri.EscapeDataStringを使用したい場合があります。stackoverflow.com/questions/2573290/…を
PEK 2014

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とWebで同様の問題の答えを検索した後、これは私が見つけた最も簡単な解決策です。

.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
あなたは、おそらくのIDictionaryインターフェイスにToURLQueryStringと呼ばれる拡張メソッドを作成することができます。public static string ToURLQueryString(this IDictionary dict) { ... }
ロイティンカー

65
このメソッドは、マルチバイト文字の標準に準拠していません。それらを%XX%XXではなく%uXXXXとしてエンコードします。結果のクエリ文字列は、Webサーバーによって誤って解釈される場合があります。これは、HttpUtility.ParseQueryString()によって返される内部フレームワーククラスHttpValueCollectionにも記載されています。コメントには、下位互換性の理由でこの動作が維持されると記載されています。
アレックス2012

25
HttpUtilityPraseQueryString( "")と新しいNameValueCollection()の間には重要な違いがあることに注意してください。HttpUtilityの結果のみがToString()をオーバーライドして適切なクエリ文字列を生成します
Frank Schwieterman

7
クエリ文字列に名前の複数のインスタンスが必要な場合はどうですか?たとえば、「type = 10&type = 21」のようになります。
Finster 2014年

7
@Finster Addメソッドを使用して、名前の複数のインスタンスをクエリ文字列に追加できます。つまりは、 queryString.Add("type", "1"); queryString.Add("type", "2"); 使用Add方法、おそらく実際にこの時間のすべてを行うための良い方法です。
jeremysawesome 2014年

94

Roy Tinkerのコメントからインスピレーションを得て、コードを簡潔かつクリーンに保つ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(name、Uri.EscapeDataString(value));
UfukHacıoğulları2013

2
この回答を改善していただきありがとうございます。マルチバイト文字の問題が修正されました。
UfukHacıoğulları2013

9
ちなみに、相対UriからUriBuilderをインスタンス化できないため、これは相対URLでは機能しません。
Yuriy Faktorovich 2013

1
重複を追加できないように削除キーを追加しました。dotnetfiddle.net/hTlyAd
Paul Totzke

29

私はしばらく前に同様の質問に答えました。基本的に、HttpValueCollectionASP.NETのRequest.QueryStringプロパティであるclassを使用するのが最善の方法ですが、残念ながら.NETフレームワークの内部にあります。Reflectorを使用してそれを取得できます(Utilsクラスに配置できます)。このように、NameValueCollectionのようにクエリ文字列を操作できますが、URLエンコード/デコードの問題はすべて処理されます。

HttpValueCollectionextends 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 2009

httpValueCollection.ToString()実際に呼び出すhttpValueCollection.ToString(true)ため、true明示を追加する必要はありません。
dav_i

5
HttpValueCollectionは内部クラスであるため、インスタンス化できません。
ozba 2016年

29

これは、同じキーの複数の値をサポートする拡張メソッド(以前の投稿の概念を組み合わせたもの)として流暢でラムダ風の方法です。私の個人的な好みは、他のチームメンバーがこのようなものを発見できるように、ラッパーよりも拡張機能です。エンコーディング方法、Stack Overflowに関する多くの投稿(そのような投稿の 1つ)、および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());
}

編集: nullサポート付きですが、特定の状況に合わせて調整する必要があります

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
値のいずれかがnullの場合、これは失敗します
Josh Noe

これは間違っています。キーと値のペアごとに多くのクエリ文字列が生成されます
Gayan

@GayanRanasinghe:それはどういう意味ですか?
Matti Virkkunen、2015

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

System.Webの下にあり、どこでも利用できないHttpUtilityを使用しないことが好きです。
Kugel

linqおよびHttpUtilityを使用しない場合は+1。空のsbを作成し、「bool first」変数を破棄し、ループ内でsb.AppendFormat()の前にsb.Append(sb.Length == 0? "?": "&")を指定します。nvcが空の場合、このメソッドは孤独な「?」ではなく空の文字列を返します。
Mathew Leger 2016

この回答は、複数の値を持つ単一のパラメーターを処理します。例:?id = 1&id = 3&id = 2&id = 9
Mathemats

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:単純な文字列ベースの拡張メソッド。他の回答の中には、より多くのエッジケースをカバーすることができるが、これは私のような状況のために十分であり、それが構築するために私を必要としないNameValueCollectionHttpValueCollectionまたはUri最初。ありがとう!
スタンリーG.

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 唯一の違いは、Systemへの参照を必要とする以外に、KeyValueペアの配列を使用することです。ネット(あなたが述べたようにPCLで利用可能です)これは、サードパーティのパッケージを含めたり、自家製のスパゲッティの混乱を一緒にしたりせずにそれを行う最も簡単な方法です。
ロストフ

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()s は必要ありません。
mpen 2013年

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"のような配列に対して完全に機能し、ところで非常に重要なパラメータの順序を維持します。
Soroush Falahati 2018年

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}」の形式は不必要に高価です:)
annakata 2009年

クラス名をQueryStringに変更しました。クエリは少しあいまいです
Nick Allen、

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

where句を使用して、文字列に追加するパラメーターを選択できます。


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を使用するコストと比較して、それを使用するコストは最小限です(Jeff Atwoodがこのトピックについて何かを投稿したと思います)。


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ペアのコレクションを受け入れます(例:Dictionary`2)。
  • string/objectペアのコレクションを受け入れます(例:RouteValueDictionary)。
  • 受け入れNameValueCollectionのは、秒。
  • クエリ値をキーでソートして、同じ値が同じ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/AnotherPathName?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が提案したソリューション(11年8月2日、7:29に回答)を使用しましたが、彼のソリューションはHttpUtilityを使用する必要がありません。ただし、Dotnetpearlsに投稿された記事によると、辞書の使用はNameValueCollectionの使用よりも(パフォーマンスの点で)高速です。以下は、NameValueCollectionの代わりにDictionaryを使用するように変更されたDSOのソリューションです。

    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

他の答えからのヒントのいくつかを使用して、かみそりプロジェクトのヘルパーを作成しました。

現在のリクエストのQueryStringオブジェクトを改ざんすることは許可されていないため、ParseQueryStringビジネスが必要です。

@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

以下のコードHttpValueCollectionToString、ILSpyを介しての実装から削除されたもので、name = valueクエリ文字列を提供します。

残念ながら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

そしてLINQなしのC#バージョン:

    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
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.