asp .net core Get raw request.

DogTwo發表於2018-12-26

  小弟初來乍到，分享一些工作學習中遇到的問題和解決方式，如有不準確或是有錯誤的地方，希望不吝賜教，謝過了。  –Dogtwo

背景：
一個代理伺服器BK，接收前端A傳送的請求，記錄log，並轉發給另外的伺服器B。
請求中有類似這樣的模組:
Person：
{
　　name:abc,
　　age: 20,
　　address:
　　{
　　　　home: xxx,
　　　　company: yyy
　　}
}
其中home,company以及address為可選欄位，伺服器B要求如果為空則不傳遞該欄位。
對於前端A來說，如果客戶沒有填入某欄位則json中將不包含該欄位。
例如若不包含home，則前端A的request中內容為：
Person：
{
　　name:abc,
　　age: 20,
　　address:
　　{
　　　　company: yyy
}
}
前文所述，A的請求會經過BK再轉發給B,BK使用ASP.NETCORE，讀取A傳送來的請求方式如下
public Task Test([FromBody] Model model)
框架本身已經封裝很好，會將request.body中內容自動轉化為model物件。對於可選欄位home來說，如果前端未傳送，
則model.person.address.home的值為””。若請求中address整體都未傳送，則model.address為null.

一般來說，這樣的處理不會有什麼問題。但這次的坑中，我們需要把model再當作內容轉發給B,原來使用的方法為
(RestRequest) request.addJsonBody(model);

此時會使A傳送的請求與B接收的請求出現差異！
此時會使A傳送的請求與B接收的請求出現差異！
此時會使A傳送的請求與B接收的請求出現差異！（重要的事情說三遍）

例如
A傳送的：
Person：
{
　　name:abc,
　　age: 20
}
B接收的：
Person：
{
　　name:abc,
　　age: 20,
　　address:null
}

對於基本型別，若某欄位可選我們可以這樣處理
public int？ a { get; set; }
對於內嵌的address來說，經由BK處理後無法取消掉address。(或者是我沒找到方法，有辦法的話請不吝賜教)

解決辦法：
既然框架轉化的model不能滿足要求，第一思路是直接去取原生的request來獲取request.body，轉發給B.
但此時在方法為取到的request.body中內容居然為””。明明可以通過[FromBody]來獲取model，直接取原生內容居然為空，很費解.
網路求助後發現：
ASP NET Core不允許我們僅僅通過方法引數以任何有意義的方式捕獲“原始”資料。因此我們需要通過處理Request.Body來獲取原始資料，然後反序列化它。

我們可以捕獲原始的Request.Body並從原始緩衝區中讀取引數。最簡而有效的方法是接受不帶引數的POST或PUT資料，然後從Request.Body讀取原始資料：
例：

 1 [HttpPost("api/blog/jsonstring")]
 2 public async Task Index()
 3 {
 4     var result = string.Empty;
 5 
 6     using (var reader = new StreamReader(Request.Body,Encoding.UTF8))
 7     {
 8         result = await reader.ReadToEndAsync();
 9     }
10 
11     return result;
12 }

 

但在該專案中，使用上述程式碼取得的result仍為空,筆者程式碼類似於：

 1 [HttpPost("api/blog/jsonstring")]
 2 public async Task Index([FromBody] Model model)
 3 {
 4 　　var result = string.Empty;
 5 
 6 　　using (var reader = new StreamReader(Request.Body, Encoding.UTF8))
 7 　　{
 8 　　　　result = await reader.ReadToEndAsync();
 9 　　}
10 
11 　　return result;
12 }

 

區別在於多了這個[FromBody] Model model，將其去掉之後result可以成功取得對應值。
繼續求助網路發現：
ASP.NET Core 中的 Request.Body 雖然是一個 Stream ，但它是一個與眾不同的 Stream —— 不允許 Request.Body.Position=0 ，這就意味著只能讀取一次。
解決辦法為
引用名稱空間 Microsoft.AspNetCore.Http.Internal ，呼叫方法 Request.EnableRewind() (但嘗試時該方法無效，需要進一步研究)

另外，成功取得request.body值以後要用這個方法將其加入到新的request中：
request.AddParameter("application/json", result, ParameterType.RequestBody);

參考:
1. ASP.NET Core Web API獲取原始請求內容
2. ASP.NET Core 中讀取 Request.Body 的正確姿勢
3.Returning only useful fields from the API && Consuming an API that accepts a comma-separated list of fields.

相關文章