完成OSS.Http底層HttpClient重構封裝 支持標準庫

OSS.Http項目對於.Net Standard標準庫的支持已經遷移完畢,OSS開源系列兩個最底層的類庫已經具備跨運行時支持的能力。由於OSS.Http類庫是幾年前我參照RestSharp的思路,完成的一個輕量型Http請求框架。因爲時間較久底層使用的還是HttpWebRequest,這次基本上是完全重構,這篇文章主要包含 1. HttpClient的介紹,2. 重構的思路, 3. 容易遇到的問題。

一. httpclient的基本介紹

  HttpClient應該是在.net framework4.5版本左右引用的新功能,在此之前常用的是HttpWebRequest,相比較而言,前者更加的簡單清晰,最重要的是完全支持.net standard API,這也是我選擇它的重要原因。

  HttpClient在結構上做了很大的調整,並且是完全異步的實現,可以說從底層上完成了異步的支持,這裏先介紹對應的幾個主要類:

  1.  HtttpRequestMessage

  請求的基本信息,請求地址,請求動作等,此值是在HttpClient發起請求的方法中當參數傳入,與他對應的是響應 HttpResponseMessage

  2.  HttpContent

   請求的內容體,主要包含請求的具體內容,contenttype,contentlenght等,是HtttpRequestMessage的一個屬性,這兩個都包含Headers屬性,但是範圍分別不一樣,這個是很容易混淆出錯的地方,我給做了簡單分類:

  HttpRequestMessage的頭部(HttpRequestHeaders )主要是請求的屬性,如Accept,UserAgent,AcceptEncoding等http鏈接的基本屬性。

  HttpContent的頭部(HttpContentHeaders)主要是當前請求內容的屬性,主要有:Allow,Content-Encoding,Content-Length,Content-Type ,Expires ,Last-Modified 等,詳見官方類庫。

      HttpContent 系統提供了幾個默認實現,主要如下幾個:

 

  3.  HttpMessageHandler

  此類主要作用是請求內容處理動作等的定義,如是否支持重定向,是否可以使用cookie,代理Proxy等,偏向於系統的設置,可以此值通過HttpClient構造函數傳入其中,系統默認的提供的子類爲 HttpClientHandler。

  4.  HttpClient

  具體的請求實現調用實現,完整實現了POST,GET,Delete等Http請求方法,所有的方法最終調用的是SendAsync方法。

 

  上邊的四個主要類,構成了HttpClient請求的主要實現,如果你只是簡單的使用,那麼只需要關心HttpClient即可,如下:

其實在它內部已經默認實現了HttpRequestMessage和HttpClientHandler的賦值。

  雖然簡單介紹,但是基本上可以看出,HttpClient的實現做了非常明確的分工,不是再像以前所有的設置都集中在webrequest中。分工的明確最直接的優勢是HttpClient實現了多請求共用,參見博文

The default HttpClient is the simplest way in which you can start sending requests. A single HttpClient can be used to send as many HTTP requests as you want concurrently so in many scenarios you can just create one HttpClient and then use that for all your requests.

也就是當你係統中要發起不同的請求時,可以共用一個HttpClient,而不用像HttpWebReqest基本每次請求都需要重新定義一個對象,以減少資源的消耗。

 

二. 重構OSS.Http

  回到正題,重構我們的當前代碼模塊,如我所說,由於.Net Standard下完全不提供httpWebRequest的支持,直接導致了我做出重新實現的決定,因爲以前httpWebRequest的簡陋,所以我基本上做了很大的封裝框架,上層完全不需要接觸具體的底層實現,基本上實現了RestSharp的核心,有興趣的同學可以參考代碼 OSS.Http 下Old分支。

  重構之前由於對HttpClient不是十分了解,本想延續已有框架流程,轉換實現。不過隨着對Client文檔的查看研究,發現很多封裝已經完全不需要,流程也發生了變化,所以刪除很多原來框架下的東西,重新整理出最終的實現。

  當然現在的HttpClient本身實現已經足夠簡單清晰,不過在很多情況下直接調用POST,GET等方法,會減少部分代碼的重用,像在OSS.Social項目中,底層我只需要實現一個RestCommon方法,即可達到全局請求控制,調用方只需要提供Url,HttpMothed,Parameter即可。

  這裏我畫了一個簡單的流程圖作爲呈現:

 

流程基本沒有太大的出入,代碼在Github,文件的結構如下:

  Mos文件下: Enum.cs  枚舉類,FileParameter.cs 文件參數類,FormParameter Form表單參數類 ,OsHttpRequest 請求參數類,

  OsRest.cs  是當前封裝類的主要實現,同時爲了保證HttpClient本身功能通用,OsRest繼承自HttpClient,同時提供了RestSend方法,在這個方法中完成流程的實現並最終調用SendAsync方法執行請求。

  RestUtil.cs  輔助類,完成了全局OsRest(HttpClient)的共用,並定義了一個默認HttpClientHandler實現,正常直接調用這個類就可以了。

 

     ​流程中的執行用戶自定義設置,可以在OSHttpRequest中的RequestSet委託屬性中設置,例如可以設置訪問類型是json:

三.  容易遇到的問題

  雖然整個重構後的代碼已經不多了,但是應該還是有些問題可以給大家分享下

  1.  Header賦值問題,請參見我第一部分,一定要分清不同Headers,否則就可能給你報不正確的值錯誤

  2.  可以發現上邊的流程圖中有個“是否是Get”的判斷,因爲如果是Get請求,Content是不能賦值的,就像在HttpWebReqest中,如果get請求調用了GetRequestStream方法,會有“無法發送具有此謂詞類型的內容正文”的異常錯誤。當然如果你使用的是OSS.Http作爲請求,那麼就沒有這個問題了。

 

    3.  和上傳文件同時上傳的表單參數,與單獨的表單參數提交,是不一樣的,請注意處理,不懂得參見OsRest類即可,已經做了處理。

 

如果你還有其他問題,或者對後續的更新感興趣,請關注公衆號(OSSCoder):

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章