Asp.netCore RESTful WebApi 小結-有解無憂

上篇文章記錄了WebApi的概念以及簡單的認知WebApi ，今天來探究下它的適用場景以及怎么去用它，

　　先簡單聊一下WebApi與用得比較多的WCF、WebService各自的特點：

　　一、WebService是一種可以接收從Internet或者Intranet上的其它系統中傳遞過來的請求，輕量級的獨立的通訊技術，它的特點有：

　　1、基于SOAP協議的，資料格式是XML；

　　 2、web Service 最大的優勢便是跨平臺的可互操作性；

　　 3、支持Http協議Xml技術的設備即可擁有并且訪問web Service，但只能部署在IIS上；

　　 4、一些只需要與本機上的其余程式通訊的應用程式則不適合用web Service，理由并非技術上無法實作，而是消耗過大沒有任何好處，

　　二、WCF是提供統一的，可用于建立安全、可靠的面向服務的應用的高效開發平臺，其特點有：

　　 1、基于SOAP協議的，資料格式是XML；

　　 2、可以支持各種各樣的協議,比如TCP，HTTP，HTTPS，Json等；

　　 3、與其前輩web Service相比，WCF不僅可以部署在IIS上還可以部署在應用程式中或者Windows服務中；

　　 4、只要支持標準的web service,可以跨行程、跨機器甚至于跨平臺的通信，

　　三、WebApi的特點：

　　 1、需要通過URI資訊來指定端點，每一個URI代表1種資源；

　　 2、可通過不同的http動作表達不同的含義,客戶端使用GET、POST、PUT、DELETE4個表示操作方式的動詞對服務端資源進行操作：GET用來獲取資源，POST用來新建資源（也可以用于更新資源），PUT用來更新資源，DELETE用來洗掉資源；

　　 3、通過請求來實作對資源的資源，資源的表現形式大多是XML或者HTML（亦或其它），請求的回復通過Http Status Code表達不同含義，并且客戶端可以通過Accept header來與服務器協商格式，例如希望服務器回傳JSON格式還是XML格式亦或者其他擴展格式；

　　 4、支持跨平臺、CORS跨域呼叫WebApi,如通過前端js或者直接在后臺呼叫它，部署時支持Self-host或者IIS，；

　　 5、客戶端與服務端之間的互動在請求之間是無狀態的，從客戶端到服務端的每個請求都必須包含理解請求所必需的資訊，

　　聊完它們的特點，那么如何物盡其用呢？(參考鏈接：https://blog.csdn.net/u013043518/java/article/details/51793294)

　　 1、當你想創建一個支持訊息、訊息佇列、雙工通信的服務時，你應該選擇WCF

　　 2、當你想創建一個服務，可以用更快速的傳輸通道時，像TCP、NamedPipes或者甚至是UDP（在WCF4.5中）,在其他傳輸通道不可用的時候也可以支持HTTP，

　　 3、當你想創建一個基于HTTP的面向資源的服務并且可以使用HTTP的全部特征時（比如URIs、request/response頭，快取，版本控制，多種內容格式），你應該選擇WebAPI

　　 4、當你想讓你的服務用于瀏覽器、手機、iPhone和平板電腦時，你應該選擇Web API

　 前面在聊WebApi特點的時候有提到可以通過前端或者在后臺去呼叫它，看下具體如何呼叫：

　　例1：通過HttpClient類調Api，在Web API發布的同時，.NET提供了兩個程式集：System.Net.Http和System.Net.Http.Formatting，這兩個程式集中最核心的類是HttpClient (在這里只討論如何調WebApi，思路為打磨一個通用的工具類，其余部分各位看官自由發揮)：

 1 public class CallAPI
 2 {
 3 private static string uri = "http://localhost:5000/";
 4 private HttpClient client = new HttpClient();
 5 
 6 /// <summary>
 7 /// 簡單查詢
 8 /// </summary>
 9 /// <param name="resource">目標資源</param>
10 public void GetData(string resource)
11 {
12 　　client.BaseAddress = new Uri(uri);
13 
14 　　// 為JSON格式添加一個Accept報頭
15 　　client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
16 　　HttpResponseMessage responseMessage = client.GetAsync(resource).Result;//獲取查詢結果
17 　　if (responseMessage.IsSuccessStatusCode)
18 　　{
19 　　　　var ds = responseMessage.Content.ReadAsStringAsync().Result;
20 　　　　string content = JsonConvert.SerializeObject(ds, Newtonsoft.Json.Formatting.Indented);//轉換為你想要的格式如xml,json等，定義通用的轉換類這里就不介紹了，請自行打造
21 　　}
22 }
23 
24 /// <summary>
25 /// 帶參查詢
26 /// </summary>
27 /// <param name="resource">目標資源</param>
28 /// <param name="id">ID</param>
29 public void GetDataWithParam(string resource)
30 {
31 　　client.BaseAddress = new Uri(uri);
32 
33 　　client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
34 　　HttpResponseMessage responseMessage = client.GetAsync(resource).Result;
35 　　if (responseMessage.IsSuccessStatusCode)
36 　　{
37 　　　　var ds = responseMessage.Content.ReadAsStringAsync().Result;
38 　　　　string content = JsonConvert.SerializeObject(ds, Newtonsoft.Json.Formatting.Indented);
39 　　}
40 
41 }
42 
43 
44 /// <summary>
45 /// put請求更新資源
46 /// </summary>
47 /// <param name="resource"></param>
48 /// <returns></returns>
49 public bool PutData(string resource)
50 {
51 　　bool bol = false;
52 　　//創建和webapi對應的類
53 　　var content = new FormUrlEncodedContent(new Dictionary<string, string>()
54 　　{
55 　　　　{"ID","382accff-57b2-4d6e-ae84-a61e00a3e3b5"},
56 　　　　{"Name","Name" },
57 　　　　{"QZH","111"}
58 　　});
59 　　HttpResponseMessage response = client.GetAsync(resource).Result;
60 　　response = client.PostAsync(resource, content).Result;
61 　　if (response.IsSuccessStatusCode)
62 　　{
63 　　　　bol = true;
64 　　　　var result = response.Content.ReadAsStringAsync().Result;
65 　　}
66 　　return bol;
67 }
68 
69 }

View Code

　例2：基于mvc+dotnet core WebApi，通過前端ajax來呼叫，下面直接貼幾段不同呼叫型別的代碼（由于Put 請求與Post請求類似就不再舉例貼代碼）：

　　片段1：基礎型別作為引數

 1 　前端ajax代碼：
 2 $.ajax({
 3 type: "get",
 4 url: "http://localhost:27221/api/Charging/GetAllChargingData",
 5 data: { id: 1, name: "Jim", bir: "1988-09-11"},
 6 success: function (data, status) {
 7 if (status == "success") {
 8 $("#div_test").html(data);
 9 }
10 }
11 });
12 Controller層代碼：
13 [HttpGet]
14 public string GetAllChargingData(interestingid，string name, DateTime bir)
15 {return "ChargingData" + id;}

View Code

　　片段2：物體型別作為引數

 1 前端ajax代碼：　
 2 　$.ajax({
 3 type: "get",
 4 url: "http://localhost:27221/api/Charging/GetByModel",
 5 contentType: "application/json",
 6 data: { strQuery: JSON.stringify({ ID: "1", NAME: "Jim", CREATETIME: "1988-09-11" }) },
 7 success: function (data, status) {
 8 if (status == "success") {
 9 $("#div_test").html(data);
10 }
11 }
12 });
13 Controller層代碼一（先序列化，再在后臺反序列的方式）：
14 [HttpGet]
15 public string GetByModel(string strQuery)
16 {
17 TB_CHARGING oData=https://www.cnblogs.com/laziji666/p/Newtonsoft.Json.JsonConvert.DeserializeObject(strQuery));
18 return "Charging" + oData.ID;
19 }
20 Controller層代碼二（在引數里面加上[FromUri]）：
21 [HttpGet]
22 [HttpGet]
23 public string GetAllChargingData([FromUri]TB_CHARGING obj)
24 {
25 return "ChargingData" + obj.ID;
26 }

View Code

　　片段3：單個物體作為引數：（post請求默認是將表單里面的資料的key/value形式發送到服務，而我們的服務器只需要有對應的key/value屬性值的物件就可以接收到，而如果使用application/json，則表示將前端的資料以序列化過的json傳遞到后端，后端要把它變成物體物件，還需要反序列化的程序）

 1 方法一： （使用post請求的默認引數型別，前端直接傳遞json型別的物件）
 2 前端ajax代碼：
 3 $.ajax({
 4 type: "post",
 5 url: "http://localhost:27221/api/Charging/SaveData",
 6 data: { ID: "1", NAME: "Jim", CREATETIME: "1988-09-11" },
 7 success: function (data, status) {}
 8 });
 9 方法二：（指定了contentType為application/json，需序列化待傳遞的物件）
10 前端ajax代碼：
11 var postdata = https://www.cnblogs.com/laziji666/p/{ ID:"1", NAME: "Jim", CREATETIME: "1988-09-11" };
12 $.ajax({
13 type: "post",
14 url: "http://localhost:27221/api/Charging/SaveData",
15 contentType: 'application/json',
16 data: JSON.stringify(postdata),
17 success: function (data, status) {}
18 });
19 Controller層代碼：
20 [HttpPost]
21 public bool SaveData(TB_CHARGING oData)
22 {
23 return true;
24 }

View Code

　　片段4：物體和基礎型別一起作為引數傳遞

 1 前端ajax代碼：
 2 var postdata = https://www.cnblogs.com/laziji666/p/{ ID:"1", NAME: "Jim", CREATETIME: "1988-09-11" };
 3 $.ajax({
 4 type: "post",
 5 url: "http://localhost:27221/api/Charging/SaveData",
 6 contentType: 'application/json',
 7 data: JSON.stringify({ NAME:"Lilei", Charging:postdata }),
 8 success: function (data, status) {}
 9 });
10 Controller層代碼：
11 [HttpPost]
12 public object SaveData(dynamic obj)
13 {
14 var strName = Convert.ToString(obj.NAME);
15 var oCharging = Newtonsoft.Json.JsonConvert.DeserializeObject<TB_CHARGING>(Convert.ToString(obj.Charging));
16 return strName;
17 }

View Code

　　片段5：基礎型別陣列作為引數傳遞

 1 前端ajax代碼：
 2     var arr = ["1", "2", "3", "4"];
 3     $.ajax({
 4         type: "post",
 5         url: "http://localhost:27221/api/Charging/SaveData",
 6         contentType: 'application/json',
 7         data: JSON.stringify(arr),
 8         success: function (data, status) { }
 9     });
10 Controller層代碼：
11         [HttpPost]
12         public bool SaveData(string[] ids)
13         {
14             return true;
15         }

View Code

　　片段6：簡單貼個Delete請求

 1     var arr = [
 2         { ID: "1", NAME: "Jim", CREATETIME: "1988-09-11" },
 3         { ID: "2", NAME: "Lilei", CREATETIME: "1990-12-11" },
 4         { ID: "3", NAME: "Lucy", CREATETIME: "1986-01-10" }
 5     ];
 6     $.ajax({
 7         type: "delete",
 8         url: "http://localhost:27221/api/Charging/OptDelete",
 9         contentType: 'application/json',
10         data: JSON.stringify(arr),
11         success: function (data, status) {}
12     });
13 Controller層：
14         [HttpDelete]
15         public bool OptDelete(List<TB_CHARGING> lstChargin)
16         {
17             return true;
18         }

View Code

　　總結：記錄下個人的學習Asp.netCore RESTful WebApi的程序，不對之處歡迎指正，另：對于Controller層WebApi回傳值的梳理建議參考官網檔案（https://docs.microsoft.com/zh-cn/aspnet/core/web-api/action-return-types?view=aspnetcore-3.1）

轉載請註明出處，本文鏈接：https://www.uj5u.com/net/20493.html

標籤：C#

上一篇：C#基礎篇——事件

下一篇：【半譯】擴展shutdown超時設定以保證IHostedService正常關閉