如何在ASP.NET Core自定义中间件中读取Request.Body和Response.Body的内容？

原文:如何在ASP.NET Core自定义中间件中读取Request.Body和Response.Body的内容？

文章名称： 如何在ASP.NET Core自定义中间件读取Request.Body和Response.Body的内容？
做者： Lamond Lu
地址： http://www.javashuo.com/article/p-tpmbwnuf-bq.html
源代码： https://github.com/lamondlu/webapi-logger

 

背景

最近在徒手造轮子，编写一个ASP.NET Core的日志监控器，其中用到了自定义中间件读取Request.Body和Response.Body的内容，可是编写过程，并不像想象中的一路顺风，ASP.NET Core针对Request.Body和Response.Body的几个特殊设计，致使了完成以上功能须要绕一些弯路。

原始代码

为了读取Request.Body和Response.Body的内容，个人实现思路以下：

• 建立一个LoggerMiddleware的中间件，将它放置在项目中间件管道的头部。由于根据ASP.NET Core的中间件管道设计，只有第一个中间件才能获取到原始的请求信息和最终的响应信息。
  

• Request.Body和Response.Body属性都是Steram类型， 在LoggerMiddleware中间件的InvokeAsync方法中，咱们能够分别使用StreamReader读取Request.Body和Response.Body的内容。

根据以上思路，我编写了如下代码。

LoggerMiddleware.cs

public class LoggerMiddleware
    {
        private readonly RequestDelegate _next;

        public LoggerMiddleware(RequestDelegate next)
        {
            _next = next;
        }

        public async Task InvokeAsync(HttpContext context)
        {
            var requestReader = new StreamReader(context.Request.Body);

            var requestContent = requestReader.ReadToEnd();
            Console.WriteLine($"Request Body: {requestContent}");

            await _next(context);

            var responseReader = new StreamReader(context.Response.Body);
            var responseContent = responseReader.ReadToEnd();
            Console.WriteLine($"Response Body: {responseContent}");
        }
    }

Startup.cs

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseMiddleware<LoggerMiddleware>();
            app.UseDeveloperExceptionPage();
        }
        else
        {
            app.UseHsts();
        }

        app.UseHttpsRedirection();
        app.UseMvc();
    }

问题1：Response.Body的Stream不可读

这里为了测试我建立了一个默认的ASP.NET Core WebApi项目。当运行程序，使用GET方式调用/api/values以后，控制台会返回第一个须要处理的错误。

System.ArgumentException: Stream was not readable.

即ASP.NET Core默认建立的Response.Body属性是不可读的。

这一点咱们能够经过打断点看到Response.Body属性的CanRead值是false。

这就很糟糕了，ASP.NET Core默认并不想让咱们在中间件中直接读取Response.Body中的信息。

这里看似的无解，可是咱们能够转换一下思路，既然ASP.NET Core默认将Response.Body是不可读的，那么咱们就使用一个可读可写的Stream对象将其替换掉。这样当全部中间件都依次执行完以后，咱们就能够读取Response.Body的内容了。

public async Task InvokeAsync(HttpContext context)
{
     var requestReader = new StreamReader(context.Request.Body);

     var requestContent = requestReader.ReadToEnd();
     Console.WriteLine($"Request Body: {requestContent}");

     using (var ms = new MemoryStream())
     {
         context.Response.Body = ms;
         await _next(context);

         context.Response.Body.Position = 0;

         var responseReader = new StreamReader(context.Response.Body);

         var responseContent = responseReader.ReadToEnd();
         Console.WriteLine($"Response Body: {responseContent}");

         context.Response.Body.Position = 0;
     }
}

注意：

• 读取Response.Body的时候，须要设置Position = 0, 这样是为了重置指针，若是不这样作的话，会致使读取的流不正确。

• 这里千万不要用using包裹StreamReader, 由于StreamReader会在读取完Stream内容以后，将Stream关闭，致使后续因为Stream关闭，而不能再次读取Stream中的内容。若是必须使用，请使用StreamReader的如下重载，将leaveOpen参数设置为true, 确保StreamReader对象被销毁的时候不会自动关闭读取的Stream.

  public StreamReader(Stream stream, Encoding encoding, bool detectEncodingFromByteOrderMarks, int bufferSize, bool leaveOpen);

从新启动程序，请求/api/values, 咱们就获得的正确的结果。

进一步完善代码

以上代码实现，看似已经可以读取Response.Body的内容了，可是其实仍是有问题的。

回想一下，咱们作出以上方案的前提是，当前LoggerMiddleware中间件必须位于中间件管道的头部。

若是不能保证这个约定, 就会出现问题，由于咱们在LoggerMiddleware中间件中将Response.Body属性指向了一个新的可读可写的Stream对象。若是LoggerMiddleware中间件以前的某个中间件中设置过Response.Body, 就会致使这部分设置丢失。

所以正确的设置方式应该是这样的：

public async Task InvokeAsync(HttpContext context)
    {
        var originalResponseStream = context.Response.Body;

        var requestReader = new StreamReader(context.Request.Body);
        
        var requestContent = requestReader.ReadToEnd();
        Console.WriteLine($"Request Body: {requestContent}");
        

        using (var ms = new MemoryStream())
        {
            context.Response.Body = ms;
            await _next(context);


            ms.Position = 0;
            var responseReader = new StreamReader(ms);

            var responseContent = responseReader.ReadToEnd();
            Console.WriteLine($"Response Body: {responseContent}");

            ms.Position = 0;

            await ms.CopyToAsync(originalResponseStream);
            context.Response.Body = originalResponseStream;
        }
    }

代码解释：

• 这里当进入LoggerMiddleware中间件时，咱们将以前中间件操做完成以后的Response.Body对象对应的原始Stream, 保存在一个临时变量中
• 当LoggerMiddelware中间件的任务完成以后，咱们须要将后续产生的Response.Body流追加到原始Stream中，而后将Response.Body对象重置为这个新的Stream。

至此Repsonse.Body的问题都解决，下面咱们再来看一下Request.Body的问题。

问题2：Request.Body的内容能够正确的显示，可是后续的ModelBinding都失败了

下面咱们来请求POST /api/values, Request.Body里面的内容是字符串"123123"

服务器端返回了400错误， 错误信息

A non-empty request body is required.

这里就很奇怪，为啥请求体是空呢？咱们回到中间件部分代码，这里咱们在读取完Request.Body中的Stream以后，没有将Stream的指针重置，当前指针已是Stream的尾部，因此后续ModelBinding的时候，读取不到Stream的内容了。

public async Task InvokeAsync(HttpContext context)
    {
        ...
        var requestReader = new StreamReader(context.Request.Body);
        
        var requestContent = requestReader.ReadToEnd();
        Console.WriteLine($"Request Body: {requestContent}");
        ...
    }

因而，这里咱们须要采起和Response.Body相同的处理方式，在读取完Request.Body以后，咱们须要将Request.Body的Stream指针重置

public async Task InvokeAsync(HttpContext context)
    {
        ...
        var requestReader = new StreamReader(context.Request.Body);
        
        var requestContent = requestReader.ReadToEnd();
        Console.WriteLine($"Request Body: {requestContent}");
        context.Request.Body.Position = 0;
        ...
    }

你必定觉着至此问题就解决了，不过ASP.NET Core和你又开了一个玩笑。

当你从新请求POST /api/values以后，你会获得如下结果。

错误缘由：

System.NotSupportedException: Specified method is not supported.

翻译过来就是指定方法不支持。到底不支持啥呢？在代码上打上断点，你会发现Request.Body的CanSeek属性是false, 即Request.Body的Stream, 你是不能随便移动指针的，只能按顺序读取一次，默认不支持反复读取。

那么如何解决这个问题呢？

你能够在使用Request对象中的EnableRewind或者EnableBuffering。 这2个方法的做用都是在内存中建立缓冲区存放Request.Body的内容，从而容许反复读取Request.Body的Stream。

说明： 其实EnableBuffering方法内部就只直接调用的EnableRewind方法。

下面咱们修改代码

public async Task InvokeAsync(HttpContext context)
    {
        context.Request.EnableBuffering();
        var requestReader = new StreamReader(context.Request.Body);

        var requestContent = requestReader.ReadToEnd();
        Console.WriteLine($"Request Body: {requestContent}");
        context.Request.Body.Position = 0;


        using (var ms = new MemoryStream())
        {
            context.Response.Body = ms;
            await _next(context);


            ms.Position = 0;
            var responseReader = new StreamReader(ms);

            var responseContent = responseReader.ReadToEnd();
            Console.WriteLine($"Response Body: {responseContent}");

            ms.Position = 0;
        }
    }

再次请求POST /api/values, api请求被正确的处理了。