由ASP.NET Core读取Response.Body引发的思考

前言

    前几天有群友在群里问如何在我之前的文章《ASP.NET Core WebApi返回结果统一包装实践》的时候有点疑问，主要的疑问点就是关于Respouse的读取的问题。在之前的文章《深入探究ASP.NET Core读取Request.Body的正确方式》曾分析过关于Request的读取问题，需要读取Respouse的场景同样经常遇到，比如读取输出信息或者包装一下输出结果等。无独有偶Respouse的读取同样存在类似的问题，本文我们便来分析一下如何进行Response的Body读取。

使用方式

我们在日常的使用中是如何读取流呢？很简单，直接使用StreamReader去读取，方式如下

public override void OnResultExecuted(ResultExecutedContext context)
{
    //操作流之前恢复一下操作位
    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);
}

代码很简单，直接读取即可，可是这样读取是有问题的会抛出异常System.ArgumentException:“Stream was not readable.”异常信息就是的意思是当前Stream不可读，也就是Respouse的Body是不可以被读取的。关于StreamReader到底和Stream有啥关联，我们在之前的文章深入探究ASP.NET Core读取Request.Body的正确方式一文中有过源码分析，这里就不在赘述了，有兴趣的同学可以自行翻阅，强烈建议在阅读本文之前可以看一下那篇文章，方便更容易了解。
如何解决上面的问题呢？方式也很简单，比如你想在你的程序中保证Response的Body都是可读的，你可以定义一个中间件解决这个问题。

public static IApplicationBuilder UseResponseBodyRead(this IApplicationBuilder app)
{
    return app.Use(async (context, next) =>
    {
        //获取原始的Response Body
        var originalResponseBody = context.Response.Body;
        try
        {
            //声明一个MemoryStream替换Response Body
            using var swapStream = new MemoryStream();
            context.Response.Body = swapStream;
            await next(context);
            //重置标识位
            context.Response.Body.Seek(0, SeekOrigin.Begin);
            //把替换后的Response Body复制到原始的Response Body
            await swapStream.CopyToAsync(originalResponseBody);
        }
        finally
        {
            //无论异常与否都要把原始的Body给切换回来
            context.Response.Body = originalResponseBody;
        }
    });
}

本质就是先用一个可操作的Stream比如咱们这里的MemoryStream替换默认的ResponseBody，让后续对ResponseBody的操作都是针对新的ResponseBody进行操作，完成之后把替换后的ResponseBody复制到原始的ResponseBody。最终无论异常与否都要把原始的Body给切换回来。需要注意的是，这个中间件的位置尽量要放在比较靠前的位置注册，至少也要保证在你所有要操作ResponseBody之前的位置注册。如下所示

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

源码探究

通过上面我们了解到了ResponseBody是不可以被读取的，至于为什么呢，这个我们需要通过相关源码了解一下。通过HttpContext类的源码我们可以看到相关定义

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

这里看到HttpContext本身是个抽象类，看一下它的属性HttpResponse类的定义也是一个抽象类

public abstract class HttpResponse
{
}

由上面可知Response属性是抽象的,所以抽象类HttpResponse必然包含一个子类去实现它，否则没办法直接操作相关方法。这里我们介绍一个网站https://source.dot.net用它可以更轻松的阅读微软类库的源码，比如CLR、ASP.NET Core、EF Core等等，双击一个类或者属性方法可以查找引用和定义它们的地方，非常方便，它的源码都是最新版本的，来源就是GitHub上的相关仓库。找到实例化HttpResponse的为位置在HttpContext的子类DefaultHttpContext类中[点击查看源码