สร้างสตริงแบบสอบถามสำหรับ System.Net.HttpClient get

หากฉันต้องการส่งคำขอการรับ http โดยใช้ System.Net.HttpClient ดูเหมือนว่าไม่มี API ที่จะเพิ่มพารามิเตอร์การแก้ไขนี้ถูกต้องหรือไม่

มี api ง่าย ๆ ในการสร้างสตริงการสืบค้นที่ไม่เกี่ยวข้องกับการสร้างคอลเลกชันค่าชื่อและการเข้ารหัส url เหล่านั้นและจากนั้นก็เชื่อมต่อพวกเขาในที่สุด? ฉันหวังว่าจะใช้สิ่งที่ต้องการ API ของ RestSharp (เช่น AddParameter (.. ))

หากฉันต้องการส่งคำขอการรับ http โดยใช้ 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และทำสิ่งต่อไปนี้:

รุ่น keyvaluepair

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: อย่าใช้เวอร์ชันที่ยอมรับเนื่องจากใช้งานไม่ได้กับการจัดการอักขระ unicode และไม่ใช้ API ภายใน

ฉันพบปัญหาการเข้ารหัสสองครั้งที่แปลกจริง ๆ ด้วยวิธีการแก้ปัญหาที่ยอมรับ:

ดังนั้นหากคุณกำลังจัดการกับตัวละครที่จะต้องมีการเข้ารหัสโซลูชั่นที่ได้รับการยอมรับจะนำไปสู่การเข้ารหัสซ้ำ:

• พารามิเตอร์การสืบค้นจะถูกเข้ารหัสอัตโนมัติโดยใช้NameValueCollectionตัวจัดทำดัชนี ( และการใช้นี้UrlEncodeUnicodeไม่ได้คาดหวังอย่างสม่ำเสมอUrlEncode(!) )
• จากนั้นเมื่อคุณเรียกuriBuilder.Uriมันสร้างใหม่Uriโดยใช้ตัวสร้างซึ่งจะเข้ารหัสอีกครั้ง (การเข้ารหัส 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 / ถอดรหัสปกติ (ดูที่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

ในบรรทัดเดียวกับโพสต์ของ Rostov หากคุณไม่ต้องการรวมการอ้างอิงถึงSystem.Webในโครงการของคุณคุณสามารถใช้FormDataCollectionจาก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();

ขอบคุณ "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"