位置：首页-资讯-后端开发

怎么在ASP.NET中使用Http通用扩展库

2023-06-14 14:16

短信预约 -IT技能 免费直播动态提醒

怎么在ASP.NET中使用Http通用扩展库？相信很多没有经验的人对此束手无策，为此本文总结了问题出现的原因和解决方法，通过这篇文章希望你能解决这个问题。

ASP.NET 是什么

ASP.NET 是开源，跨平台，高性能，轻量级的 Web 应用构建框架，常用于通过 HTML、CSS、JavaScript 以及服务器脚本来构建网页和网站。

一、开启服务端请求缓冲

ASP.NET Core 中请求体是不能多次读取的，由于在MVC中，框架已经读取过请求体，如果你在控制器中再次读取，将会引发异常，如下示例：

[ApiController]    [Route("[controller]")]    public class TestController : ControllerBase    {         public TestController()        {        }        [HttpPost]        public async Task<WeatherForecast> Save([FromBody]WeatherForecast enttiy)        {            using (StreamReader reader = new StreamReader(Request.Body))            {                Request.Body.Position = 0;                string response = await reader.ReadToEndAsync();            }            return enttiy;        }    }

当通过Post请求/test接口时，语句 Request.Body.Position 将触发异常：

System.NotSupportedException: Specified method is not supported.   at Microsoft.AspNetCore.Server.Kestrel.Core.Internal.Http.HttpRequestStream.set_Position(Int64 value)

当然，实际中可能不会像示例这样处理请求，但在业务需求中，的确可能会有多次读取请求体的情况出现。

通过开启请求缓冲可以解决多次读取请求体的问题，Xfrogcn.AspNetCore.Extensions扩展库提供了EnableBufferingAttribute特性用于开启请求缓冲，你可以将此特性用于控制器或者Action方法。

以上示例，只需在Save方法上添加EnableBuffering特性：

[HttpPost]    [EnableBuffering]    public async Task<WeatherForecast> Save([FromBody]WeatherForecast enttiy)    {        ....    }

二、请求头传递

微服务架构下，通常我们使用请求头来实现请求的链路跟踪以及日志与请求的关联，例如，通过x-request-id，在日志系统中可以直接查看某一个请求在所有服务中的相关日志。

扩展库通过拦截HttpClient请求管道，可实现对指定请求头的自动传递。默认配置下，扩展库会自动传递以"x-"开始的请求头，如果你需要传递其他的请求头，可通过配置中的TrackingHeaders来添加。

IServiceCollection services = new ServiceCollection()        .AddExtensions(null, config =>        {            // 自动传递以my-为前缀的请求头            config.TrackingHeaders.Add("my-*");        });

三、请求头日志的记录

.NET Core日志框架中，实现了日志范围的概念，通过日志范围，可以让日志系统记录当前上下文的信息，例如，ASP.NET Core MVC中，日志范围包含ActionContext相关信息，故可以在一个请求的所有日志中都可自动记录Action的相关信息。

扩展库可以将配置的请求头加入请求的日志范围，例如，默认配置下，扩展库会将x-request-id加入到请求的日志范围，所以在单一请求中的所有日志，都可自动携带x-request-id信息，以此实现跨服务的日志关联。要包含其他的请求头，可以通过配置中的HttpHeaders来设置：

IServiceCollection services = new ServiceCollection()        .AddExtensions(null, config =>        {            // 将my-id请求头包含到日志范围            config.HttpHeaders.Add("my-id");        });

注意: 默认的控制台日志、文件日志不会保存日志范围的相关信息，你可以使用json格式的控制台日志或文件日志，在此格式下将保存日志范围中的数据。

IServiceCollection services = new ServiceCollection()        .AddExtensions(null, config =>        {            config.ConsoleJsonLog = true;        });

四、Http消息上的扩展方法

扩展库在HttpRequestMessage上提供了GetObjectAsync、WriteObjectAsync扩展方法，以便于对请求消息的读写。在HttpResponseMessage上提供了GetObjectAsync、WriteObjectAsync扩展方法，以便于对应答消息的读写。这些方法都采用json格式。

示例：

public class WeatherForecast    {        public DateTime Date { get; set; }        public int TemperatureC { get; set; }        public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);        public string Summary { get; set; }    }

static async Task Main(string[] args)    {        IServiceCollection services = new ServiceCollection()            .AddExtensions(null, config =>            {            });        IServiceProvider serviceProvider = services.BuildServiceProvider();        IHttpClientFactory factory = serviceProvider.GetRequiredService<IHttpClientFactory>();        HttpClient client = factory.CreateClient();        HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:5000/test");                // 写入请求对象        await request.WriteObjectAsync(new WeatherForecast()        {            Date = DateTime.Now        });        request.Content.Headers.ContentType = new MediaTypeHeaderValue("application/json");        // 读取请求对象        var entity = await request.GetObjectAsync<WeatherForecast>();        HttpResponseMessage response = await client.SendAsync(request);        // 读取应答对象        entity = await response.GetObjectAsync<WeatherForecast>();        Console.ReadLine();    }