ASP.NET Core扩展库之Http通用扩展库的使用详解

POOPE

目录

• 一、开启服务端请求缓冲
  
• 二、请求头传递
  
• 三、请求头日志的记录
  
• 四、Http消息上的扩展方法
  
• 五、HttpClient上的扩展方法
  

　　本文将介绍Xfrogcn.AspNetCore.Extensions扩展库对于Http相关的其他功能扩展，这些功能旨在处理一些常见需求, 包括请求缓冲、请求头传递、请求头日志范围、针对HttpClient与HttpRequestMessage、HttpResponseMessage的扩展方法。

一、开启服务端请求缓冲

　　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();
  }

五、HttpClient上的扩展方法

　　为了更方便快捷地使用HttpClient，扩展库在HttpClient上增加了多个扩展方法：

   

• PostAsync<TResponse>: 发送对象到服务端，并获取指定类型的应答   
  
• PostAsync: 发送对象到服务端，并获取应答字符串   
  
• GetAsync<TResponse>: 发送Get请求，并获取TResponse类型的应答   
  
• GetAsync: 发送Get请求，并获取String类型的应答   
  
• SubmitFormAsync<TResponse>: 向服务器提交表单数据，并获取TResponse类型的应答   
  
• SubmitFormAsync: 向服务器提交表单数据，并获取String类型的应答   
  
• UploadFileAsync<TResponse>: 上次本地文件   
  
• UploadStreamAsync<TResponse>: 上传流数据到服务器
  

　　有关这些扩展方法的详细说明，可参考文档 GitHub Gitee
　　Xfrogcn.AspNetCore.Extensions地址：GitHub Gitee
　　以上就是ASP.NET Core扩展库之Http通用扩展库的使用详解的详细内容，更多关于ASP.NET Core扩展库之Http通用扩展库的资料请关注脚本之家其它相关文章！