快捷導(dǎo)航

ASP.NET Core擴(kuò)展庫之Http通用擴(kuò)展庫的使用詳解

更新時(shí)間：2021年04月20日 11:33:52 作者：xfrog

這篇文章主要介紹了ASP.NET Core擴(kuò)展庫之Http通用擴(kuò)展庫的使用詳解，幫助大家更好的理解和學(xué)習(xí)使用.net技術(shù)，感興趣的朋友可以了解下

本文將介紹Xfrogcn.AspNetCore.Extensions擴(kuò)展庫對(duì)于Http相關(guān)的其他功能擴(kuò)展，這些功能旨在處理一些常見需求, 包括請(qǐng)求緩沖、請(qǐng)求頭傳遞、請(qǐng)求頭日志范圍、針對(duì)HttpClient與HttpRequestMessage、HttpResponseMessage的擴(kuò)展方法。

一、開啟服務(wù)端請(qǐng)求緩沖

ASP.NET Core 中請(qǐng)求體是不能多次讀取的，由于在MVC中，框架已經(jīng)讀取過請(qǐng)求體，如果你在控制器中再次讀取，將會(huì)引發(fā)異常，如下示例：

    [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;
        }
    }

當(dāng)通過Post請(qǐng)求/test接口時(shí)，語句 Request.Body.Position 將觸發(fā)異常：

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

當(dāng)然，實(shí)際中可能不會(huì)像示例這樣處理請(qǐng)求，但在業(yè)務(wù)需求中，的確可能會(huì)有多次讀取請(qǐng)求體的情況出現(xiàn)。

通過開啟請(qǐng)求緩沖可以解決多次讀取請(qǐng)求體的問題，Xfrogcn.AspNetCore.Extensions擴(kuò)展庫提供了EnableBufferingAttribute特性用于開啟請(qǐng)求緩沖，你可以將此特性用于控制器或者Action方法。

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

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

二、請(qǐng)求頭傳遞

微服務(wù)架構(gòu)下，通常我們使用請(qǐng)求頭來實(shí)現(xiàn)請(qǐng)求的鏈路跟蹤以及日志與請(qǐng)求的關(guān)聯(lián)，例如，通過x-request-id，在日志系統(tǒng)中可以直接查看某一個(gè)請(qǐng)求在所有服務(wù)中的相關(guān)日志。

擴(kuò)展庫通過攔截HttpClient請(qǐng)求管道，可實(shí)現(xiàn)對(duì)指定請(qǐng)求頭的自動(dòng)傳遞。默認(rèn)配置下，擴(kuò)展庫會(huì)自動(dòng)傳遞以"x-"開始的請(qǐng)求頭，如果你需要傳遞其他的請(qǐng)求頭，可通過配置中的TrackingHeaders來添加。

    IServiceCollection services = new ServiceCollection()
        .AddExtensions(null, config =>
        {
            // 自動(dòng)傳遞以my-為前綴的請(qǐng)求頭
            config.TrackingHeaders.Add("my-*");
        });

三、請(qǐng)求頭日志的記錄

.NET Core日志框架中，實(shí)現(xiàn)了日志范圍的概念，通過日志范圍，可以讓日志系統(tǒng)記錄當(dāng)前上下文的信息，例如，ASP.NET Core MVC中，日志范圍包含ActionContext相關(guān)信息，故可以在一個(gè)請(qǐng)求的所有日志中都可自動(dòng)記錄Action的相關(guān)信息。

擴(kuò)展庫可以將配置的請(qǐng)求頭加入請(qǐng)求的日志范圍，例如，默認(rèn)配置下，擴(kuò)展庫會(huì)將x-request-id加入到請(qǐng)求的日志范圍，所以在單一請(qǐng)求中的所有日志，都可自動(dòng)攜帶x-request-id信息，以此實(shí)現(xiàn)跨服務(wù)的日志關(guān)聯(lián)。要包含其他的請(qǐng)求頭，可以通過配置中的HttpHeaders來設(shè)置：

    IServiceCollection services = new ServiceCollection()
        .AddExtensions(null, config =>
        {
            // 將my-id請(qǐng)求頭包含到日志范圍
            config.HttpHeaders.Add("my-id");
        });

注意: 默認(rèn)的控制臺(tái)日志、文件日志不會(huì)保存日志范圍的相關(guān)信息，你可以使用json格式的控制臺(tái)日志或文件日志，在此格式下將保存日志范圍中的數(shù)據(jù)。

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

四、Http消息上的擴(kuò)展方法

擴(kuò)展庫在HttpRequestMessage上提供了GetObjectAsync、WriteObjectAsync擴(kuò)展方法，以便于對(duì)請(qǐng)求消息的讀寫。在HttpResponseMessage上提供了GetObjectAsync、WriteObjectAsync擴(kuò)展方法，以便于對(duì)應(yīng)答消息的讀寫。這些方法都采用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");
        
        // 寫入請(qǐng)求對(duì)象
        await request.WriteObjectAsync(new WeatherForecast()
        {
            Date = DateTime.Now
        });
        request.Content.Headers.ContentType = new MediaTypeHeaderValue("application/json");

        // 讀取請(qǐng)求對(duì)象
        var entity = await request.GetObjectAsync<WeatherForecast>();

        HttpResponseMessage response = await client.SendAsync(request);

        // 讀取應(yīng)答對(duì)象
        entity = await response.GetObjectAsync<WeatherForecast>();

        Console.ReadLine();
    }