如何为HttpClient请求设置Content-Type头?
我正在尝试设置一个HttpClient
对象的Content-Type
头,如我所调用的API所要求的。
我尝试设置Content-Type
如下所示:
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"); // ... }
它允许我添加Accept
头,但是当我尝试添加Content-Type
,会抛出以下exception:
错误的标题名称。 确保请求头与
HttpRequestMessage
一起使用,使用HttpResponseMessage
响应头和使用HttpContent
对象的内容头。
如何在HttpClient
请求中设置Content-Type
标头?
内容types是内容的头部,而不是请求的头部,这就是失败的原因。 Robert Levybuild议的AddWithoutValidation
可以工作,但是您也可以在创build请求内容时自己设置内容types(请注意,代码段在两个地方添加了“application / json”(对于Accept和Content-Type标头):
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); });
对于那些没有看到约翰对卡洛斯解决scheme的评论…
req.Content.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");
如果你不介意一个小的库依赖, Flurl.Http [披露:我是作者]使这个超级简单。 它的PostJsonAsync
方法负责序列化内容和设置content-type
头,而ReceiveJson
反序列化响应。 如果需要accept
头文件,则需要自己设置,但Flurl也提供了一个相当干净的方法:
using Flurl.Http; var result = await "http://example.com/" .WithHeader("Accept", "application/json") .PostJsonAsync(new { ... }) .ReceiveJson<TResult>();
Flurl使用HttpClient和Json.NET,它是一个PCL,所以它可以在各种平台上工作。
PM> Install-Package Flurl.Http
尝试使用TryAddWithoutValidation
var client = new HttpClient(); client.DefaultRequestHeaders.TryAddWithoutValidation("Content-Type", "application/json; charset=utf-8");
调用AddWithoutValidation
而不是Add
(请参阅此MSDN链接 )。
另外,我猜你正在使用的API实际上只需要POST或PUT请求(不是普通的GET请求)。 在这种情况下,当您调用HttpClient.PostAsync
并传入HttpContent
,请在该HttpContent
对象的Headers
属性上进行设置。
.Net试图强迫你遵守某些标准,即只能在具有内容的请求(例如POST
, PUT
等)上指定Content-Type
标题。 因此,正如其他人已经指出的,设置Content-Type
头的首选方法是通过HttpContent.Headers.ContentType
属性。
这就是说,某些API(如2016-12-19的LiquidFiles Api )需要为GET
请求设置Content-Type
标头。 .Net将不允许在请求本身上设置这个头文件 – 即使使用TryAddWithoutValidation
。 此外,您不能为请求指定一个Content
– 即使它是零长度的。 我似乎能解决这个问题的唯一方法就是去反思。 代码(以防其他人需要它)是
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");
编辑:
如注释中所述,该字段在不同版本的dll中具有不同的名称。 在GitHub的源代码中 ,这个字段目前被命名为s_invalidHeaders
。 根据@David Thompson的build议,这个例子已经被修改来解释这个。
一些关于.NET Core的额外信息(在阅读erdomke关于设置私有字段以在没有内容的请求上提供内容types的post之后)…
在debugging我的代码后,我看不到通过reflection设置的私有字段 – 所以我想我会尝试重新创build问题。
我已经尝试使用.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;
而且,正如预期的那样,我收到了一个聚合exception,其内容是"Cannot send a content-body with this verb-type."
但是,如果我用.NET Core(1.1)做同样的事情 – 我没有得到一个例外。 我的请求很高兴地被我的服务器应用程序回答,内容types被拾取。
我对此感到惊喜,我希望它能帮助别人!