ASP.NET Core针对一个使用HttpClient对象的类编写单元测试详解

更新时间：2019年01月04日 11:05:36 作者：Lamond Lu

这篇文章主要给大家介绍了关于ASP.NET Core中如何针对一个使用HttpClient对象的类编写单元测试的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

介绍

几年前，微软引入了HttpClient类来替代HttpWebRequest来发送Web请求。这个新的类更易于使用，更加简洁，更具有异步性，且易于扩展。

HttpClient类有一个可以接受HttpMessageHandler类对象的构造函数。HttpMessageHandler类对象可以接受一个请求(HttpRequestMessage), 并返回响应(HttpResponseMessage)。它的功能完全取决于它的实现。默认情况下HttpClient使用的是HttpClientHandler，HttpClientHandler是一个处理程序，它向网络服务器发送请求并从服务器返回响应。在本篇博文中，我们将通过继承DelegatingHandler来创建自己的HttpMessageHandler。

为了实现以上功能，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构造函数，然后复写了SendAsync方法, 在该方法中直接返回了构造函数中传入的HttpResponseMessage对象。

编写一个使用IHttpClientFactory接口的服务

下面我们需要编写一个UserService类，这个类提供了一个GetUsers方法，来从远程服务器端获取用户列表。

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实例化

测试服务

在下面的单元测试中，我们会使用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");
  }
}

在以上测试中，我们期望获取一个成功的响应，并得到2个用户的信息。
我们期望从Service中得到的数据是JSON格式的。
我们使用一个伪造的处理程序初始化了一个HttpClient对象，然后定义了我们期望的得到的伪造对象httpClientFactoryMock.CreateClient().Returns(fakeHttpClient);

测试场景2：模拟一个404错误，返回空数据

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, 它的结果集是Null

总结

本篇作者讲解了在ASP.NET Core中如何伪造HttpClient来测试持有HttpClient对象的类。这里主要是通过伪造的DelegatingHandler对象来创建一个HttpClient对象，并使用IHttpClientFactory来获取伪造的HttpClient来达到目的。

本篇源代码：https://github.com/lamondlu/Sample_TestHttpClient （本地下载）

好了，以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对脚本之家的支持。

原文地址： How to unit test a class that consumes an HttpClient with IHttpClientFactory in ASP.NET Core?

作者： Anthony Giretti

您可能感兴趣的文章:

Asp.net基于ajax和jquery-ui实现进度条
这篇文章主要介绍了Asp.net基于ajax和jquery-ui实现进度条,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-12-12
ASP.NET中Validation验证控件正则表达式特殊符号的说明
本文介绍asp.net中RegularExpressionValidator控件中的几种特殊字符串使用规则，并做了代码演示，希望对大家有所帮助。
2016-04-04
ASP.NET无刷新分页简单实现
无刷新分页功能，虽然比较简单，但是涉及到的知识面蛮多的，我记录一下制作的步骤与心得，仅供参考。如有哪里不足，希望大家指出，有更好的方法，也可以提出来，大家一起学习。
2015-09-09
ASP.NET MVC从控制器中获取URL值
这篇文章介绍了ASP.NET MVC从控制器中获取URL值的方法，文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2022-03-03
asp.net上传图片并作处理水印与缩略图的实例代码
asp.net 上传图片并作处理（生成缩略图、在图片上增加文字水印、在图片上生成图片水印）的实例代码，经过测试！
2013-06-06
详解.Net中字符串不变性与相等判断的特殊场景
本文主要介绍了.Net中字符串不变性与相等判断的特殊场景，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-04-04
五步掌握OOM框架AutoMapper基本使用
本文主要介绍了OOM框架AutoMapper的相关知识，本篇的五个实例可以帮你解决常见的基本问题。具有一定的参考价值，下面跟着小编一起来看下吧
2017-01-01
C#反射技术的简单操作(读取和设置类的属性)
反射的作用想必大家都知道了吧，少量属性的自动化操作手动添加几下当然是没有问题的，但是属性数量较多的时候敲起这些繁锁的代码可以困了，再说对扩展和维护性造成很多的不遍，以下代码中如不能直接使用请添加using System.Text;的引用。
2011-01-01
asp.net水晶报表参数字段在代码中赋值的方法
这篇文章主要介绍了asp.net水晶报表参数字段在代码中赋值的方法,实例分析了asp.net中水晶报表的使用技巧,需要的朋友可以参考下
2015-05-05
.net平台推送ios消息的实现方法
这篇文章主要介绍了.net平台推送ios消息的实现方法,详细讲述了各个具体的实现步骤并附有源码供大家参考之用,需要的朋友可以参考下
2014-10-10