前言

????前幾天有群友在群里問(wèn)如何在我之前的文章《ASP.NET Core WebApi返回結(jié)果統(tǒng)一包裝實(shí)踐》的時(shí)候有點(diǎn)疑問(wèn)，主要的疑問(wèn)點(diǎn)就是關(guān)于Respouse的讀取的問(wèn)題。在之前的文章《深入探究ASP.NET Core讀取Request.Body的正確方式》曾分析過(guò)關(guān)于Request的讀取問(wèn)題，需要讀取Respouse的場(chǎng)景同樣經(jīng)常遇到，比如讀取輸出信息或者包裝一下輸出結(jié)果等。無(wú)獨(dú)有偶Respouse的讀取同樣存在類似的問(wèn)題，本文我們便來(lái)分析一下如何進(jìn)行Response的Body讀取。

使用方式

我們?cè)谌粘５氖褂弥惺侨绾巫x取流呢？很簡(jiǎn)單，直接使用StreamReader去讀取，方式如下

public override void OnResultExecuted(ResultExecutedContext context)
{
    //操作流之前恢復(fù)一下操作位
    context.HttpContext.Response.Body.Position = 0;

    StreamReader stream = new StreamReader(context.HttpContext.Response.Body);
    string body = stream.ReadToEnd();
    _logger.LogInformation("body content:" + body);

    context.HttpContext.Response.Body.Position = 0;
    base.OnResultExecuted(context);
}

代碼很簡(jiǎn)單，直接讀取即可，可是這樣讀取是有問(wèn)題的會(huì)拋出異常System.ArgumentException:“Stream was not readable.”異常信息就是的意思是當(dāng)前Stream不可讀，也就是Respouse的Body是不可以被讀取的。關(guān)于StreamReader到底和Stream有啥關(guān)聯(lián)，我們?cè)谥暗奈恼律钊胩骄緼SP.NET Core讀取Request.Body的正確方式一文中有過(guò)源碼分析，這里就不在贅述了，有興趣的同學(xué)可以自行翻閱，強(qiáng)烈建議在閱讀本文之前可以看一下那篇文章，方便更容易了解。
如何解決上面的問(wèn)題呢？方式也很簡(jiǎn)單，比如你想在你的程序中保證Response的Body都是可讀的，你可以定義一個(gè)中間件解決這個(gè)問(wèn)題。

public static IApplicationBuilder UseResponseBodyRead(this IApplicationBuilder app)
{
    return app.Use(async (context, next) =>
    {
        //獲取原始的Response Body
        var originalResponseBody = context.Response.Body;
        try
        {
            //聲明一個(gè)MemoryStream替換Response Body
            using var swapStream = new MemoryStream();
            context.Response.Body = swapStream;
            await next(context);
            //重置標(biāo)識(shí)位
            context.Response.Body.Seek(0, SeekOrigin.Begin);
            //把替換后的Response Body復(fù)制到原始的Response Body
            await swapStream.CopyToAsync(originalResponseBody);
        }
        finally
        {
            //無(wú)論異常與否都要把原始的Body給切換回來(lái)
            context.Response.Body = originalResponseBody;
        }
    });
}

本質(zhì)就是先用一個(gè)可操作的Stream比如咱們這里的MemoryStream替換默認(rèn)的ResponseBody，讓后續(xù)對(duì)ResponseBody的操作都是針對(duì)新的ResponseBody進(jìn)行操作，完成之后把替換后的ResponseBody復(fù)制到原始的ResponseBody。最終無(wú)論異常與否都要把原始的Body給切換回來(lái)。需要注意的是，這個(gè)中間件的位置盡量要放在比較靠前的位置注冊(cè)，至少也要保證在你所有要操作ResponseBody之前的位置注冊(cè)。如下所示

var app = builder.Build();
app.UseResponseBodyRead();

源碼探究

通過(guò)上面我們了解到了ResponseBody是不可以被讀取的，至于為什么呢，這個(gè)我們需要通過(guò)相關(guān)源碼了解一下。通過(guò)HttpContext類的源碼我們可以看到相關(guān)定義

public abstract class HttpContext
{
    public abstract HttpResponse Response { get; }
}

這里看到HttpContext本身是個(gè)抽象類，看一下它的屬性HttpResponse類的定義也是一個(gè)抽象類

public abstract class HttpResponse
{
}

由上面可知Response屬性是抽象的,所以抽象類HttpResponse必然包含一個(gè)子類去實(shí)現(xiàn)它，否則沒(méi)辦法直接操作相關(guān)方法。這里我們介紹一個(gè)網(wǎng)站https://source.dot.net用它可以更輕松的閱讀微軟類庫(kù)的源碼，比如CLR、ASP.NET Core、EF Core等等，雙擊一個(gè)類或者屬性方法可以查找引用和定義它們的地方，非常方便，它的源碼都是最新版本的，來(lái)源就是GitHub上的相關(guān)倉(cāng)庫(kù)。找到實(shí)例化HttpResponse的為位置在HttpContext的子類DefaultHttpContext類中[點(diǎn)擊查看源碼