我又踩坑了！如何為HttpClient請求設(shè)置Content-Type標(biāo)頭？
本文轉(zhuǎn)載自微信公眾號「Dotnet Plus」，作者小碼甲 。轉(zhuǎn)載本文請聯(lián)系Dotnet Plus公眾號。
最近在重構(gòu)認(rèn)證代碼，認(rèn)證過程相當(dāng)常規(guī)：
- POST /open-api/v1/user-info?client_id&timstamp&rd=12345&sign=***&method=hmac
- content-type: application/json
- payload: { "token":"AA2917B0-C23D-40AB-A43A-4C4B61CC7C74"}
平臺顯示 ：簽名校驗失敗， 排查到平臺收到的Post Payload并非預(yù)期，閱讀本文，解鎖正確使用Content-Type標(biāo)頭的姿勢。
1. 入坑
下面是構(gòu)造HttpClient對象、發(fā)起請求的代碼：
- // 初始化HttpClientFactory
- context.Services.AddHttpClient("platform", c =>
- {
- c.BaseAddress = new Uri("https://alpha-engage.demohost.com/");
- c.DefaultRequestHeaders.Accept
- .Add(new MediaTypeWithQualityHeaderValue("application/json"));
- })...
- // 產(chǎn)生命名HttpClient，發(fā)起請求
- var client = _clientFactory.CreateClient("platform");
- var response = await client.PostAsync($"open-api/v1/user-token/info?{req.AuthString()}",new StringContent(req.ReqPayload.ToString(),Encoding.UTF8) );
平臺日志顯示，收到的請求payload：
- {\"token\":\"AA2917B0-C23D-40AB-A43A-4C4B61CC7C74\"}
額，平臺收到的JSON數(shù)據(jù)被轉(zhuǎn)碼了，沒有識別出JSON?
明眼人一看，HttpClient請求沒有設(shè)置Content-Type，接收端沒有識別出JSON 格式的payload , 進(jìn)行了轉(zhuǎn)碼，生成了錯誤簽名。
① Content-Type是一個Entity Header，指示資源的mediaType ，可用在請求/響應(yīng)中
② 代碼中new StringContent(req.ReqPayload.ToString(),Encoding.UTF8) 沒有指定mediaType參數(shù)，故函數(shù)會使用text/plain默認(rèn)值
------------------------------------------
當(dāng)我嘗試添加Content-Type時(下面黃色背景行代碼):
- context.Services.AddHttpClient("platform", c =>
- {
- c.BaseAddress = new Uri("https://alpha-engage.demohost.com/");
- c.DefaultRequestHeaders.Accept
- .Add(new MediaTypeWithQualityHeaderValue("application/json"));//ACCEPT header
- c.DefaultRequestHeaders.Add("content-type", "application/json");
- })
此時拋出以下異常：
- InvalidOperationException: Misused header name. Make sure request headers are used with
- HttpRequestMessage, response headers with HttpResponseMessage, and
- content headers with HttpContent objects.
納尼，HttpContent Headers是啥?Chrome dev tools顯示只有兩種Header啊?
2. 爬坑
| --- | 信息 | 舉例 | .NET類型 |
|---|---|---|---|
| General Header | 可同時作用在請求/響應(yīng)中，但是與傳輸數(shù)據(jù)無關(guān) | Upgrade、Connection | --- |
| Request Header | 將要獲取的資源或客戶端本身的信息 | Accept、 Authorization |
HttpRequestHeaders |
| Response Header | 響應(yīng)信息 | Location、ETag | HttpResponseHeaders |
| Entity Header |
實體Body額外的信息 | Content-Length、 Connection |
HttpContentHeaders |
Content-Type屬于Entity Header的一種，對應(yīng).NET類型 HttpContent Header;
雖然Entity Header不是請求標(biāo)頭也不是響應(yīng)標(biāo)頭，它們還是會包含在請求/響應(yīng)標(biāo)頭術(shù)語中(此說法來自官方)。
所以我們在Chrome DevTools沒有看到Entity Headers分組, 卻常在請求/響應(yīng)標(biāo)頭中看到Content-Type標(biāo)頭。
回到上面的異常，.NET 嚴(yán)格區(qū)分四種標(biāo)頭，所以c.DefaultRequestHeaders.Add("content-type", "application/json") 嘗試將content-type添加到請求頭，姿勢不正確，.NET提示InvalidOperationException。
3. 填坑
給這個常規(guī)的Post請求設(shè)置正確的Content-Type標(biāo)頭。
方法① 對HttpRequestMessage對象Content屬性添加Header
- using (var request = new HttpRequestMessage())
- {
- request.Method = new HttpMethod(method);
- request.RequestUri = new Uri(url);
- request.Content = new StringContent(payload);
- request.Content.Headers.ContentType = new MediaTypeHeaderValue("application/json");
- var response = await _httpClient.SendAsync(request);
- return response;
- }
使用HttpClient.SendAsync(request)
方法② 寫入HttpContent時傳入媒體類型
StringContent某個重載構(gòu)造函數(shù) : 參數(shù)3 可直接設(shè)置media type，
- var response = await client.PostAsync($"open-api/v1/user-token/info?{req.AuthString()}",new StringContent(req.ReqPayload.ToString(),Encoding.UTF8,"application/json") );
