轉載地址:https://www.cnblogs.com/wangjiming/p/8378108.html
閱讀目錄
一 概述
二 Get
1 基礎數據類型
1.1 方法只含一個形參
1.2 方法含多個形參
2 實體對象類型
3 實體對象和基礎數據類型混合
4 最小滿足原則
5 url長度限制
6 Get規範化
7 關於實體作爲參數傳遞的拓展
7.1 藉助[FromUri]特性傳遞實體
7.2 系列化和反系列化傳遞實體
三 Post
1 基本數據類型傳遞
1.1 [FromBody]單個參數傳遞
1.2 Dynamic單個參數傳遞
2 實體作爲參數傳遞
3 實體集合作爲參數傳遞
4 數組作爲參數傳遞
5 小結
四 總結
一 概述
一般地,我們在研究一個問題時,常規的思路是爲該問題建模;我們在研究相似問題時,常規思路是找出這些問題的共性和異性。基於該思路,我們如何研究WebApi參數傳遞問題呢?
首先,從參數本身來說,種類較爲多(如int,double,float,string,array,Object等),且有些類型較爲複雜(如值類型和引用類型的機制等);
其次,從基於WebApi的Http請求方法來說,種類多且不盡相同(如Get,post,Delete,put,head等),在上一篇文章 :【WebApi系列】淺談HTTP在WebApi開發中的運用 中,我們簡要描述了Http請求的20個方法;
……….
如此複雜且不盡相同,關於WebApi參數傳遞,我們該選擇什麼作爲切入點來研究呢?基於我們上面提到的研究思路,我們想到了.NET Framework框架,那麼,我們來看看基於.NET Framework框架的的WebApi
模板是怎樣的呢?
請按圖中步驟操作
我們來看看Values控制器是怎樣的
1 public class ValuesController : ApiController
2 {
3 // GET api/values
4 public IEnumerable<string> Get()
5 {
6 return new string[] { "value1", "value2" };
7 }
8
9 // GET api/values/5
10 public string Get(int id)
11 {
12 return "value";
13 }
14
15 // POST api/values
16 public void Post([FromBody]string value)
17 {
18 }
19
20 // PUT api/values/5
21 public void Put(int id, [FromBody]string value)
22 {
23 }
24
25 // DELETE api/values/5
26 public void Delete(int id)
27 {
28 }
29 }
**從Values控制器,我們不難得出如下幾個結論:
(1)WebApi常規方法爲四個:Get,Post,Put和Delete;
(2)四種方法的參數可歸結爲兩大類:url傳遞(Request-url)和Body(Request-body)傳遞;
(3)基於(2),我們將四種方法的參數傳遞歸爲兩大類,而這兩大類又集中在Get和Post中體現了(Put是Get和Post的組合,Delete與Get類似);
其實,分析到現在,我們很容易找得到了研究WebApi參數傳遞的切入點?研究Get和Post方法參數傳遞即可。是的,沒錯,我們本篇文章就是基於Get和Post方法的參數傳遞,前者對應Request-url,後者對應Reqeust-Body。**
二 Get
1 基礎數據類型
1.1 方法只含一個形參(參數傳得進去)
ajax
複製代碼
$(document).ready(function () {
$("#FindProdcutDetail").click(function () {
$.ajax({
type: "Get",
//url: "/api/Default/GetProductDetails?ProductCode=JX80869"
url: "/api/Default/GetProductDetails",
data: { "ProductCode":"JX80869"}
})
})
})
複製代碼
Result
**總結
(1)當Get方法形參爲一個且爲基本數據類型時,Get方法能接受外部傳遞的值
(2)Get傳值的本質是通過url字符串拼接,如上兩兩種url形式的傳遞的結果都是一樣**
url形式1
url: “/api/Default/GetProductDetails?ProductCode=JX80869”
url形式2
url: “/api/Default/GetProductDetails”,
data: { “ProductCode”:”JX80869”}
我們用Goole Chrome來看看結果,發現url形式1和url形式2均一致
(3)Get傳遞參數本質是url字符串拼接,Request-Head頭部傳遞,Request-Body中不能傳遞(這是與Post方法的本質區別),我們舉兩個例子
例子1:我們將形參添加[FromBody]屬性後,值傳遞不進去
例子2:我們用PostMan來測試,發現PostMan中,Get方法參數Body爲灰色,是不能選中的
1.2 方法含有多個形參(參數傳得進去)
複製代碼
$(document).ready(function () {
$("#FindProdcutDetail").click(function () {
$.ajax({
type: "Get",
url: "/api/Default/GetProductDetails",
data: { "ProductCode": "JX80869","ProductName":"YaGao"}
})
})
})
複製代碼
result
2 實體對象類型(參數傳不進去)
model
複製代碼
1 public class ProductDetail
2 {
3 //產品編碼
4 [Required]
5 public string ProductCode { get; set; }
6 //產品名稱
7 [Required]
8 public string ProductName { get; set; }
9 //產品價格
10 [Required]
11 public double ProductPrice{ get; set; }
12 }
複製代碼
ajax
複製代碼
$(document).ready(function () {
var productDetail = { "ProductName": "YaGao", "ProductCode": "JX80869", "ProductPrice": 40.5};
$("#FindProdcutDetail").click(function () {
$.ajax({
type: "Get",
url: "/api/Default/ProductDetails",
data: productDetail
})
})
})
複製代碼
result:
分析
3 實體對象和基礎數據類型混合(實體傳不進去,基礎數據能傳遞進去)
ajax
複製代碼
1 $(document).ready(function () {
2 $("#FindProdcutDetail").click(function () {
3 $.ajax({
4 type: "Get",
5 url: "/api/Default/GetProductDetails",
6 data: { "_productDetail": "ObjectEntity","ProductName":"YaGao"}
7 })
8 })
9 })
複製代碼
result
4 最小滿足原則(參數傳得進去)
所謂“最小滿足原則”,指外部參數必須至少滿足被調用方法的形參(形參個數,形參類型和形參名字),換句話說,被調用方法具有的形參,外部參數必須傳遞進來,被調用方法沒有
的形參,外部參數傳遞與否都可以,否則將會產生狀態碼404錯誤,用數學集合的思路來理解的話,被調用方法的形參相當於外部參數的子集。如下例子,我們舉一個真子集的例子,
即外部傳遞參數的個數大於被調方法的的形參個數。
Ajax
複製代碼
$(document).ready(function () {
$("#FindProdcutDetail").click(function () {
$.ajax({
type: "Get",
url: "/api/Default/GetProductDetails",
data: {"ProductCode": "JX00034", "ProductName": "YaGao", "ProductPrice": 20.5, "PrudcutType": "Daily Necessities"}
})
})
})
複製代碼
result
分析:主要原因是路由規則,路由從url裏面取參數與aciton參數匹配,直到匹配滿足爲止,具體詳細深入內容,在【WebApi系列】路由章節分析。
5 url長度限制
url參數長度是有一定限制的,當超過一定長度,會報404錯誤
ajax
複製代碼
$(document).ready(function () {
$("#FindProdcutDetail").click(function () {
$.ajax({
type: "Get",
url: "/api/Default/GetProductDetails",
data: {
"ProductCode": "JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +
"JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +
"JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +
"JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +
"JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +
"JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +
"JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +
"JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +
"JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +
"JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +
"JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +
"JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +
"JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +
"JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +
"JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +
"JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +
"JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +
"JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +
"JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +
"JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +
"JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +
"JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +
"JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +
"JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +
"JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" +
"JX00034xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
})
})
})
複製代碼
result
6 Get規範化
關於Get類型規範化,應注意兩點,避免不必要的錯誤或異常:(1)方法的命名儘量採用:“Get+方法名”的形式 (2)在每個方法上加上特性[HttpGet]。
例子:我們去掉[HttpGet]特性和方法前的Get,看看情況什麼怎樣的
ajax
複製代碼
$(document).ready(function () {
$("#FindProdcutDetail").click(function () {
$.ajax({
type: "Get",
url: "/api/Default/ProductDetails",
data: {"ProductCode": "JX00034 "}
})
})
})
複製代碼
Controller
複製代碼
1 public class DefaultController : ApiController
2 {
3 4 //[HttpGet]
5 public string ProductDetails(string ProductCode)
6 {
7 return "values";
8 }
9 }
複製代碼
Result
7 關於實體作爲參數傳遞的拓展
7.1 藉助[FromUri]特性傳遞實體
ajax
複製代碼
$(document).ready(function () {
var GetEntityParam = { "ProductName": "YaGao", "ProductCode": "JX80869", "ProductPrice": 40.5};
$("#FindProdcutDetail").click(function () {
$.ajax({
type: "Get",
url: "/api/Default/ProductDetails",
data: GetEntityParam
})
})
})
複製代碼
result
7.2 系列化與反系列化傳遞實體
ajax
複製代碼
$(document).ready(function () {
$("#FindProdcutDetail").click(function () {
$.ajax({
type: "Get",
url: "/api/Default/ProductDetails",
data: { "productDetail": JSON.stringify({ "ProductName": "YaGao", "ProductCode": "JX80869", "ProductPrice": 40.5 }) }
})
})
})
複製代碼
result
***8 小結
(1)Get參數傳遞的本質是url字符串拼接;
(2)url字符串長度受限制;
(3)Get參數傳遞在Http請求頭部傳遞,而不支持Request-Body傳遞;
(4)Get類型的方法支持參數爲基本類型,不支持實體類型;
(5)Get類型的方法命名,應儘量採用“Get+方法名”的命名方式,且習慣性地在方法前加上[HttpGet特性];
(6)實參與形參的匹配,遵循路由規則;
(7)Get對應DB的Select操作,從這一點來理解,就知道爲什麼Http不支持實體對象傳遞的合理性了,因爲一般情況,我們都是通過簡單的字段查詢信息(對應基本類型),
如ID號,用戶名等,而不會通過一個實體查詢數據;*
三 Post
1 基本數據類型傳遞
1.1 [FromBody]單個參數傳遞
ajax
result
1.2 dynamic單個參數傳遞
ajax
複製代碼
(“#FindProdcutDetail”).click(function () {
$.ajax({
type: “Post”,
contentType: ‘application/json’,
url: “/api/Default/PostParamToProducts”,
data: JSON.stringify({“ProductCode”:”JX00039”})
})
})
})
複製代碼
result
Googel Chrome查看
2 實體作爲參數傳遞
ajax
複製代碼
(“#FindProdcutDetail”).click(function () {
$.ajax({
type: “Post”,
url: “/api/Default/PostParamToProducts”,
data: { “ProductCode”: “JX00036”,”ProductName”:”YaGao”,”ProductPrice”:20.5}
})
})
})
複製代碼
result
我們用Googel Chrome看看
3 實體集合作爲參數傳遞
ajax
複製代碼
(“#FindProdcutDetail”).click(function () {
$.ajax({
type: “Post”,
contentType: ‘application/json’,
url: “/api/Default/PostParamToProducts”,
data: JSON.stringify(list_ProductDetail)
})
})
})
複製代碼
result
Google Chrome 查看
4 數組作爲參數傳遞
ajax
複製代碼
(“#FindProdcutDetail”).click(function () {
$.ajax({
type: “Post”,
contentType: ‘application/json’,
url: “/api/Default/PostParamToProducts”,
data: JSON.stringify(arr)
})
})
})
複製代碼
Result
我們用Google Chrome看看
***5 小結
(1)Post參數傳遞本事是在Request-Body內傳遞,而Get參數傳遞本質是url拼接;
(2)Post參數傳遞不是key/value形式,而Get參數是key/value形式;
(3)Post傳遞參數時,無論是單個參數還是對象,均藉助[FromBody]特性(當然,某些情況去掉[FromBody]特性也可把值傳遞進去,但未了規範化,儘量加上該特性);
(4)Post沒長度限制,而Get有長度限制(一般爲1024b);
(5)Post相對Get,較安全;
(6)Post操作相當於DB的Insert操作;*
四 總結
***1.雖然HTTP請求方法有20多種,常用的大致爲4種,即Get,Post,Put,Delete(當然,像Trace,Head等也常用);
2.Get,Post,Put,Delete分別對應DB的Select,Insert,Update和Delete操作;
3.WebApi參數類型,大致分爲基本數據類類型和對象數據類型(當然你也可以理解爲抽象數據類型);
4.研究WebApi參數傳遞,只需研究Get和Post即可,因爲其他http方法參數傳遞基本都是有這兩種組合而成(如Put有Get和Post組合而成),或者相似(如Delete與Get相似);
5.對於控制器方法,儘量參照規範格式寫,如在相應控制器方法上加上對應的htt請求(Get對應[HttpGet],Post對應[HttpPost]),方法名儘量採用“Http請類型+方法名”格式(如Get請求,建議採用Get+MethodName;Post請求對應Post+MethodName);
6.WebApi參數請求,大致分爲兩大類型,即Request-url和Request-body;
7.文中我們還簡要分析了Get和Post區別;
8.關於如何設計一個良好的接口,在文章中,我們觸及了一下,但未研究,會在後續的文章中單獨分析;*