HttpWebRequest、HttpWebResponse、HttpClient、WebClient等http網路訪問類的使用示例彙總

来源:https://www.cnblogs.com/lionwang/archive/2018/08/01/9400823.html
-Advertisement-
Play Games

工作中長期需要用到通過HTTP調用API以及文件上傳下載，積累了不少經驗，現在將各種不同方式進行一個彙總。 首先是HttpWebRequest： 然後是HttpWebResponse： 上面兩個方法需要配合使用，皆為同步方式。當然也可以將上面兩個方法合併到一個方法中，可以參見接下來這個方法。 另外是 ...


工作中長期需要用到通過HTTP調用API以及文件上傳下載，積累了不少經驗，現在將各種不同方式進行一個彙總。

首先是HttpWebRequest：

 1 /// <summary>
 2 /// 向伺服器發送Request
 3 /// </summary>
 4 /// <param name="url">字元串</param>
 5 /// <param name="method">枚舉類型的方法Get或者Post</param>
 6 /// <param name="body">Post時必須傳值</param>
 7 /// <param name="timeoutSeconds">超時時間，單位秒</param>
 8 /// <returns></returns>
 9 public static string Request(string url, MethodEnum method, string body = "", int timeoutSeconds = 15000)
10 {
11     if (!IsConnectedInternet())
12         return "網路連接錯誤，請稍後再試。";
13 
14     try
15     {
16         GC.Collect();
17         HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
18         request.Timeout = timeoutSeconds;
19         request.Method = method.ToString();
20         21         //如果是Post的話，則設置body
22         if (method == MethodEnum.POST)
23         {
24             request.ContentType = "application/json";
25             request.KeepAlive = false;
26             byte[] requestBody = Encoding.UTF8.GetBytes(body);
27             request.ContentLength = requestBody.Length;
28 
29             Stream requestStream = request.GetRequestStream();
30             requestStream.Write(requestBody, 0, requestBody.Length);
31         }
32 
33         return Response(request);
34     }
35     catch (Exception ex)
36     {
37         if (ex.InnerException != null)
38             return ex.InnerException.Message;
39         if (ex.Message.Contains("已取消一個任務"))
40             return "連接伺服器超時，請重試";
41         if (ex.Message.Contains("404"))
42             return "連接伺服器404，請重試";
43         return ex.Message;
44     }
45 }

然後是HttpWebResponse：

 1 /// <summary>
 2 /// 返回Response數據
 3 /// </summary>
 4 /// <param name="request"></param>
 5 /// <returns></returns>
 6 private static string Response(HttpWebRequest request)
 7 {
 8     HttpWebResponse response = (HttpWebResponse)request.GetResponse();
 9 
10     string jsonRead = "";
11 
12     if (response.StatusCode != HttpStatusCode.OK)
13     {
14         return response.StatusCode.ToString();
15     }
16     //接收過程
17     if (response.GetResponseStream() != null)
18     {
19         StreamReader myStreamReader = new StreamReader(response.GetResponseStream() ?? Stream.Null, Encoding.UTF8);
20         jsonRead = myStreamReader.ReadToEnd();
21         myStreamReader.Close();
22     }
23     response.Close();
24     request.Abort();
25 
26     return jsonRead;
27 }

上面兩個方法需要配合使用，皆為同步方式。當然也可以將上面兩個方法合併到一個方法中，可以參見接下來這個方法。

另外是使用HttpWebRequest和HttpWebResponse進行文件上傳，採用非同步方式：

 1 public static void UploadFile(string url, string filePath, string fileName, Action<string> callback)
 2 {
 3     // 時間戳，用做boundary
 4     string timeStamp = DateTime.Now.Ticks.ToString("x");
 5 
 6     //根據uri創建HttpWebRequest對象
 7     HttpWebRequest httpReq = (HttpWebRequest)WebRequest.Create(new Uri(url));
 8     httpReq.Method = "POST";
 9     httpReq.AllowWriteStreamBuffering = false; //對發送的數據不使用緩存
10     httpReq.Timeout = 300000;  //設置獲得響應的超時時間（300秒）
11     httpReq.ContentType = "multipart/form-data; boundary=" + timeStamp;
12 
13     //文件
14     FileStream fileStream = new FileStream(filePath, FileMode.Open, FileAccess.Read);
15     BinaryReader binaryReader = new BinaryReader(fileStream);
16 
17     //頭信息
18     string boundary = "--" + timeStamp;
19     string dataFormat = boundary + "\r\nContent-Disposition: form-data; name=\"{0}\";filename=\"{1}\"\r\nContent-Type:application/octet-stream\r\n\r\n";
20     string header = string.Format(dataFormat, "file", Path.GetFileName(filePath));
21     byte[] postHeaderBytes = Encoding.UTF8.GetBytes(header);
22 
23     //結束邊界
24     byte[] boundaryBytes = Encoding.ASCII.GetBytes("\r\n--" + timeStamp + "--\r\n");
25 
26     long length = fileStream.Length + postHeaderBytes.Length + boundaryBytes.Length;
27 
28     httpReq.ContentLength = length;//請求內容長度
29 
30     try
31     {
32         //每次上傳4k
33         int bufferLength = 4096;
34         byte[] buffer = new byte[bufferLength];
35 
36         //已上傳的位元組數
37         long offset = 0;
38         int size = binaryReader.Read(buffer, 0, bufferLength);
39         Stream postStream = httpReq.GetRequestStream();
40 
41         //發送請求頭部消息
42         postStream.Write(postHeaderBytes, 0, postHeaderBytes.Length);
43 
44         while (size > 0)
45         {
46             postStream.Write(buffer, 0, size);
47             offset += size;
48             size = binaryReader.Read(buffer, 0, bufferLength);
49         }
50 
51         //添加尾部邊界
52         postStream.Write(boundaryBytes, 0, boundaryBytes.Length);
53         postStream.Close();
54 
55         string returnValue = "";
56         //獲取伺服器端的響應
57         using (HttpWebResponse response = (HttpWebResponse)httpReq.GetResponse())
58         {
59             Stream receiveStream = response.GetResponseStream();
60             StreamReader readStream = new StreamReader(receiveStream, Encoding.UTF8);
61             returnValue = readStream.ReadToEnd();
62             response.Close();
63             readStream.Close();
64         }
65         
66         callback?.Invoke(returnValue);
67     }
68     catch (Exception)
69     {
70         callback?.Invoke("");
71     }
72     finally
73     {
74         fileStream.Close();
75         binaryReader.Close();
76     }
77 }

上面還用到一個enum叫MethodEnum，包含GET和POST兩個枚舉值。

還有一個比較特殊的POST方法：

 1 public static string HttpPostFormData(string url, Dictionary<string, string> dic)
 2 {
 3     try
 4     {
 5         GC.Collect();
 6         // 時間戳，用做boundary
 7         string timeStamp = DateTime.Now.Ticks.ToString("x");
 8         string boundary = "----" + timeStamp;
 9 
10         HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
11         request.Method = WebRequestMethods.Http.Post;
12         request.ContentType = "multipart/form-data; boundary=" + boundary;
13         request.KeepAlive = true;
14         request.Timeout = 3000;
15 
16         var stream = new MemoryStream();
17 
18         //頭信息
19         string dataFormat = "--" + boundary + "\r\nContent-Disposition: form-data; name=\"{0}\"\r\n\r\n{1}\r\n";
20         foreach (string key in dic.Keys)
21         {
22             string s = string.Format(dataFormat, key, dic[key]);
23             byte[] data = Encoding.UTF8.GetBytes(s);
24             stream.Write(data, 0, data.Length);
25         }
26 
27         //結束邊界
28         byte[] boundaryBytes = Encoding.ASCII.GetBytes("--" + boundary + "--");
29         stream.Write(boundaryBytes, 0, boundaryBytes.Length);
30 
31         request.ContentLength = stream.Length;//請求內容長度
32 
33         Stream requestStream = request.GetRequestStream(); //寫入請求數據
34         stream.Position = 0L;
35         stream.CopyTo(requestStream);
36         stream.Close();
37 
38         requestStream.Close();
39 
40         return Response(request);
41     }
42     catch (Exception e)
43     {
44         return e.Message;
45     }
46 }

--------------------------------------------------------------------------------------我是分割線-----------------------------------------------------------------------------------------------------------

然後是HttpClient，這個類提供的都是非同步方法，下麵包含了POST、GET、PUT、DELETE四個方法，還有一個SEND方法稍加改動即可實現：

  1 public static async void AsyncPost(string url, string body, Action<RequestResult> callback, int timeoutSeconds = 10)
  2 {
  3     var requestResult = new RequestResult();
  4     if (!IsConnectedInternet())
  5     {
  6         requestResult.Message = "網路連接錯誤，請稍後再試。";
  7         callback?.Invoke(requestResult);
  8         return;
  9     }
 10 
 11     try
 12     {
 13         using (var client = new HttpClient())
 14         {
 15             client.DefaultRequestHeaders.Add("authorization", "LJQfL1A2oeP2fuEiOHo6");
 16             client.Timeout = new TimeSpan(0, 0, timeoutSeconds);
 17             //byte[] requestBody = Encoding.UTF8.GetBytes(body);
 18             HttpContent content = new StringContent(body);
 19             content.Headers.ContentType = new MediaTypeHeaderValue("application/json");
 20             var response = await client.PostAsync(url, content);
 21             //確保HTTP成功狀態值
 22             response.EnsureSuccessStatusCode();
 23             //await非同步讀取最後的JSON
 24             await response.Content.ReadAsStringAsync().ContinueWith(t =>
 25             {
 26                 if (t.IsCompleted)
 27                 {
 28                     requestResult.IsSuccess = true;
 29                     requestResult.Result = t.Result;
 30                     callback?.Invoke(requestResult);
 31                 }
 32             });
 33         }
 34     }
 35     catch (Exception e)
 36     {
 37         if (e.InnerException != null)
 38             requestResult.Message = e.InnerException.Message;
 39         else if (e.Message.Contains("已取消一個任務"))
 40             requestResult.Message = "連接伺服器超時，請重試";
 41         else if (e.Message.Contains("404"))
 42             requestResult.Message = "連接伺服器404，請重試";
 43         else
 44             requestResult.Message = e.Message;
 45         callback?.Invoke(requestResult);
 46     }
 47 }
 48 
 49 public static async void AsyncGet(string url, Action<RequestResult> callback, int timeoutSeconds = 10)
 50 {
 51     var requestResult = new RequestResult();
 52     if (!IsConnectedInternet())
 53     {
 54         requestResult.Message = "網路連接錯誤，請稍後再試。";
 55         callback?.Invoke(requestResult);
 56         return;
 57     }
 58 
 59     try
 60     {
 61         using (var client = new HttpClient())
 62         {
 63             client.DefaultRequestHeaders.Add("authorization", "LJQfL1A2oeP2fuEiOHo6");
 64             client.Timeout = new TimeSpan(0, 0, timeoutSeconds);
 65             var response = await client.GetAsync(url);
 66             //確保HTTP成功狀態值
 67             response.EnsureSuccessStatusCode();
 68             //await非同步讀取最後的JSON
 69             await response.Content.ReadAsStringAsync().ContinueWith(t =>
 70             {
 71                 if (t.IsCompleted)
 72                 {
 73                     requestResult.IsSuccess = true;
 74                     requestResult.Result = t.Result;
 75                     callback?.Invoke(requestResult);
 76                 }
 77             });
 78         }
 79     }
 80     catch (Exception e)
 81     {
 82         if (e.InnerException != null)
 83             requestResult.Message = e.InnerException.Message;
 84         else if (e.Message.Contains("已取消一個任務"))
 85             requestResult.Message = "連接伺服器超時，請重試";
 86         else if (e.Message.Contains("404"))
 87             requestResult.Message = "連接伺服器404，請重試";
 88         else
 89             requestResult.Message = e.Message;
 90         callback?.Invoke(requestResult);
 91     }
 92 }
 93 
 94 public static async void AsyncPut(string url, string body, Action<RequestResult> callback, int timeoutSeconds = 10)
 95 {
 96     var requestResult = new RequestResult();
 97     if (!IsConnectedInternet())
 98     {
 99         requestResult.Message = "網路連接錯誤，請稍後再試。";
100         callback?.Invoke(requestResult);
101         return;
102     }
103 
104     try
105     {
106         using (var client = new HttpClient())
107         {
108             client.DefaultRequestHeaders.Add("authorization", "LJQfL1A2oeP2fuEiOHo6");
109             client.Timeout = new TimeSpan(0, 0, timeoutSeconds);
110             HttpContent content = new StringContent(body);
111             content.Headers.ContentType = new MediaTypeHeaderValue("application/json");
112             var response = await client.PutAsync(url, content);
113             //確保HTTP成功狀態值
114             response.EnsureSuccessStatusCode();
115             //await非同步讀取最後的JSON
116             await response.Content.ReadAsStringAsync().ContinueWith(t =>
117             {
118                 if (t.IsCompleted)
119                 {
120                     requestResult.IsSuccess = true;
121                     requestResult.Result = t.Result;
122                     callback?.Invoke(requestResult);
123                 }
124             });
125         }
126     }
127     catch (Exception e)
128     {
129         if (e.InnerException != null)
130             requestResult.Message = e.InnerException.Message;
131         else if (e.Message.Contains("已取消一個任務"))
132             requestResult.Message = "連接伺服器超時，請重試";
133         else if (e.Message.Contains("404"))
134             requestResult.Message = "連接伺服器404，請重試";
135         else
136             requestResult.Message = e.Message;
137         callback?.Invoke(requestResult);
138     }
139 }
140 
141 public static async void AsyncDelete(string url, Action<RequestResult> callback, int timeoutSeconds = 10)
142 {
143     var requestResult = new RequestResult();
144     if (!IsConnectedInternet())
145     {
146         requestResult.Message = "網路連接錯誤，請稍後再試。";
147         callback?.Invoke(requestResult);
148         return;
149     }
150 
151     try
152     {
153         using (var client = new HttpClient())
154         {
155             client.DefaultRequestHeaders.Add("authorization", "LJQfL1A2oeP2fuEiOHo6");
156             client.Timeout = new TimeSpan(0, 0, timeoutSeconds);
157             var response = await client.DeleteAsync(url);
158             //確保HTTP成功狀態值
159             response.EnsureSuccessStatusCode();
160             //await非同步讀取最後的JSON
161             await response.Content.ReadAsStringAsync().ContinueWith(t =>
162             {
163                 if (t.IsCompleted)
164                 {
165                     requestResult.IsSuccess = true;
166                     requestResult.Result = t.Result;
167                     callback?.Invoke(requestResult);
168                 }
169             });
170         }
171     }
172     catch (Exception e)
173     {
174         if (e.InnerException != null)
175             requestResult.Message = e.InnerException.Message;
176         else if (e.Message.Contains("已取消一個任務"))
177             requestResult.Message = "連接伺服器超時，請重試";
178         else if (e.Message.Contains("404"))
179             requestResult.Message = "連接伺服器404，請重試";
180         else
181             requestResult.Message = e.Message;
182         callback?.Invoke(requestResult);
183     }
184 }

上面使用到的RequestResult類：

 1 public class RequestResult : IDisposable
 2 {
 3     public bool IsSuccess { get; set; }
 4 
 5     public string Result { get; set; }
 6 
 7     public string Message { get; set; }
 8 
 9     public RequestResult(bool isSuccess = false, string result = "", string message = "")
10     {
11         IsSuccess = isSuccess;
12         Result = result;
13         Message = message;
14     }
15 
16     ~RequestResult()
17     {
18         Dispose();
19     }
20 
21     public void Dispose()
22     {
23         Dispose(true);
24         GC.SuppressFinalize(this);//不需要再調用本對象的Finalize方法
25     }
26 
27     protected virtual void Dispose(Boolean disposing)
28     {
29         if (disposing)
30         {
31             //--- 清理托管資源 ---//
32         }
33 
34         //--- 清理非托管資源 ---//
35     }
36 }

還有一個判斷Windows系統網路連接狀態的方法：

 1 #region 網路狀態測試
 2 
 3 [DllImport("winInet.dll")]
 4 private static extern bool InternetGetConnectedState(ref int dwFlag, int dwReserved);
 5 
 6 /// <summary>
 7 /// 用於檢查網路是否可以連接互聯網,true表示連接成功,false表示連接失敗 
 8 /// </summary>
 9 /// <returns></returns>
10 private static bool IsConnectedInternet()
11 {
12     int description = 0;
13     return InternetGetConnectedState(ref description, 0);
14 }
15 
16 #endregion

--------------------------------------------------------------------------------------我是分割線-----------------------------------------------------------------------------------------------------------

最後是使用WebClient進行文件下載，這裡使用了Task非同步方式，也可以改為普通方法或靜態方法：

 1 /// <summary>
 2 /// 下載文件
 3 /// </summary>
 4 /// <param name="fileUrl">文件地址</param>
 5 /// <param name="filePath">文件的本地路徑</param>
 6 /// <returns>文件在本地的存儲路徑</returns>
 7 private Task GetFileLocalPath(
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 程式員人生之路
    當你選擇電腦或者電子、自控等專業進入大學時，你本來還是有機會從事其它行業的，可你畢業時執迷不悟，仍然選擇了開發做為你的職業，真是自做孽不可活。不過，歡迎你和我一樣加入這個被其它人認為是風光無限的“白領”吧。 如果你不是特別的與人世隔絕，我想你一定看過金老先生的名著《笑傲江湖》吧，裡面有一門十分奇特 ...
  • 語法糖
    字元串: C#中$的用法: 是為了替代string.format();https://www.cnblogs.com/hilolin/p/9123970.htmlhttps://blog.csdn.net/kebi007/article/details/52612610語法糖: C#6.0: htt... ...
  • C# 操作Word 中的OLE——插入、編輯、讀取 OLE
    概述 OLE，Object Linking and Embedding，即對象連接與嵌入。我們在設計程式時，OLE可以用來創建複合文檔，把文字、聲音、圖像、表格、應用程式等類型的信息組合在一起，在Word中，我們可以通過OLE來實現以上要素信息的組合。下麵的示例中將介紹如何通過C# 來操作Word中 ...
  • 細說C#繼承
    簡介 繼承(封裝、多態)是面向對象編程三大特性之一，繼承的思想就是擯棄代碼的冗餘，實現更好的重用性。 繼承從字面上理解，無外乎讓人想到某人繼承某人的某些東西，一個給一個拿。這個語義在生活中，就像 家族繼承財產，爺爺將財產繼承給兒女，兒女在將財產繼承給子孫，有些東西可以繼承有些的東西只繼承給 某人。映 ...
  • 未能載入文件或程式集“Oracle.DataAccess”或它的某一個依賴項.試圖載入格式不正確的程式
    1.今天在部署IIS7應用程式的時候出現了這個錯誤，本以為是發佈的錯誤，其實不然，是IIS中所依賴的項沒有配置正確 2.選擇創建站點中對應的應用池 高級設置 啟用32位應用程式，然後把值改為true。 3.打開cmd命令進行安裝 如果映射存在，請檢查應用程式是否分配給了.NET Framework4 ...
  • ado.net的簡單資料庫操作（一）
    摘要：接下來的幾篇博客將要講到如何使用ado.net實現簡單的資料庫操作，包括增刪改等內容。首先會介紹基礎的資料庫操作，然後以一個實例來進行講解，這個實例會把一個數據表讀取到winform上，然後在winform上有一些按鈕和文本框，通過這些實現對資料庫里的內容的增刪改的操作。我個人比較菜，因此記錄... ...
  • WPF Slider滑動條的顏色修改
    效果如下： 鄙人雖然開發WPF有些時間，但之前一直是一些簡單Template和Style改改之類的工作，並沒有深入研究過。此次為了完成工作，首先也是網上搜了半天，沒有找到合適的代碼直接拷貝（搜索能力待提高），乾脆就直接靜下心來琢磨琢磨。 一開始在界面上就放了Slider，撓撓頭，怎麼修改Templa ...
  • C#實現文章添加內鏈
    為什麼文章要添加內鏈？ 1.有利於讀者 我喜歡內鏈文章的最初動機是讓讀者在我的博客獲得更好的閱讀體驗，並獲得更多的價值。如果我的讀者訪問了我的一篇文章，發現不僅僅回答他需要的答案，還提供了更多相關內容的信息，讓他們能在更多的相關主題去擴展閱讀，他們遲早會喜歡並滿意我的博客。讓讀者滿意就是我們的目標， ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類