開源.NetCore通用工具庫Xmtool使用連載 - HTTP請求篇

来源:https://www.cnblogs.com/bcbr/archive/2023/08/12/17624230.html
-Advertisement-
Play Games

【前言】 幹了這麼多年C#,後悔沒早點用這種“分頁”,簡單/高效/易維護,比其它的分頁方式強多了,不信你自己看。 【正文】 支持.Net Core(2.0及以上)與.Net Framework(4.5及以上) 可以部署在Docker, Windows, Linux, Mac。 從NuGet引入Dev ...


【Github源碼】


《上一篇》 介紹了Xmtool工具庫中的XML操作類庫,今天我們繼續為大家介紹其中的HTTP請求類庫。

在現如今的軟體需求場景中,HTTP網路請求幾乎是開發過程中必然會使用的功能;而系統自帶的HTTPClient對象使用起來並不是那麼容易和友好,因此我們對其進行了二次封裝成了一個Web類庫。
該Web類庫提供了HTTP請求和HTTP安全相關兩方面的封裝。HTTP請求是基於系統自帶的HttpClient對象進行了二次封裝,提供了更易用的方法,並且對Json類型更加友好;HTTP安全方面主要針對XSS攻擊提供了字元處理方法,後續會根據需要不斷添加。


HTTP請求

使用HTTP請求,首選需要獲取HttpClientExt對象:

HttpClientExt client = Xmtool.Web.Client();
// 或者
HttpClientExt client = Xmtool.Web.Client("microservice-1");

根據獲取Client時傳入的參數不同,系統將返回不同的實例;但對相同的參數會做單例處理,也就是說相同的參數將獲取到同一個實例;當不傳入任何參數時,每次都會返回一個全新的實例。

根據HTTP常用請求場景類庫提供了各種屬性和方法:

Timeout屬性

BaseAddress屬性

AddDefaultHeader方法

AddRequestHeader方法

AddRequestHeaderWithoutValidation方法

SetContent方法

SetJsonContent方法

SetJsonContent方法二

Clear方法

Get方法

GetAsync方法

Post方法

PostAsync方法

Put方法

PutAsync方法

Delete方法

DeleteAsync方法

Patch方法

PatchAsync方法

Head方法

HeadAsync方法

Options方法

OptionsAsync方法

1. Timeout屬性

說明:用來設置或獲取HTTP請求的超時時間。

2. BaseAddress屬性

說明: 用來設置或獲取HTTP請求的基本地址,在後續使用相對地址發送請求時會使用該地址進行拼接。

3. AddDefaultHeader方法

public HttpClientExt AddDefaultHeader(string name, string value)
說明:為HTTP請求設置請求頭信息,該頭信息會在實例每次發起請求時攜帶。
參數:

name:請求頭名稱。

value:請求頭內容。

HttpClientExt client = Xmtool.Web.Client();
client.AddDefaultHeader("User", "admin");

4. AddRequestHeader方法

public HttpClientExt AddRequestHeader(string name, string value)
說明:為HTTP請求設置請求頭信息,該頭信息僅會在實例下一次發起請求時攜帶。
參數:

name:請求頭名稱。

value:請求頭內容。

5. AddRequestHeaderWithoutValidation方法

public HttpClientExt AddRequestHeaderWithoutValidation(string name, string value)
說明:為HTTP請求設置請求頭信息,該頭信息僅會在實例下一次發起請求時攜帶;該方法和AddRequestHeader的區別是不會對參數的合法性進行檢查。
參數:

name:請求頭名稱。

value:請求頭內容。

6. SetContent方法

public HttpClientExt SetContent(string content)
說明:為下一次HTTP請求(主要是提交類請求,如Post)設置提交內容。
參數:

content:請求提交內容。

HttpClientExt client = Xmtool.Web.Client();
client.SetContnent("Good Day");
// TODO

7. SetJsonContent方法

public HttpClientExt SetJsonContent(string content)
說明:為下一次請求設置提交內容,必須是JSON格式。
參數:

content:請求提交內容,JSON格式。

HttpClientExt client = Xmtool.Web.Client();
client.SetJsonContnent("{\"Author\": \"softwaiter\"}");
// TODO

8. SetJsonContent方法二

public HttpClientExt SetJsonContent(DynamicObjectExt obj)
說明:通過動態對象為下一次請求設置JSON格式的提交內容。
參數:

obj:要提交的動態對象。

DynamicObjectExt obj = new DynamicObjectExt();
obj.Author = "softwaier";

HttpClientExt client = Xmtool.Web.Client();
client.SetJsonContnent(obj);
// TODO

9. Clear方法

public HttpClientExt Clear()
說明:清除僅在下一次請求中生效的提交內容和請求頭信息。

10. Get方法

public HttpResponseExt Get(string requestUri)
說明:以Get方式發起一個HTTP請求。
參數:

requestUri:HTTP請求地址,可以是相對地址或絕對地址;如果是相對地址將使用BaseAddress進行拼接。

HttpClientExt client = Xmtool.Web.Client();
HttpResponseExt rep = client.Get("https://www.baidu.com");
// TODO

11. GetAsync方法

public async Task<HttpResponseExt> GetAsync(string requestUri)
說明:Get方法的非同步版本。

12. Post方法

public HttpResponseExt Post(string requestUri)
說明:以Post方式發起一個HTTP請求。
參數:

requestUri:HTTP請求地址,可以是相對地址或絕對地址;如果是相對地址將使用BaseAddress進行拼接。

// 新增一條人員信息
HttpClientExt client = Xmtool.Web.Client();
HttpResponseExt rep = client.SetJsonContent("{\"user\": \"admin", \"password\": \"Admin123\"}")
    .Post("https://www.ceshi.com/person");
// TODO

13. PostAsync方法

public async Task<HttpResponseExt> PostAsync(string requestUri)
說明:Post方法的非同步版本。

14. Put方法

public HttpResponseExt Put(string requestUri)
說明:以Put方式發起一個HTTP請求。
參數:

requestUri:HTTP請求地址,可以是相對地址或絕對地址;如果是相對地址將使用BaseAddress進行拼接。

// 修改Id為1的人員住址
HttpClientExt client = Xmtool.Web.Client();
HttpResponseExt rep = client.SetJsonContent("{\"address\": \"BeiJing\"}")
    .Put("https://www.ceshi.com/person/1");
// TODO

15. PutAsync方法

public async Task<HttpResponseExt> PutAsync(string requestUri)
說明:Put方法的非同步版本。

16. Delete方法

public HttpResponseExt Delete(string requestUri)
說明:以Delete方式發起一個HTTP請求。
參數:

requestUri:HTTP請求地址,可以是相對地址或絕對地址;如果是相對地址將使用BaseAddress進行拼接。

// 刪除Id為1的人員信息
HttpClientExt client = Xmtool.Web.Client();
HttpResponseExt rep = client.Delete("https://www.ceshi.com/person/1");
// TODO

17. DeleteAsync方法

public async Task<HttpResponseExt> DeleteAsync(string requestUri)
說明:Delete方法的非同步版本。

18. Patch方法

public HttpResponseExt Patch(string requestUri)
說明:以Patch方式發起一個HTTP請求。
參數:

requestUri:HTTP請求地址,可以是相對地址或絕對地址;如果是相對地址將使用BaseAddress進行拼接。

// 修改Id為1的人員信息
HttpClientExt client = Xmtool.Web.Client();
HttpResponseExt rep = client.SetJsonContent("{\"name\":\"wangxm\", \"age\": 18}")
    .Delete("https://www.ceshi.com/person/1");
// TODO

19. PatchAsync方法

public async Task<HttpResponseExt> PatchAsync(string requestUri)
說明:Patch方法的非同步版本。

20. Head方法

public HttpResponseExt Head(string requestUri)
說明:以Head方式發起一個HTTP請求。
參數:

requestUri:HTTP請求地址,可以是相對地址或絕對地址;如果是相對地址將使用BaseAddress進行拼接。

21. HeadAsync方法

public async Task<HttpResponseExt> HeadAsync(string requestUri)
說明:Head方法的非同步版本。

22. Options方法

public HttpResponseExt Options(string requestUri)
說明:以Options方式發起一個HTTP請求。
參數:

requestUri:HTTP請求地址,可以是相對地址或絕對地址;如果是相對地址將使用BaseAddress進行拼接。

23. OptionsAsync方法

public async Task<HttpResponseExt> OptionsAsync(string requestUri)
說明:Options方法的非同步版本。

HTTP安全

HTTP安全在類庫中目前僅提供了一個應對XSS攻擊的處理方法,該方法會對傳入參數進行二次,將內容中有風險部分進行處理並返回。

使用時需要首先獲取HttpSecurity對象:

HttpSecurity security = Xmtool.Web.Security();

Xss方法

1. Xss方法

public string Xss(string str)
說明:對指定字元內容進行Xss風險處理並返回處理結果。
參數:

str:需要進行處理的字元串內容。

string str = "<script>alert(123);</script><div>hello world.</div>";
string str2 = Xmtool.Web.Security().Xss(str);
Console.Writeline(str2);	// 輸出<div>hello world.</div>
//TODO 

附加說明

一、DynamicObjectExt對象

說明:DynamicObjectExt動態對象是Xmtool工具庫中最具特色的一項功能;通過該對象可以無需事先定義就能像使用實體類一樣進行數據對象的賦值和操作;且比系統自帶的dynamic對象更加靈活友好。如果你熟悉Javascript的話,它就像Javascript中的變數一樣可以任意使用;更加詳細的說明請參考《DynamicObjectExt詳細說明》

二、HttpResponseExt對象

HttpResponseExt對象用於接收HTTP請求返回結果,封裝了響應碼、響應頭、響應內容 3 部分內容。

StatusCode屬性

Headers屬性

Content屬性

Json屬性

Xml屬性

1. StatusCode屬性

說明:HTTP請求的響應狀態碼。

2. Headers屬性

說明:HTTP請求的響應頭信息。
HttpClientExt client = Xmtool.Web.Client();
HttpResponseExt resp = client.Get("https://www.baidu.com");
if (resp.Headers.ContainsKey("user"))
{
    string user = resp.Headers["user"];
    // TODO
}

3. Content屬性

說明:HTTP請求的響應內容。

4. Json屬性

說明:HTTP請求返回的JSON格式的內容;如果返回內容不是合法的JSON格式,將返回異常。
// https://www.ceshi.com/person/1 請求返回內容
{
    "Name": "softwaiter",
    "Age": 18,
    "Address": "BeiJing"
}
HttpClientExt client = Xmtool.Web.Client();
HttpResponseExt resp = client.Get("https://www.ceshi.com/person/1");
if (resp.Json.Name == "softwaiter")
{
    // TODO
}

5. Xml屬性

說明:HTTP請求返回的XML格式的內容;如果返回內容不是合法的XML格式,將返回異常。


【Github源碼】


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • HotSpot的演算法實現 HotSpot的演算法實現概要 1、枚舉根節點 由於目前的主流Java虛擬機使用的都是準確式GC(這個概念在第1章介紹Exact VM對Classic VM的改進時講過),所以當執行系統停頓下來後,並不需要一個不漏地檢查完所有執行上下文和全局的引用位置,虛擬機應當是有辦法直接 ...
  • 問題:在Windows環境下部署java的jar包,若有多個服務同時啟動,很難找到相應服務重啟。每次都重啟全部服務很麻煩。應用場景大多用於部署測試。 適用:jar部署,war部署不適用。 解決方案:找到相應jar服務關閉並重啟。 註意: 1、正確設置埠,jar服務運行的埠; 2、正確設置jar文 ...
  • 數據類型是編程語言中的一個重要概念,它定義了數據的類型和提供了特定的操作和方法。在 python 中,數據類型的作用是將不同類型的數據進行分類和定義,例如數字、字元串、列表、元組、集合、字典等。這些數據類型不僅定義了數據的類型,還為數據提供了一些特定的操作和方法,例如字元串支持連接和分割,列表支持排... ...
  • ## 依賴導入 ```xml org.hibernate.orm hibernate-core 6.2.7.Final com.mysql mysql-connector-j 8.0.33 ``` ## 配置文件 ```xml com.mysql.cj.jdbc.Driver jdbc:mysql: ...
  • 在實際開發過程中,我們可能會遇到併發寫文件的場景,如果處理不當很可能出現文件內容亂序問題。下麵我們通過一個示常式序描述這一過程並給出解決該問題的方法。 ...
  • # 前言 在面試這一篇我們介紹過[CountDownLatch和CyclicBarrier](https://github.com/jmilktea/jtea/blob/master/%E9%9D%A2%E8%AF%95/CountDownLatch%E5%92%8CCyclicBarrier.md ...
  • 按照業務拆分的方式稱為垂直分片,又稱為縱向拆分,它的核心理念是專庫專用;水平分片又稱為橫向拆分,是通過某些欄位根據某種規則將數據分散至多個庫或表中。 ...
  • **原文鏈接:** [](https://mp.weixin.qq.com/s/--AdUcwOQyP6r5W8ziVwUg) 上一篇文章介紹了 [如何實現計數器限流?](https://mp.weixin.qq.com/s/CTemkZ2aKPCPTuQiDJri0Q)主要有兩種實現方式,分別是固 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 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 ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...