Làm cách nào để bạn đặt tiêu đề Kiểu Nội dung cho yêu cầu HttpClient?

Tôi đang cố gắng đặt Content-Typetiêu đề của một HttpClientđối tượng theo yêu cầu của API mà tôi đang gọi.

Tôi đã thử thiết lập Content-Typenhư dưới đây:

using (var httpClient = new HttpClient())
{
    httpClient.BaseAddress = new Uri("http://example.com/");
    httpClient.DefaultRequestHeaders.Add("Accept", "application/json");
    httpClient.DefaultRequestHeaders.Add("Content-Type", "application/json");
    // ...
}

Nó cho phép tôi thêm Accepttiêu đề nhưng khi tôi cố gắng thêm Content-Typenó sẽ ném ngoại lệ sau:

Tên tiêu đề sử dụng sai. Đảm bảo các tiêu đề yêu cầu được sử dụng với HttpRequestMessage, các tiêu đề phản hồi HttpResponseMessagevà các tiêu đề nội dung với HttpContentcác đối tượng.

Làm cách nào để đặt Content-Typetiêu đề trong HttpClientyêu cầu?

Loại nội dung là một tiêu đề của nội dung, không phải của yêu cầu, đó là lý do tại sao điều này là thất bại. AddWithoutValidationnhư được đề xuất bởi Robert Levy có thể hoạt động, nhưng bạn cũng có thể đặt loại nội dung khi tự tạo nội dung yêu cầu (lưu ý rằng đoạn mã thêm "application / json" ở hai vị trí - cho các tiêu đề Chấp nhận và Loại nội dung):

HttpClient client = new HttpClient();
client.BaseAddress = new Uri("http://example.com/");
client.DefaultRequestHeaders
      .Accept
      .Add(new MediaTypeWithQualityHeaderValue("application/json"));//ACCEPT header

HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Post, "relativeAddress");
request.Content = new StringContent("{\"name\":\"John Doe\",\"age\":33}",
                                    Encoding.UTF8, 
                                    "application/json");//CONTENT-TYPE header

client.SendAsync(request)
      .ContinueWith(responseTask =>
      {
          Console.WriteLine("Response: {0}", responseTask.Result);
      });

Đối với những người không thấy Johns bình luận về giải pháp carlos ...

req.Content.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");

Nếu bạn không bận tâm đến một sự phụ thuộc thư viện nhỏ, Flurl.Http [tiết lộ: Tôi là tác giả] làm cho điều này trở nên đơn giản. PostJsonAsyncPhương pháp của nó đảm nhiệm cả việc tuần tự hóa nội dung và thiết lập content-typetiêu đề, và giải tuần tự hóa ReceiveJsonphản hồi. Nếu accepttiêu đề là bắt buộc, bạn sẽ cần phải tự đặt nó, nhưng Flurl cũng cung cấp một cách khá rõ ràng để làm điều đó:

using Flurl.Http;

var result = await "http://example.com/"
    .WithHeader("Accept", "application/json")
    .PostJsonAsync(new { ... })
    .ReceiveJson<TResult>();

Flurl sử dụng HttpClient và Json.NET trong phần mềm và đó là PCL nên nó sẽ hoạt động trên nhiều nền tảng khác nhau.

PM> Install-Package Flurl.Http

thử sử dụng TryAddWithoutValidation

  var client = new HttpClient();
  client.DefaultRequestHeaders.TryAddWithoutValidation("Content-Type", "application/json; charset=utf-8");

Net cố gắng để buộc bạn phải tuân theo các tiêu chuẩn nhất định, cụ thể là các Content-Typetiêu đề chỉ có thể được xác định trên yêu cầu có nội dung (ví dụ POST, PUTvv). Do đó, như những người khác đã chỉ ra, cách ưa thích để đặt Content-Typetiêu đề là thông qua thuộc HttpContent.Headers.ContentTypetính.

Như đã nói, một số API nhất định (như LiquidFiles Api , kể từ 2016-12-19) yêu cầu đặt Content-Typetiêu đề cho GETyêu cầu. .Net sẽ không cho phép đặt tiêu đề này cho chính yêu cầu - ngay cả khi sử dụng TryAddWithoutValidation. Hơn nữa, bạn không thể chỉ định một Contentyêu cầu - ngay cả khi nó có độ dài bằng không. Cách duy nhất tôi có thể có được xung quanh điều này là dùng đến sự phản chiếu. Mã (trong trường hợp một số người khác cần nó) là

var field = typeof(System.Net.Http.Headers.HttpRequestHeaders)
    .GetField("invalidHeaders", System.Reflection.BindingFlags.NonPublic | System.Reflection.BindingFlags.Static) 
  ?? typeof(System.Net.Http.Headers.HttpRequestHeaders) 
    .GetField("s_invalidHeaders", System.Reflection.BindingFlags.NonPublic | System.Reflection.BindingFlags.Static);
if (field != null)
{
  var invalidFields = (HashSet<string>)field.GetValue(null);
  invalidFields.Remove("Content-Type");
}
_client.DefaultRequestHeaders.TryAddWithoutValidation("Content-Type", "text/xml");

Biên tập:

Như đã lưu ý trong các bình luận, trường này có các tên khác nhau trong các phiên bản khác nhau của dll. Trong mã nguồn trên GitHub , trường hiện được đặt tên s_invalidHeaders. Ví dụ đã được sửa đổi để giải thích cho điều này theo gợi ý của @David Thompson.

Một số thông tin bổ sung về .NET Core (sau khi đọc bài đăng của erdomke về việc đặt trường riêng để cung cấp loại nội dung theo yêu cầu không có nội dung) ...

Sau khi gỡ lỗi mã của tôi, tôi không thể thấy trường riêng được đặt thông qua sự phản chiếu - vì vậy tôi nghĩ tôi sẽ cố gắng tạo lại vấn đề.

Tôi đã thử đoạn mã sau bằng .Net 4.6:

HttpRequestMessage httpRequest = new HttpRequestMessage(HttpMethod.Get, @"myUrl");
httpRequest.Content = new StringContent(string.Empty, Encoding.UTF8, "application/json");

HttpClient client = new HttpClient();
Task<HttpResponseMessage> response =  client.SendAsync(httpRequest);  //I know I should have used async/await here!
var result = response.Result;

Và, như mong đợi, tôi nhận được một ngoại lệ tổng hợp với nội dung "Cannot send a content-body with this verb-type."

Tuy nhiên, nếu tôi làm điều tương tự với .NET Core (1.1) - tôi không có ngoại lệ. Yêu cầu của tôi đã được ứng dụng máy chủ của tôi trả lời khá vui vẻ và loại nội dung đã được chọn.

Tôi đã rất ngạc nhiên về điều đó, và tôi hy vọng nó sẽ giúp được ai đó!

Gọi AddWithoutValidationthay vì Add(xem liên kết MSDN này ).

Ngoài ra, tôi đoán API bạn đang sử dụng thực sự chỉ yêu cầu điều này cho các yêu cầu POST hoặc PUT (không phải các yêu cầu GET thông thường). Trong trường hợp đó, khi bạn gọi HttpClient.PostAsyncvà chuyển qua một HttpContent, hãy đặt cái này vào thuộc Headerstính của HttpContentđối tượng đó .

Dành cho những ai gặp rắc rối với charset

Tôi đã có một trường hợp rất đặc biệt là nhà cung cấp dịch vụ không chấp nhận bộ ký tự và họ từ chối thay đổi cấu trúc con để cho phép nó ... Thật không may, httpClient đã tự động đặt tiêu đề thông qua StringContent, và bất kể bạn có chuyển null hay Encoding.UTF8 không nó sẽ luôn đặt bộ ký tự ...

Hôm nay tôi đã ở rìa để thay đổi hệ thống phụ; chuyển từ httpClient sang bất cứ thứ gì khác, rằng một cái gì đó xuất hiện trong tâm trí tôi ..., tại sao không sử dụng sự phản chiếu để làm trống "bộ ký tự"? ... Và trước khi tôi thử nó, tôi đã nghĩ ra một cách, "có lẽ tôi có thể thay đổi nó sau khi khởi tạo", và điều đó đã hiệu quả.

Đây là cách bạn có thể đặt tiêu đề "application / json" chính xác mà không cần "; charset = utf-8".

var jsonRequest = JsonSerializeObject(req, options); // Custom function that parse object to string
var stringContent = new StringContent(jsonRequest, Encoding.UTF8, "application/json");
stringContent.Headers.ContentType.CharSet = null;
return stringContent;

Lưu ý: Các nullgiá trị trong sau đây sẽ không làm việc, và append "; charset = utf-8"

return new StringContent(jsonRequest, null, "application/json");

BIÊN TẬP

@DesertFoxAZ đề xuất rằng cũng có thể sử dụng đoạn mã sau và hoạt động tốt. (không tự kiểm tra)

stringContent.Headers.ContentType = new MediaTypeHeaderValue("application/json");

var content = new JsonContent();
content.Headers.ContentType = new MediaTypeHeaderValue("application/json");
content.Headers.ContentType.Parameters.Add(new NameValueHeaderValue("charset", "utf-8"));
content.Headers.ContentType.Parameters.Add(new NameValueHeaderValue("IEEE754Compatible", "true"));

Đó là tất cả những gì bạn cần.

Với việc sử dụng Newtonsoft.Json, nếu bạn cần một nội dung dưới dạng chuỗi json.

public class JsonContent : HttpContent
   {
    private readonly MemoryStream _stream = new MemoryStream();
    ~JsonContent()
    {
        _stream.Dispose();
    }

    public JsonContent(object value)
    {
        Headers.ContentType = new MediaTypeHeaderValue("application/json");
        using (var contexStream = new MemoryStream())
        using (var jw = new JsonTextWriter(new StreamWriter(contexStream)) { Formatting = Formatting.Indented })
        {
            var serializer = new JsonSerializer();
            serializer.Serialize(jw, value);
            jw.Flush();
            contexStream.Position = 0;
            contexStream.WriteTo(_stream);
        }
        _stream.Position = 0;

    }

    private JsonContent(string content)
    {
        Headers.ContentType = new MediaTypeHeaderValue("application/json");
        using (var contexStream = new MemoryStream())
        using (var sw = new StreamWriter(contexStream))
        {
            sw.Write(content);
            sw.Flush();
            contexStream.Position = 0;
            contexStream.WriteTo(_stream);
        }
        _stream.Position = 0;
    }

    protected override Task SerializeToStreamAsync(Stream stream, TransportContext context)
    {
        return _stream.CopyToAsync(stream);
    }

    protected override bool TryComputeLength(out long length)
    {
        length = _stream.Length;
        return true;
    }

    public static HttpContent FromFile(string filepath)
    {
        var content = File.ReadAllText(filepath);
        return new JsonContent(content);
    }
    public string ToJsonString()
    {
        return Encoding.ASCII.GetString(_stream.GetBuffer(), 0, _stream.GetBuffer().Length).Trim();
    }
}

Ok, nó không phải là HTTPClient nhưng nếu bạn có thể sử dụng nó, WebClient khá dễ dàng:

using (var client = new System.Net.WebClient())
 {
    client.Headers.Add("Accept", "application/json");
    client.Headers.Add("Content-Type", "application/json; charset=utf-8");
    client.DownloadString(...);
 }

Bạn có thể sử dụng nó sẽ được làm việc!

HttpRequestMessage msg = new HttpRequestMessage(HttpMethod.Get,"URL");
msg.Content = new StringContent(string.Empty, Encoding.UTF8, "application/json");

HttpResponseMessage response = await _httpClient.SendAsync(msg);
response.EnsureSuccessStatusCode();

string json = await response.Content.ReadAsStringAsync();

Tôi thấy nó đơn giản và dễ hiểu nhất theo cách sau:

async Task SendPostRequest()
{
    HttpClient client = new HttpClient();
    var requestContent = new StringContent(<content>);
    requestContent.Headers.ContentType = new MediaTypeHeaderValue("application/json");
    var response = await client.PostAsync(<url>, requestContent);
    var responseString = await response.Content.ReadAsStringAsync();
}
...

SendPostRequest().Wait();

Bạn cần làm như thế này:

    HttpContent httpContent = new StringContent(@"{ the json string }");
    httpContent.Headers.ContentType = new MediaTypeHeaderValue("application/json");
    client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));                
    HttpResponseMessage message = client.PostAsync(@"{url}", httpContent).Result;