iis服务器助手广告广告
返回顶部
首页 > 资讯 > 后端开发 > ASP.NET >ASP.NET Core扩展库之Http请求模拟功能的使用
  • 848
分享到

ASP.NET Core扩展库之Http请求模拟功能的使用

2024-04-02 19:04:59 848人浏览 八月长安
摘要

目录一、在服务端使用 二、在单元测试中使用 三、示例     如今,完全独立的业务应用几乎不存在,不管是在企业内部微服务之间的调用,还是与外部

    如今,完全独立的业务应用几乎不存在,不管是在企业内部微服务之间的调用,还是与外部第三方服务的调用,Httpapi交互是常见的场景,这些实际情况给我们的开发带来了比较大的挑战,一是第三方服务可能会牵制我们的开发进度,特别是在多团队开发的情况下,由于依赖于其他团队的服务,有时候需要等待其他团队的进度,导致自己团队的无效等待。有时因为其他团队的延期,导致团队的被动延期。二是第三方服务的质量问题或开发过程中的频繁更新导致的部署问题,将严重拖累自己团队的开发进度,同时让你无法专心的开发自己的服务。三是单元测试困难,特别是在依赖于多个第三方服务时,使得单元测试可能依赖于其他服务环境,导致单元测试结果的不确定性。

    为了解决以上这些问题,XfroGCn.Aspnetcore.Extensions扩展库提供了Http请求模拟的功能,通过此功能可以让你在开发、单元测试时实现你的服务与第三方服务的完全解耦,让你能够更聚焦于自己服务的开发。

    Http请求模拟构建在.net core HttpClientFactory架构之上,通过在HttpClient请求管道中替换实际发送Http请求的主消息处理器为模拟消息处理器来完成请求的模拟应答。

一、在服务端使用

    假设我们负责开发一个订单服务,在订单提交接口,我们保存完订单数据之后,需要发送消息通知,消息通知的发送由消息服务来实现,该服务由另一团队负责,如下图所示:

    由于订单服务依赖于消息服务,在项目启动时,一般两个团队会协商好消息服务的接口定义,然后消息服务团队会快速搭建一个空接口供订单服务团队调用,如果是这种流程,订单服务团队只需等待消息服务团队搭建好环境即可开始工作,好像影响不大,但在实际开发过程中,会存在以下现实的问题:

  • 虽然消息服务团队提供空接口的时间不长,但是如果项目工期紧张,计划都是以小时计算,那么这也将影响订单服务的开发进度
  • “空消息服务”实际上无法一直保持空的状态,消息服务团队会不断对服务进行更新加入他们的实现逻辑,而消息服务本身也可能依赖于其他的服务,这导致订单团队所使用的消息服务不稳定,那么订单团队的进度实际上还是会受到消息服务团队,以及消息服务所依赖的其他团队的影响。
  • 订单服务团队可以使用空的消息服务,但消息服务团队往往需要连接企业外部的第三方服务,比如App的消息推送通道,这让整个项目依赖更加复杂。
  • 订单服务团队编写单元测试会比较困难(当然,此点可以通过抽象来解决,但结合扩展库的Http请求模拟功能,我们可以简化此过程)

    以下介绍如何使用扩展库的请求模拟功能。

    为了聚焦于模拟功能的演示,该示例进行了简化,比如与消息服务的通讯,在正式项目中会通过消息服务的SDK来完成,示例中将直接使用HttpClient,有关SDK与扩展库的结合,我们将在后续文章中说明。

1.引用Xfrogcn.AspNetCore.Extensions
2.定义订单类


    public class Order
    {
        public string Id { get; set; }

        public string ProductCode { get; set; }

        public decimal Price { get; set; }
        
        public int Quantity { get; set; }

        public decimal Amount { get; set; }
    }

3.定义消息发送请求类


    public class SendMessageRequest
    {
        public string MessageId { get; set; }

        public string Message { get; set; }

        public List<int> UserIds { get; set; }
    }

4.配置
    在Starup ConfigureServices方法中配置模拟


        public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers();
            // 启用扩展库
            services.AddExtensions(Configuration);

            // 消息服务所使用的HttpClient名称MESSAGESERVICE
            IHttpClientBuilder messageClient = services.AddHttpClient("MESSAGESERVICE", client =>
            {
                // 设置基础地址
                client.BaseAddress = new Uri("http://api.hello.com/");
            });
            // 只有Mock配置设置为true时,才启用,通过开发应用配置文件来配置
            if (Configuration.GetValue<bool>("Mock"))
            {
                // 配置针对消息服务客户端,POST到/message/send接口的请求,都将返回一个ResponseMessage
                messageClient.AddMockHttpMessageHandler()
                    .AddMock<ResponseMessage>("/message/send", HttpMethod.Post, new ResponseMessage());
            } 

        }

    注意,以上通过配置中的Mock属性来决定是否开启模拟功能,为了不影响正式发布,可以通过开发环境配置(appsettings.Development.JSON)来开启模拟:


{
  "Mock": true
}

5.控制器


    [Route("api/order")]
    [ApiController]
    public class OrderController : ControllerBase
    {
        readonly HttpClient messageClient;
        public OrderController(IHttpClientFactory clientFactory)
        {
            // 创建消息服务所使用的客户端,名称与配置所使用的名称一致
            // 实际项目中千万不要写上哦~
            messageClient = clientFactory.CreateClient("MESSAGESERVICE");
        }

        [HttpPost]
        public async Task<ResponseMessage> SaveOrder([FromBody]Order order)
        {
            // 保存订单,省略了....
            // 调用消息服务接口
            ResponseMessage response = await messageClient.PostAsync<ResponseMessage>(
                "/message/send", new SendMessageRequest()
                {
                    MessageId = Guid.NewGuid().ToString("N").ToLower(),
                    Message = "订单已提交",
                    UserIds = new List<int>() { 1,2,3}
                });
            // 根据消息服务返回应答继续处理,省略了...

            return response;
        }
    }

6.启动,然后通过Api测试工具(如Postman)向/api/order POST请求,接口将返回以下应答:


{
    "code": "0",
    "message": null,
    "isSuccess": true
}

    如上,通过Http请求模拟,我们实现了订单服务对消息服务的依赖。

二、在单元测试中使用

    单元测试中,针对模拟应答的配置是一样的,我们可以通过测试用例模拟各种不同的应答,包括异常,来对执行路径进行测试。


        [Fact]
        public async Task Test1()
        {
            IServiceCollection services = new ServiceCollection()
                .AddExtensions();

            services.AddHttpClient("TESTCLIENT")
                .AddMockHttpMessageHandler()
                // 请求/test/exception将触发异常
                .AddMock("/test/exception", HttpMethod.Get, new Exception(""))
                // 针对 /test/404 返回404应答
                .AddMock("/test/404", HttpMethod.Get, httpstatusCode.NotFound)
                // 返回指定类型
                .AddMock<int>("/test/obj", HttpMethod.Get, 100)
                // 自定义条件及应答
                .AddMock(request =>
                {
                    if (request.Headers.Contains("hello"))
                    {
                        return true;
                    }
                    return false;
                }, async (request, response) =>
                {
                    // 如果是调用第三方服务,你可以在这里检查request发出的请求内容是否正确

                    // 自定义应答内容
                    await response.WriteObjectAsync(new
                    {
                        test = "Hello World"
                    });
                })
                // 针对所有请求返回字符串Hello
                .AddMock("*", HttpMethod.Get, "Hello");

            IServiceProvider provider = services.BuildServiceProvider();

            IHttpClientFactory clientFactory = provider.GetRequiredService<IHttpClientFactory>();
            HttpClient client = clientFactory.CreateClient("TESTCLIENT");
            client.BaseAddress = new Uri("http://localhost");

            HttpResponseMessage resposne = await client.GetAsync("/test/404");
            Assert.Equal(HttpStatusCode.NotFound, resposne.StatusCode);
        }

三、示例

    详细示例请参考GitHub

    Xfrogcn.AspNetCore.Extensions地址:gitHub Gitee

以上就是ASP.net core扩展库之Http请求模拟功能的使用的详细内容,更多关于ASP.Net Core Http请求模拟功能的使用的资料请关注编程网其它相关文章!

--结束END--

本文标题: ASP.NET Core扩展库之Http请求模拟功能的使用

本文链接: https://www.lsjlt.com/news/124613.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
  • ASP.NET Core扩展库之Http请求模拟功能的使用
    目录一、在服务端使用 二、在单元测试中使用 三、示例     如今,完全独立的业务应用几乎不存在,不管是在企业内部微服务之间的调用,还是与外部...
    99+
    2024-04-02
  • ASP.NET Core扩展库之Http通用扩展库的使用详解
    目录一、开启服务端请求缓冲 二、请求头传递 三、请求头日志的记录 四、Http消息上的扩展方法 五、HttpClient上的扩展方法     ...
    99+
    2024-04-02
  • ASP.NET Core扩展库之日志功能的使用详解
    目录一、简介 二、使用 三、配置 四、配置日志级别 五、日志级别的动态修改 六、本地文件日志配置 七、容器化支持 八、测试支持 九、禁用Serilog  &nbs...
    99+
    2024-04-02
  • ASP.NET Core扩展库之Http日志的使用详解
    目录一、开启服务端请求日志 二、开启客户端请求日志 三、示例     最佳实践都告诉我们不要记录请求的详细日志,因为这有安全问题,但在实际开发...
    99+
    2024-04-02
  • ASP.NET Core扩展库的功能是什么
    本篇内容介绍了“ASP.NET Core扩展库的功能是什么”的有关知识,在实际案例的操作过程中,不少人都会遇到这样的困境,接下来就让小编带领大家学习一下如何处理这些情况吧!希望大家仔细阅读,能够学有所成!亲爱的.Neter们,在我们日复一日...
    99+
    2023-06-09
  • ASP.NET Core扩展库的相关功能介绍
    目录简介日志扩展轻量级实体映射AspNetCore Http服务端的扩展HttpClient扩展令牌提供器并行队列处理亲爱的.Neter们,在我们日复一日的编码过程中是不是会遇到一些...
    99+
    2024-04-02
  • ASP.NET Core扩展库之实体映射使用详解
    目录一、启用二、配置自定义转换逻辑三、使用四、通过特性指定属性映射关系五、拷贝六、示例在分层设计模式中,各层之间的数据通常通过数据传输对象(DTO)来进行数据的传递,而大多数情况下,...
    99+
    2024-04-02
  • 如何使用golang中的net/http/httptest.NewRecorder函数模拟HTTP请求和响应
    如何使用golang中的net/http/httptest.NewRecorder函数模拟HTTP请求和响应在开发和测试Web应用程序时,经常需要模拟HTTP请求和响应。Golang提供了net/http/httptest包来方便地模拟HT...
    99+
    2023-11-18
    Golang net/http httptestNewRecorder
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作