ASP.NET Core針對一個使用HttpClient對象的類編寫單元測試詳解
介紹
幾年前,微軟引入了HttpClient類來替代HttpWebRequest來發(fā)送Web請求。這個新的類更易于使用,更加簡潔,更具有異步性,且易于擴展。
HttpClient類有一個可以接受HttpMessageHandler類對象的構(gòu)造函數(shù)。HttpMessageHandler類對象可以接受一個請求(HttpRequestMessage), 并返回響應(yīng)(HttpResponseMessage)。它的功能完全取決于它的實現(xiàn)。默認情況下HttpClient使用的是HttpClientHandler,HttpClientHandler是一個處理程序,它向網(wǎng)絡(luò)服務(wù)器發(fā)送請求并從服務(wù)器返回響應(yīng)。在本篇博文中,我們將通過繼承DelegatingHandler來創(chuàng)建自己的HttpMessageHandler。
為了實現(xiàn)以上功能,HttpClient對象不可以直接使用,而是需要與允許使用IHttpClientFactory接口進行模擬的依賴注入一起使用。
讓我們來偽造一個HttpMessageHandler
下面的例子中,我們只討論HttpResponseMessage, 不會處理HttpRequestMessage。
以下是我偽造的一個HttpMessageHandler對象。
public class FakeHttpMessageHandler : DelegatingHandler { private HttpResponseMessage _fakeResponse; public FakeHttpMessageHandler(HttpResponseMessage responseMessage) { _fakeResponse = responseMessage; } protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken) { return await Task.FromResult(_fakeResponse); } }
這里我添加了一個需要HttpResponseMessage構(gòu)造函數(shù),然后復寫了SendAsync方法, 在該方法中直接返回了構(gòu)造函數(shù)中傳入的HttpResponseMessage對象。
編寫一個使用IHttpClientFactory接口的服務(wù)
下面我們需要編寫一個UserService類,這個類提供了一個GetUsers方法,來從遠程服務(wù)器端獲取用戶列表。
public class UserService { private readonly IHttpClientFactory _httpFactory; public UserService(IHttpClientFactory httpFactory) { _httpFactory = httpFactory; } public async Task<List<User>> GetUsers(string url) { using (HttpClient httpclient = _httpFactory.CreateClient()) { using (HttpResponseMessage response = await httpclient.GetAsync(url)) { if (response.StatusCode == HttpStatusCode.OK) { List<User> users = await response.Content.ReadAsAsync<List<User>>(); return users; } return null; } } } }
以下是Api請求返回的用戶類
public class User { public string FirstName { get; set; } public string LastName { get; set; } }
如你所見,使用HttpClientFactory允許我們模擬HttpClient實例化
測試服務(wù)
在下面的單元測試中,我們會使用XUnit、FluentAssertion、NSubstitute
測試場景1: 模擬一個請求,返回2個用戶
public class UserServiceTests { [Fact] public async Task WhenACorrectUrlIsProvided_ServiceShouldReturnAlistOfUsers() { // Arrange var users = new List<User> { new User { FirstName = "John", LastName = "Doe" }, new User { FirstName = "John", LastName = "Deere" } }; var httpClientFactoryMock = Substitute.For<IHttpClientFactory>(); var url = "http://good.uri"; var fakeHttpMessageHandler = new FakeHttpMessageHandler(new HttpResponseMessage() { StatusCode = HttpStatusCode.OK, Content = new StringContent(JsonConvert.SerializeObject(users), Encoding.UTF8, "application/json") }); var fakeHttpClient = new HttpClient(fakeHttpMessageHandler); httpClientFactoryMock.CreateClient().Returns(fakeHttpClient); // Act var service = new UserService(httpClientFactoryMock); var result = await service.GetUsers(url); // Assert result .Should() .BeOfType<List<User>>() .And .HaveCount(2) .And .Contain(x => x.FirstName == "John") .And .Contain(x => x.LastName == "Deere") .And .Contain(x => x.LastName == "Doe"); } }
- 在以上測試中,我們期望獲取一個成功的響應(yīng),并得到2個用戶的信息。
- 我們期望從Service中得到的數(shù)據(jù)是JSON格式的。
- 我們使用一個偽造的處理程序初始化了一個HttpClient對象,然后定義了我們期望的得到的偽造對象httpClientFactoryMock.CreateClient().Returns(fakeHttpClient);
測試場景2: 模擬一個404錯誤,返回空數(shù)據(jù)
public class UserServiceTests { [Fact] public async Task WhenABadUrlIsProvided_ServiceShouldReturnNull() { // Arrange var httpClientFactoryMock = Substitute.For<IHttpClientFactory>(); var url = "http://bad.uri"; var fakeHttpMessageHandler = new FakeHttpMessageHandler(new HttpResponseMessage() { StatusCode = HttpStatusCode.NotFound }); var fakeHttpClient = new HttpClient(fakeHttpMessageHandler); httpClientFactoryMock.CreateClient().Returns(fakeHttpClient); // Act var service = new UserService(httpClientFactoryMock); var result = await service.GetUsers(url); // Assert result .Should() .BeNullOrEmpty(); } }
和測試場景1類似,當一個Http請求返回Not Found, 它的結(jié)果集是Null
總結(jié)
本篇作者講解了在ASP.NET Core中如何偽造HttpClient來測試持有HttpClient對象的類。這里主要是通過偽造的DelegatingHandler對象來創(chuàng)建一個HttpClient對象,并使用IHttpClientFactory來獲取偽造的HttpClient來達到目的。
本篇源代碼:https://github.com/lamondlu/Sample_TestHttpClient (本地下載)
好了,以上就是這篇文章的全部內(nèi)容了,希望本文的內(nèi)容對大家的學習或者工作具有一定的參考學習價值,如果有疑問大家可以留言交流,謝謝大家對腳本之家的支持。
原文地址: How to unit test a class that consumes an HttpClient with IHttpClientFactory in ASP.NET Core?
作者: Anthony Giretti
相關(guān)文章
ASP.NET?MVC使用jQuery的Load方法加載靜態(tài)頁面及注意事項
這篇文章介紹了ASP.NET?MVC使用jQuery加載靜態(tài)頁面的方法,文中通過示例代碼介紹的非常詳細。對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2022-09-09asp.net 數(shù)據(jù)庫的連接和datatable類
asp.net下數(shù)據(jù)庫的連接與數(shù)據(jù)庫datatable類實現(xiàn)代碼。2009-05-05datagrid綁定list沒有數(shù)據(jù) 表頭不顯示的解決方法
datagrid綁定list沒有數(shù)據(jù) 表頭不顯示的問題,那是因為 綁定了null,你給list new一下就好 表頭就會有啦2013-05-05Win2008 server + IIS7 設(shè)置身份模擬(ASP.NET impersonation)
IIS7 與 IIS 6 相比有了很大的改動,原來在 IIS 6 下可以的設(shè)置到了 IIS 7 下有的會發(fā)生變化。身份模擬的配置上,IIS7 和 IIS6有很大不同,網(wǎng)上IIS6的身份模擬的文章比較多,但介紹IIS7的比較少,我把的一些折騰的經(jīng)驗在這篇博客中寫下來,以供參考2011-10-10關(guān)于ASP.NET中TreeView用法的一個小例子
下面是一個Treeview動態(tài)的綁定3層深度的樹的代碼,有需要的朋友可以參考一下2013-12-12