最近在徒手造轮子，编写一个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, 就会导致这部分设置丢失。
因此正确的设置方式应该是这样的：