.Net WebApi 中的 FromBody FromForm FromQuery FromHeader FromRoute

• 2022 年 10 月 7 日
• 筆記
• c#

　　在日常後端Api開發中，我們跟前端的溝通中，通常需要協商好入參的數據類型，和參數是通過什麼方式存在於請求中的，是表單（form）、請求體（body）、地址欄參數（query）、還是說通過請求頭（header）。

　　當協商好後，我們的接口又需要怎麼去接收這些數據呢？很多小夥伴可能上手就是直接寫一個實體，作為 api 函數的入參，然後就愉快的編寫代碼了；前端調用時卻報 400 錯誤，可以說是一臉懵；當然，很多情況下這樣寫是不會報錯的，因為我們需要的數據，往往只會存在於一個地方，就是請求體（body），而我們的 .Net Core 又足夠的強大，導致本不嚴謹的操作卻不會發生 bug。

　　而當出現這樣的一個需求的時候，小夥伴們思考一下應該怎麼做：一個 Post 請求，參數分別放在了 地址欄（url?key=#$!fsefes&token……）、和請求體中（ {「name」:”小明”,””sex:”男”} ）；像這個需求我們的後端接口應該怎麼寫呢？下面我們嘗試一下不嚴謹的做法。

　　首先我們定義一個實體 Info

public class Info
{
    public string? Name { get; set; }

    public string? Sex { get; set; }
}

　　而又因為 Url 中的參數數量比較多，常規的一個做法，也是定義一個實體類去接收

public class Parameters
{
    public string? Key { get; set; }

    public string? Token { get; set; }

    public string? Time { get; set; }
}

　　然後編寫 Post 接口函數，非常簡單

[HttpPost]
public int Post(Parameters parameters, Info info)
{
    return 200;
}

　　我們直接 F5 把項目跑起來，你會發現，程序報錯了，因為程序分不清誰跟誰了

 　　而錯誤提示非常的清楚，你要使用 FromQuery 特性，現在我們給參數加上這個特性

[HttpPost]
public int Post([FromQuery]Parameters parameters, Info info)
{
    return 200;
}

　　再次啟動後，代碼不報錯了，我們看一下 swagger

　　由於我們給 parameters 參數加上了 FromQuery 的特性，所以程序就不懵了

　　下面給大家說下 FromBody FromForm FromQuery FromHeader FromRoute 的區別

　　FromBody：當請求的 content-type 為 application/json 時，可以不加上這個特性，因為當入參類型為實體類時，系統默認從請求體（body）中獲取數據，在這裡建議大家加上；

　　FromForm：當請求屬於表單提交，也就是 content-type 為 application/x-www-form-urlencoded，則必須給參數加上 FromForm 特性，否者會報 400 錯誤；

　　FromQuery：獲取地址爛參數，當接口參數是一個實體類時，建議必須加上該特性；

　　FromHeader：獲取請求頭參數；

　　FromRoute：獲取路由參數，這個可能有些小夥伴會很疑惑，我貼出個代碼大家就懂了：

[HttpPost("{id}")]
public int Post([FromRoute]string id, [FromQuery]Parameters parameters, Info info)
{
    return 200;
}

 　　好了，本文到此結束，感謝大佬們的觀看，謝謝！

原文鏈接：//www.cnblogs.com/ysmc/p/16758995.html