使用自定义DelegatingHandler编写更整洁的Typed HttpClient

最新推荐文章于 2024-01-20 20:51:33 发布
最新推荐文章于 2024-01-20 20:51:33 发布
阅读量2k 收藏
点赞数
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/farway000/article/details/106233687
版权

使用自定义DelegatingHandler编写更整洁的Typed HttpClient

简介

我写了很多HttpClient[1]，包括类型化的客户端。自从我发现Refit[2]以来，我只使用了那一个，所以我只编写了很少的代码！但是我想到了你！你们中的某些人不一定会使用Refit，[3]因此，我将为您提供一些技巧，以使用HttpClient消息处理程序[4]（尤其是DelegatingHandlers）[5]编写具有最大可重用性的类型化HttpClient[6]。

编写类型化的HttpClient来转发JWT并记录错误

这是要整理的HttpClient[7]：

using DemoRefit.Models;
using DemoRefit.Repositories;
using Microsoft.AspNetCore.Authentication;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Logging;
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;


namespace DemoRefit.HttpClients
{
    public class CountryRepositoryClient : ICountryRepositoryClient
    {
        private readonly HttpClient _client;
        private readonly IHttpContextAccessor _httpContextAccessor;
        private readonly ILogger<CountryRepositoryClient> _logger;


        public CountryRepositoryClient(HttpClient client, ILogger<CountryRepositoryClient> logger, IHttpContextAccessor httpContextAccessor)
        {
            _client = client;
            _logger = logger;
            _httpContextAccessor = httpContextAccessor;
        }


        public async Task<IEnumerable<Country>> GetAsync()
        {
            try
            {
                string accessToken = await _httpContextAccessor.HttpContext.GetTokenAsync("access_token");
                if (string.IsNullOrEmpty(accessToken))
                {
                    throw new Exception("Access token is missing");
                }
                _client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("bearer", accessToken);


                var headers = _httpContextAccessor.HttpContext.Request.Headers;
                if (headers.ContainsKey("X-Correlation-ID") && !string.IsNullOrEmpty(headers["X-Correlation-ID"]))
                {
                    _client.DefaultRequestHeaders.Add("X-Correlation-ID", headers["X-Correlation-ID"].ToString());
                }


                using (HttpResponseMessage response = await _client.GetAsync("/api/democrud"))
                {
                    response.EnsureSuccessStatusCode();
                    return await response.Content.ReadAsAsync<IEnumerable<Country>>();
                }
            }
            catch (Exception e)
            {
                _logger.LogError(e, "Failed to run http query");
                return null;
            }
        }
    }
}

这里有许多事情需要清理，因为它们在您将在同一应用程序中编写的每个客户端中可能都是多余的：

•从HttpContext读取访问令牌•令牌为空时，管理访问令牌•将访问令牌附加到HttpClient[8]进行委派•从HttpContext读取CorrelationId•将CorrelationId附加到HttpClient[9]进行委托•使用EnsureSuccessStatusCode（）验证Http查询是否成功

编写自定义的DelegatingHandler来处理冗余代码

这是DelegatingHandler[10]：

using Microsoft.AspNetCore.Authentication;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Logging;
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading;
using System.Threading.Tasks;


namespace DemoRefit.Handlers
{
    public class MyDelegatingHandler : DelegatingHandler
    {
        private readonly IHttpContextAccessor _httpContextAccessor;
        private readonly ILogger<MyDelegatingHandler> _logger;


        public MyDelegatingHandler(IHttpContextAccessor httpContextAccessor, ILogger<MyDelegatingHandler> logger)
        {
            _httpContextAccessor = httpContextAccessor;
            _logger = logger;
        }


        protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
        {
            HttpResponseMessage httpResponseMessage;
            try
            {
                string accessToken = await _httpContextAccessor.HttpContext.GetTokenAsync("access_token");
                if (string.IsNullOrEmpty(accessToken))
                {
                    throw new Exception($"Access token is missing for the request {request.RequestUri}");
                }
                request.Headers.Authorization = new AuthenticationHeaderValue("bearer", accessToken);


                var headers = _httpContextAccessor.HttpContext.Request.Headers;
                if (headers.ContainsKey("X-Correlation-ID") && !string.IsNullOrEmpty(headers["X-Correlation-ID"]))
                {
                    request.Headers.Add("X-Correlation-ID", headers["X-Correlation-ID"].ToString());
                }


                httpResponseMessage = await base.SendAsync(request, cancellationToken);
                httpResponseMessage.EnsureSuccessStatusCode();
            }
            catch (Exception ex)
            {
                _logger.LogError(ex, "Failed to run http query {RequestUri}", request.RequestUri);
                throw;
            }
            return httpResponseMessage;
        }
    }
}

如您所见，现在它封装了用于同一应用程序中每个HttpClient[11]的冗余逻辑 。

现在，清理后的HttpClient[12]如下所示：

using DemoRefit.Models;
using DemoRefit.Repositories;
using Microsoft.Extensions.Logging;
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Threading.Tasks;


namespace DemoRefit.HttpClients
{
    public class CountryRepositoryClientV2 : ICountryRepositoryClient
    {
        private readonly HttpClient _client;
        private readonly ILogger<CountryRepositoryClient> _logger;


        public CountryRepositoryClientV2(HttpClient client, ILogger<CountryRepositoryClient> logger)
        {
            _client = client;
            _logger = logger;
        }


        public async Task<IEnumerable<Country>> GetAsync()
        {
            using (HttpResponseMessage response = await _client.GetAsync("/api/democrud"))
            {
                try
                {
                    return await response.Content.ReadAsAsync<IEnumerable<Country>>();
                }
                catch (Exception e)
                {
                    _logger.LogError(e, "Failed to read content");
                    return null;
                }
            }
        }
    }
}

好多了不是吗？????

最后，让我们将DelegatingHandler[13]附加到Startup.cs中的HttpClient[14]：

using DemoRefit.Handlers;
using DemoRefit.HttpClients;
using DemoRefit.Repositories;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Refit;
using System;


namespace DemoRefit
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }


        public IConfiguration Configuration { get; }


        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddHttpContextAccessor();


            services.AddControllers();


            services.AddHttpClient<ICountryRepositoryClient, CountryRepositoryClientV2>()
                    .ConfigureHttpClient(c => c.BaseAddress = new Uri(Configuration.GetSection("Apis:CountryApi:Url").Value))
                    .AddHttpMessageHandler<MyDelegatingHandler>();
        }


        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }


            app.UseHttpsRedirection();


            app.UseRouting();


            app.UseAuthorization();


            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllers();
            });
        }
    }
}

使用Refit

如果您正在使用Refit[15]，则绝对可以重用该DelegatingHandler[16]！

例：

using DemoRefit.Handlers;
using DemoRefit.HttpClients;
using DemoRefit.Repositories;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Refit;
using System;


namespace DemoRefit
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }


        public IConfiguration Configuration { get; }


        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddHttpContextAccessor();


            services.AddControllers();


            services.AddRefitClient<ICountryRepositoryClient>()
                    .ConfigureHttpClient(c => c.BaseAddress = new Uri(Configuration.GetSection("Apis:CountryApi:Url").Value));
                    .AddHttpMessageHandler<MyDelegatingHandler>();
        }


        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }


            app.UseHttpsRedirection();


            app.UseRouting();


            app.UseAuthorization();


            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllers();
            });
        }
    }
}
轮子介绍：

Refit是一个深受Square的 Retrofit 库启发的库,目前在github上共有star 4000枚，通过这个框架，可以把你的REST API变成了一个活的接口:

public interface IGitHubApi
{
    [Get("/users/{user}")]
    Task<User> GetUser(string user);
}

RestService类生成一个IGitHubApi的实现，它使用HttpClient进行调用:

var gitHubApi = RestService.For<IGitHubApi>("https://api.github.com");


var octocat = await gitHubApi.GetUser("octocat");

查看更多：https://reactiveui.github.io/refit/

References

[1] HttpClient: https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netcore-3.0
[2] Refit: https://github.com/reactiveui/refit
[3] Refit，: https://github.com/reactiveui/refit
[4] HttpClient消息处理程序: https://docs.microsoft.com/en-us/aspnet/web-api/overview/advanced/httpclient-message-handlers
[5] DelegatingHandlers）: https://docs.microsoft.com/en-us/dotnet/api/system.net.http.delegatinghandler?view=netframework-4.8
[6] 类型化HttpClient: https://docs.microsoft.com/en-us/dotnet/architecture/microservices/implement-resilient-applications/use-httpclientfactory-to-implement-resilient-http-requests
[7] 键入的HttpClient: https://docs.microsoft.com/en-us/dotnet/architecture/microservices/implement-resilient-applications/use-httpclientfactory-to-implement-resilient-http-requests
[8] HttpClient: https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netcore-3.0
[9] HttpClient: https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netcore-3.0
[10] DelegatingHandler: https://docs.microsoft.com/en-us/dotnet/api/system.net.http.delegatinghandler?view=netframework-4.8
[11] HttpClient: https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netcore-3.0
[12] HttpClient: https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netcore-3.0
[13] DelegatingHandler: https://docs.microsoft.com/en-us/dotnet/api/system.net.http.delegatinghandler?view=netframework-4.8
[14] HttpClient: https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httpclient?view=netcore-3.0
[15] Refit: https://github.com/reactiveui/refit
[16] DelegatingHandler: https://docs.microsoft.com/en-us/dotnet/api/system.net.http.delegatinghandler?view=netframework-4.8

 

溪源More
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
HttpRequestInterceptor:DelegatingHandler的高度可配置实现，可用于模拟发送到特定路由的请求的行为
03-28
HttpRequestInterceptor DelegatingHandler的高度可配置实现，可用于模拟发送到特定路由的请求的行为。 用法 为了使用拦截器，您所需要做的就是使用您选择的DI进行注册，以下示例使用Microsoft内置的DI： public void ConfigureServices ( IServiceCollection services ) { services . Configure < Collection>>( Configuration . GetSection ( " HttpInterceptorOptions " )); services . AddTransient < InterceptingHandler>(); services . AddHtt
谈谈HttpClient使用详解
09-03
在实际应用中，根据需要可以添加错误处理、自定义配置等更复杂的逻辑。 总之，HttpClient为Java开发者提供了强大的HTTP通信工具，通过其丰富的功能和灵活的配置，可以在各种场景下方便地发送HTTP请求并处理响应，是...
Http message handle/Delegating handler
Allen_白的专栏
04-02 2244
Typically, a series of message handlers are chained together. The first handler receives an HTTP request, does some processing, and gives the request to the next handler. At some point, the response i
[译]Ocelot - Delegating Handlers
weixin_30737433的博客
09-06 169
原文 可以为HttpClient添加delegating handlers。 Usage 为了添加delegating handler需要做两件事。 首先如下一样创建一个类。 public class FakeHandler : DelegatingHandler { protected override async Task<HttpResponseMessage> Send...
在web api中进行统一安全验证类DelegatingHandler ，
weixin_34129145的博客
03-25 877
根据web api 官方参考文献总结出一下代码举例： 将 HTTP 响应消息的处理委托给另一处理程序（称为“内部处理程序”）的 HTTP 处理程序的类型。 如何理解这句话的意思？ 首先我们应知道Asp.Net Web Api 的http消息响应机制，这里我可以解释为：消息管道串联。官方代码指出：public abstract class DelegatingHandler : Sy...
自定义DelegatingHandler为ASP.NET Web Api添加压缩与解压的功能
Sinolife0605的博客
10-12 330
HTTP协议中的压缩 Http协议中使用Accept-Encoding和Content-Encoding头来表示期望Response内容的编码和当前Request的内容编码。而Http内容的压缩其实是内容编码的子集。所以也通过这两个头来描述Http Request和Response内容的压缩方式。 常用的压缩算法有gzip(采用GNU zip压缩)和deflate(采用zlib的格式...
.NET Core中使用HttpClient的正确姿势
10-18
使用HttpClientFactory不仅解决了HttpClient的资源管理问题，也使代码更整洁，降低了出错的可能性。 总结起来，.NET Core中的HttpClientFactory提供了一种优雅的方式来管理HttpClient实例，解决了直接使用...
ASP.NET Core针对一个使用HttpClient对象的类编写单元测试详解
10-17
总结来说，要对ASP.NET Core中使用HttpClient的类进行单元测试，关键在于创建自定义的HttpMessageHandler模拟网络行为，利用IHttpClientFactory进行依赖注入，并使用像XUnit这样的测试框架编写测试用例。这样不仅...
HttpClient 在Java项目中的使用详解
09-03
HttpClient是Java项目中用于访问HTTP服务的客户端库，提供了高效、灵活且功能丰富的HTTP协议支持。...相较于JDK自带的URLConnection，...通过熟练掌握HttpClient的使用，开发者能够更高效、更稳定地实现网络通信功能。
httpclient使用详解共8页.pdf.zip
10-29
总之，HttpClient是Java开发中不可或缺的HTTP通信工具，理解和熟练使用HttpClient，能帮助开发者更高效地处理HTTP请求，提升应用的网络性能。这份8页的PDF文档无疑是深入学习HttpClient的一个宝贵资源，建议开发者们...
scissors:剪刀是DelegatingHandler的高度可配置实现，可用于模拟发送到特定路由的请求的行为
03-30
它是什么？ 高度可配置实现，可用于模拟发送到特定路由的请求的行为。 用法 为了使用拦截器，您所需要做的就是使用您选择的DI进行注册，以下示例使用Microsoft内置的DI： public void ConfigureServices ( IServiceCollection services ) { services . Configure < Collection>>( Configuration . GetSection ( " HttpInterceptorOptions " )); services . AddTransient < InterceptingHandler>(); services . AddHttpClient ( " GitHubClient " , client
SpringBoot使用httpclient发送Post请求时
05-11
try(CloseableHttpClient httpClient = HttpClients.createDefault()) { HttpPost httpPost = new HttpPost(url); StringEntity stringEntity = new StringEntity(params, Charset.forName("UTF-8")); ...
JDK 11 HttpClient的基本使用指南
08-08
在Java 11及更高版本中，HttpClient是一个重要的新...通过本教程，你已经掌握了创建HttpClient、发送异步请求和处理响应的基本方法，接下来可以进一步探索高级特性和用法，比如错误处理、流处理、自定义响应处理器等。
HttpClient使用示例教程
08-17
HttpClient与JDK自带的URLConnection相比，具有更高的易用性和灵活性。 HttpClient的主要特性包括： 1. **纯净的Java实现**：完全基于Java语言，实现了HTTP 1.0和1.1规范。 2. **全面的HTTP方法支持**：覆盖了所有...
Asp.Net Core2.1前后使用HttpClient的两种方式
10-17
主要给大家介绍了关于Asp.Net Core2.1前后HttpClient的使用方式，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
把DelegatingHandler配置到特定的路由上去
jiuyejinfei的专栏
01-26 907
配置到特定的路由上去 config.Routes.MapHttpRoute( name: "DefaultApi", routeTemplate: "api/{controller}/{id}", defaults: new { id = RouteParameter.Optio
HTTPClient自定义DelegatingHandler拦截器要点
最新发布
a807460184的博客
01-20 517
以前是写前端的，感觉前端的类似axios的拦截器很方便，可以在请求的发送前后做一些通用化的操作，现在以为工作原因刚刚接触.NET，在.NET中请求库中经过挑选最后选择了HTTPClient这个类库，就在想有没有类似axios拦截库一样的功能，在查了一下官网文档，是推荐在应用程序的入口处就using，这样在整个应用周期中都可以使用HTTPClient。的调用是异步的，但是在拦截器中，无法正确的接收到这个异步方法的完成情况，所以就导致了循环请求的感觉，这个只是我目前的个人猜测，请各位大佬予以指教。
k8s之client-go和ctrl的各种k8s client
fourierr的博客
09-04 720
k8s之client-go和ctrl的各种k8s client
ASP.NET Core 2.1 中的 HttpClientFactory (Part 3) 使用Handler实现传出请求中间件
weixin_30699235的博客
08-15 512
原文：https://www.stevejgordon.co.uk/httpclientfactory-aspnetcore-outgoing-request-middleware-pipeline-delegatinghandlers发表于：2018年4月 ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值