解决Asp.Net Core 3.1 中无法读取HttpContext.Request.Body的问题

最新推荐文章于 2023-10-04 12:35:41 发布
最新推荐文章于 2023-10-04 12:35:41 发布
阅读量9.1k 收藏 10
点赞数 6
分类专栏： .Net Core C#基础 文章标签： c# asp.net 后端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_43263355/article/details/107980799
版权

解决Asp.Net Core 3.1 中无法读取HttpContext.Request.Body的问题

需求

根据项目需要，要为WebApi实现一个ExceptionFilter，不仅要将WebApi执行过程中产生的异常信息进行收集，还要把WebApi的参数信息进行收集，以方便未来定位问题。

问题描述

对于WepApi的参数，一部分是通过URL获取，例如Get请求。对于Post或Put请求，表单数据是保存在Http请求的Body中的。基于此，我们可以在ExceptionFilter中，通过ExceptionContext参数，获取当前Http请求的Body数据。考虑到Body是Stream类型，读取方法如下：

public override async Task OnExceptionAsync(ExceptionContext context){
        var httpContext = context.HttpContext;
         var request = httpContext.Request;
         StreamReader sr = new StreamReader(request.Body);
         string body = await sr.ReadToEndAsync();
     }
 }

很遗憾，上面的代码读取到的Body数据为空。后来将代码移到ActionFilter，读取到的Body数据依然为空。最后将代码移到Middleware中，读取到的Body数据还是空。

问题解决

解决方案

结合Github和Stackflow类似问题的分析，得到解决方案如下，具体原因集分析请参看问题分析章节。

  1. 在Startup.cs中定义Middleware，设置缓存Http请求的Body数据。代码如下。自定义Middleware请放到Configure方法的最前面。
app.Use(next => new RequestDelegate(
          async context => {
              context.Request.EnableBuffering();
              await next(context);
          }
      ));
  1. 在Filter或Middleware中，读取Body关键代码如下。
public override async Task OnExceptionAsync(ExceptionContext context){
        var httpContext = context.HttpContext;
         var request = httpContext.Request;
         request.Body.Position = 0;
         StreamReader sr = new StreamReader(request.Body);
         string body = await sr.ReadToEndAsync();
         request.Body.Position = 0;
     }
 }

注意事项

  1. Body在ASP.NET Core 的Http请求中是以Stream的形式存在。
  2. 首行Request.Position = 0，表示设定从Body流起始位置开始，读取整个Htttp请求的Body数据。
  3. 最后一行Request.Position = 0， 表示在读取到Body后，重新设置Stream到起始位置，方便后面的Filter或Middleware使用Body的数据。
  4. 在读取Body的时候，请尽量使用异步方式读取。ASP.NET Core默认是不支持同步读取的，会抛出异常，解决方法如下：
    1. Startup.cs文件中的ConfigureServices方法中添加以下代码
  services.Configure<KestrelServerOptions>(options =>
   {
       options.AllowSynchronousIO = true;
   });
  1. Startup.cs文件中，增加Using引用。
using Microsoft.AspNetCore.Server.Kestrel.Core;

异步处理(async/await)本来就是ASP.NET Core的重要特性，因此我也是推荐使用异步方式读取Body的Stream流中的数据。

问题分析

当前的解决方案，相比于最初始的代码，增加了两点：

  • EnableBuffering(HttpRequest)方法调用，该方法会将当前请求的Body数据缓存下来。
  • 在读取Http请求的Body流时候，设置从起始位置开始读取数据。

下面我们通过如下实验，来验证上述解决方案。我们的准备工作如下：

  • 准备一个Middleware，放到所有Middleware之前执行，读取Http Post请求的body。
  • 准备一个ActionFiler（异步），读取Http Post请求的body。
  • 准备一个ExceptionFilter（异步），读取Http Post请求的body。
  • 准备一个含有分母为0的异常的Action，该Action对应一个Post请求，含有一个Club类型参数，Club是一个对足球俱乐部的描述类。

实验1

我们在代码中，不调用EnableBuffering(HttpRequest)方法。因为不调用该扩展方法，Request.Position = 0这句会抛出异常如下，因此将该句也略去，完整代码以及Action参数设定请见附录实验1。

System.NotSupportedException: Specified method is not supported.
   at Microsoft.AspNetCore.Server.Kestrel.Core.Internal.Http.HttpRequestStream.set_Position(Int64 value)
   at SportsNews.Web.Middlewares.ExceptionMiddleware.InvokeAsync(HttpContext httpContext) in D:\project\SportsNews\SportsNews.Web\Middlewares\ExceptionMiddleware.cs:line 33
   at Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware.Invoke(HttpContext context)

实验结果：

控制台执行结果：
在这里插入图片描述
Postman返回结果：
在这里插入图片描述

实验结果分析

理论上代码执行路线应该是

Middleware -> Model Binding -> ActionExecuting Filter -> Action -> Exception Filter -> ActionExecuted Filter

从控制台的显示结果来看，Action Filter和Exception Filter的代码并没有被执行。分母为0的异常也并未抛出。

根据MS提供的ASP.NET Core Http 请求的流程和Postman的请求相应，显然，异常是在数据绑定阶段（Model Binding）抛出的。
在这里插入图片描述
原因就是在不执行EnableBuffering(HttpRequest)来缓存Body的情况下，Body只能被读取一次。

而这一次在我们定义的Middleware中已经使用了，所以在后面的数据绑定阶段（Model Binding），MVC的应用程序在从Body中读取数据，反序列化成具体的对象，作为Action的参数时候，读取失败了。因为此时Body中读取到数据为空，Postman显示解析的表单JSON数据失败。

实验2

在实验1的middleware中增加EnableBuffering(HttpRequest)的调用，但是在所有代码中读取Http请求的Body后，不重置Body流到起始位置，即不增加Request.Position = 0这句。

其他代码准备同实验1，完整代码以及Action参数设定请见附录实验2。

实验2的执行结果和实验1相同，控制台和Postman的返回结果同实验1完全相同，不再赘述。

实验结果分析

虽然我们缓存了Http请求中的Body，但是没有正确使用Body流，没有在代码中将Body流设置到起始位置，再进行读取。所以实验结果表现出来的还是Body只能读一次。

实验3

在实验2的基础上，每次读取完Http请求的Body后，增加Body流重置到初始位置的代码，具体代码参见附录实验3代码。

实验3基本符合我们的预期，除了ActionExecuting Filter没有读取到Body，其他Filter， Action和Middleware全部获取到Body数据，分母为0的异常已经抛出，具体如下：

控制台：
在这里插入图片描述
Postman：

在这里插入图片描述
为什么ActionExecuting Filter没有读取到Body没有读取到Body，根据MS提供的ASP.NET Core Http 请求的流程，我们的代码执行顺序应该是这样：

Middleware -> Model Binding -> ActionExecuting Filter -> Action -> Exception Filter -> ActionExecuted Filter

在我们自定义的Middleware中，我们使用完Body，进行了重置操作，所以Model Binding阶段没有出现实验1和2中出现的异常。但是Model Binding阶段MVC应用程序会读取请求的Body，但是读取完后，没有执行重置操作。所以 在ActionExecuting Filter中没有读到Body。

但是我们在ActionExecuting Filter中进行了重置操作，所以后面的Filter可以获取到Body。

基于此，所以我们文中开始时候的解决方案，重置操作时在读取Body前和读取Body后都做的。

对于在哪缓存Http请求的Body的问题，根据MS提供的如下Http请求流程图，我建议是放到所有的Middleware之前自定义Middleware并调用EnableBuffering(HttpRequest)方法，以保证后面的Middleware， Action或Filter都可以读取到Body。

在这里插入图片描述

附录

实验1代码

  • Action代码
 [CustomerActionFilter]
 [CustomerExceptionFilterAttribute]
 [HttpPost("checkerror/{Id:int}")]
 public IActionResult GetError2 ([FromBody] Club club) {
     var a = 1;
     var b = 2;
     var c = 3;
     var d = c / (b-a*2);
     return Ok (d);
 }
  • 参数Club的定义：
public class Club {
     public int Id { get; set; }
     public string Name { get; set; }
     public string City { get; set; }

     [Column (TypeName = "date")]
     public DateTime DateOfEstablishment { get; set; }
     public string History { get; set; }
     public League League { get; set; }
     public int LeagueId { get; set; }
}
  • Postman请求参数：

{
    "Id" : 10,
    "Name" : "Real Madrid",
    "City" : "Madrid",
    "History" : "Real Madrid has long history",
    "DateOfEstablishment" : "1902-03-06",
    "LeagueId":13
}
  • Middleware 代码：

 public class ExceptionMiddleware
    {
        public RequestDelegate _next { get; }
        public string body { get; private set; }
        public ExceptionMiddleware(RequestDelegate next)
        {
            this._next = next;          
        }
        public async Task InvokeAsync(HttpContext httpContext){
            var request = httpContext.Request;
            using (StreamReader reader = new StreamReader (request.Body, Encoding.UTF8, true, 1024, true)) {
                body = await reader.ReadToEndAsync();
                System.Console.WriteLine("This is ExceptionMiddleware. Body is " + body);
            }
            await _next(httpContext);        
        }
    }
  • Exception Filter的代码：
 public class CustomerExceptionFilter: ExceptionFilterAttribute
    {
        public CustomerExceptionService _exceptionService { get; }

        public CustomerExceptionFilter(
            CustomerExceptionService exceptionService,
            IHttpContextAccessor accessor){
            this._exceptionService = exceptionService 
                                    ?? throw new ArgumentNullException(nameof(exceptionService));
        }
        public override async Task OnExceptionAsync(ExceptionContext context){
            var httpContext = context.HttpContext;
            var request = httpContext.Request;
            StreamReader sr = new StreamReader(request.Body);
            string body = await sr.ReadToEndAsync();
            System.Console.WriteLine("This is OnExceptionAsync.");
            System.Console.WriteLine("Request body is " + body);
            if (!context.ExceptionHandled) {
                context.Result = new JsonResult(new {
                	Code = 501,
                	Msg = "Please contract Administrator."
                });
            }
        }
    }
    public class CustomerExceptionFilterAttribute : TypeFilterAttribute{
        public CustomerExceptionFilterAttribute (): base(typeof(CustomerExceptionFilter)){
        }
    }
  • Action Filter的代码：

public class CustomerActionFilterAttribute: ActionFilterAttribute
    {
         public override async Task OnActionExecutionAsync(ActionExecutingContext context, ActionExecutionDelegate next){
            // before Action
            var httpContext = context.HttpContext;
            var request = httpContext.Request;
            StreamReader sr = new StreamReader(request.Body);
            string body = await sr.ReadToEndAsync();
            System.Console.WriteLine("This is OnActionExecuting.");
            System.Console.WriteLine("Request body is " + body);
            
            //Action            
            await next();

            // after Action
            //request.Body.Position = 0; 
            StreamReader sr2 = new StreamReader(request.Body);
            body = await sr2.ReadToEndAsync();
            System.Console.WriteLine("This is OnActionExecuted.");
            System.Console.WriteLine("Request body is " + body);
          //  request.Body.Position = 0;          
        } 
    }

实验2代码

  • Middleware代码：

public class ExceptionMiddleware
{
     public RequestDelegate _next { get; }
     public string body { get; private set; }
     public ExceptionMiddleware(RequestDelegate next)
     {
         this._next = next;          
     }
     public async Task InvokeAsync(HttpContext httpContext){
         var request = httpContext.Request;
         request.EnableBuffering();
         StreamReader reader = new StreamReader (request.Body) ;
         string body = await reader.ReadToEndAsync();  
         System.Console.WriteLine("This is ExceptionMiddleware. Body is " + body);
         await _next(httpContext);      
     }
 }

实验3代码

  • Middleware 代码：

 public class ExceptionMiddleware
{
     public RequestDelegate _next { get; }
     public string body { get; private set; }
     public ExceptionMiddleware(RequestDelegate next)
     {
         this._next = next;          
     }
     public async Task InvokeAsync(HttpContext httpContext){
         var request = httpContext.Request;
         request.EnableBuffering();
         StreamReader reader = new StreamReader (request.Body) ;
         string body = await reader.ReadToEndAsync(); 
         request.Body.Position = 0; 
         System.Console.WriteLine("This is ExceptionMiddleware. Body is " + body);
         await _next(httpContext);      
     }
 }
  • Exception Filter的代码：
 public class CustomerExceptionFilter: ExceptionFilterAttribute
    {
        public CustomerExceptionService _exceptionService { get; }

        public CustomerExceptionFilter(
            CustomerExceptionService exceptionService,
            IHttpContextAccessor accessor){
            this._exceptionService = exceptionService 
                                    ?? throw new ArgumentNullException(nameof(exceptionService));
        }
        public override async Task OnExceptionAsync(ExceptionContext context){
            var httpContext = context.HttpContext;
            var request = httpContext.Request;
            StreamReader sr = new StreamReader(request.Body);
            string body = await sr.ReadToEndAsync();
            request.Body.Position = 0;
            System.Console.WriteLine("This is OnExceptionAsync.");
            System.Console.WriteLine("Request body is " + body);
            if (!context.ExceptionHandled) {
                context.Result = new JsonResult(new {
                	Code = 501,
                	Msg = "Please contract Administrator."
                });
            }
        }
    }
    public class CustomerExceptionFilterAttribute : TypeFilterAttribute{
        public CustomerExceptionFilterAttribute (): base(typeof(CustomerExceptionFilter)){
        }
    }
  • Action Filter的代码：

public class CustomerActionFilterAttribute: ActionFilterAttribute
    {
         public override async Task OnActionExecutionAsync(ActionExecutingContext context, ActionExecutionDelegate next){
            // before Action
            var httpContext = context.HttpContext;
            var request = httpContext.Request;
            StreamReader sr = new StreamReader(request.Body);
            string body = await sr.ReadToEndAsync();
            request.Body.Position = 0;
            System.Console.WriteLine("This is OnActionExecuting.");
            System.Console.WriteLine("Request body is " + body);
            
            //Action            
            await next();

            // after Action
            //request.Body.Position = 0; 
            StreamReader sr2 = new StreamReader(request.Body);
            body = await sr2.ReadToEndAsync();
            request.Body.Position = 0;
            System.Console.WriteLine("This is OnActionExecuted.");
            System.Console.WriteLine("Request body is " + body);
          //  request.Body.Position = 0;          
        } 
    }
懒人Ethan
关注
  • 6
    点赞
  • 踩
  • 10
    收藏
    觉得还不错? 一键收藏
  • 3
    评论
专栏目录
AspNetCoreCurrentRequestContext:在ASP.NET Core应用程序上启用HttpContext.Current
05-15
AspNetCoreCurrentRequestContext 启用在ASP.NET Core应用程序上使用HttpContext.Current。 安装 从NuGet- PM > Install-Package AspNetCoreCurrentRequestContext 如何使用 首先，您必须在Startup类中的Configure方法IApplicationBuilder CurrentRequestContextMiddleware添加到IApplicationBuilder 。 您可以使用扩展方法UseCurrentRequestContext来实现。 public class Startup { public void Configure ( IApplicationBuilder app ) { // add CurrentReq
【ASP.NET编程知识】在ASP.NET Core5.0中访问HttpContext的方法步骤.docx
05-21
【ASP.NET编程知识】在ASP.NET Core5.0中访问HttpContext的方法步骤.docx
ASP.NET Core MVC从入门到精通系列文章PDF版
06-30
ASP.NET Core MVC从入门到精通系列文章。 本系列文章共计20篇，主要包括ASP.NET Core MVC项目创建，启动运行，以及命名约定，创建控制器，视图，模型，接收参数，传递数据ViewData，ViewBag，路由，页面布局，wwwroot和客户端库，Razor语法，EnityFrameworkCore与数据库，HttpContext，Request，Response，Session，序列化，文件上传，自动映射，Html辅助标签，模型校验，鉴权、授权基础，Identity入门，日志管理，Filter(筛选器)，缓存等内容。 具体可参考本人博客
【ASP.NET编程知识】ASP.NET Core读取Request.Body的正确方法.docx
05-15
【ASP.NET编程知识】ASP.NET Core读取Request.Body的正确方法.docx
在ASP.NET Core5.0中访问HttpContext的方法步骤
12-16
ASP.NET Core 应用通过 IHttpContextAccessor 接口及其默认实现 HttpContextAccessor 访问 HttpContext。 只有在需要访问服务内的 HttpContext 时，才有必要使用 IHttpContextAccessor。 通过 Razor Pages 使用 HttpContext Razor Pages PageModel 公开 HttpContext 属性： public class AboutModel : PageModel { public string Message { get; set; } public voi
解决.net core下HttpContext.Request.Body多次读取出现异常的问题
frankjie的博客
12-05 8968
如下面的代码，使用StreamReader多次读取HttpContext.Request.Body public IActionResult SomeAction() { using (var reader = new StreamReader(Request.Body)) { var body = reader.ReadToEnd(); // ...
解决ASP.NET Core的中间件无法读取Response.Body的问题
最新发布
weixin_43263355的博客
10-04 1657
本文主要介绍如何在ASP.NET Core的中间件中，读取Response.Body的方法，以便于我们实现更多的定制化开发。本文介绍的方法适用于.Net 3.1 和 .Net 6。
Jayway - context.read 读取数据以及类型转换问题
牧码的博客
07-01 674
String status = String.valueOf(natiCtx.read(apiCodepath)); Ps：不能把 read 的结果，直接放到 valueOf 因为外面是 T 类型。应该先转成 Object 或者其他类型，再进行 valueOf，如下代码： Object statusVal = natiCtx.read(apiCodepath); String status = String.valueOf(statusVal); ...
net core下HttpContext.Request.Body多次读取出现异常,被释放了
08-10 709
public IActionResult SomeAction() { using (var mem = new MemoryStream()) using (var reader = new StreamReader(mem)) { Request.Body.Seek(0, SeekOrigin.Begin); Request.Body...
ASP.NET Core 中不能多次读取 Request.Body和设置Position的问题
carcarrot的博客
07-25 1335
Asp.Net Core与以往Asp.Net在对待HttpContext.Request的Steam（在.Net Core中是属性Body，.Net中对应的属性是InputStream）的处理机制有点不同，Asp.NetCore的Request.Body默认情况下不允许 Request.Body.Position=0 ，这就意味着只能读取一次，要想多次读取，在 ASP.NET Core 2.1 中提供的解决方法是在第一次读取前通过Request.EnableRewind()【需要引用命名空间Micro...
Request.Body替代Request.InputStream 数据异常
123po
11-09 688
刚用.net Core 整理微信平台发布的消息发现.net Core 没有 HttpContext.Current.Request.InputStream 找了一下发现有 Request.Body 然后就替换了 后来又发现Request.Body 取不到数据将代码移到ActionFilter，读取到的Body数据依然为空。最后将代码移到Middleware中，读取到的Body数据还是空。 问题解决 网上搜了一圈发现.net Core缓存Http请求的Body数据 只能读取一次 ...
一个比较强大的HTTP请求类，支持文本参数和文件参数。
altzlo7909的博客
03-27 480
一个 http 请求类 ，支持文件上传，从淘宝 top sdk 里面扣出来的，蛮好用的，做个记录而已。 调用代码： 　　　　　　　Dictionary<string, string> textParas = new Dictionary<string, string>(); textParas.Add("username", "j...
Asp.Net Core 3.1 获取不到Post、Put请求的内容 System.NotSupportedException Specified method is not supported
极客神殿
12-18 2060
但这段代码 在和(没错特地升级过) 都读不到、获取不到Post。
NetCore3.1 读取Request.Body异常 Cannot access a disposed object Object name FileBufferingReadStream
csdn_aspnet的专栏
07-14 620
NetCore3.1 过滤器内读取Body内容_csdn_aspnet的博客-CSDN博客有需要的的伙伴可以参考，也可以私信给我，或者有更好的方法分享给我，谢谢。
.net core 获取请求内容（Request、Body）
Stodger0216的博客
03-26 7898
.Net Core 对于body多次读取，.net core2.0使用EnableRewind()，.net core 3.0使用EnableBuffering()，该参数在第一次读取body之前开启，之后body信息可以多次读取；core时代取消了之前的stream.position=0写法，虽然var byts = new byte[request.ContentLength.Value]...
.net core 多次读取request.body的方法
zhangwenjie1105的专栏
08-10 4529
1. 安装包 Microsoft.AspNetCore.Http 2. public override void OnActionExecuting(ActionExecutingContext filterContext) { // 使request.body可以读取多次 filterContext.HttpContext.Re...
Net5.0里面通过HttpContext获取post、get请求参数信息
qq_37213281的博客
01-13 4179
项目场景： net5.0中使用httpcontext获取里面传输的post,get参数 直接上代码： //获取post参数 思路：以流的形式读取body里面的参数 public async Task Invoke(HttpContext context) { HttpRequest request = context.Request; Stream straem = request.Body; Encoding encoding = Encoding.UTF8; stri
asp.net core 3.1 公共类里获取 HttpContext 的方法
沐雪大神
08-25 2599
场景： 在开发web项目的时候，写一些通用的公共方法是很常见的操作，而一些关于Http的操作，经常会用到HttpContext这个对象。 若是在Controller里，我们操作就很简单，可以使用注入的方法直接使用：，比如以下代码： public class HomeController : Controller { private IHttpContextAccessor _accessor; public HomeController(IHttpContextAccessor
Request Body数据读取
琪琪的博客
11-17 3489
拦截器要读取request body数据的话需要注意一个问题，一旦拦截器把数据流从request读取出来后，后区的接口层就拿不到数据了，因为流是一次性的，那么要解决这个问题，我们就需要在拦截器取出流拿到数据后重新将数据放回流，这样后面的接口层就能正常获取到数据了 下面放出代码实现： @Component @Order(10000) @WebFilter(filterName = "HttpServletRequestFilter", urlPatterns = "/") public class Ht
.net core3.1 写一个过滤器用来验证sesion
05-27
在 .NET Core 3.1 中，可以使用过滤器来验证 Session。具体实现步骤如下： 1. 创建一个 Session 验证过滤器类，继承自 ActionFilterAttribute： ```csharp public class SessionValidationFilter : ActionFilterAttribute { public override void OnActionExecuting(ActionExecutingContext context) { var session = context.HttpContext.Session.GetString("UserName"); if (string.IsNullOrEmpty(session)) { context.Result = new RedirectToActionResult("Index", "Login", null); } } } ``` 2. 在需要验证 Session 的 Controller 或 Action 上，添加该过滤器的特性： ```csharp [SessionValidationFilter] public class HomeController : Controller { //... } ``` 这样，当请求到达该 Controller 或 Action 时，就会先执行 SessionValidationFilter 过滤器中的 OnActionExecuting 方法。在该方法中，我们通过 HttpContext.Session.GetString("UserName") 方法获取 Session 中的 UserName 值，如果为空则重定向到登录页面。如果验证通过，则会继续执行后续的 Action。 需要注意的是，使用 Session 验证过滤器需要先在 Startup.cs 中启用 Session，添加以下代码： ```csharp public void ConfigureServices(IServiceCollection services) { //... services.AddDistributedMemoryCache(); services.AddSession(options => { options.IdleTimeout = TimeSpan.FromMinutes(30); options.Cookie.HttpOnly = true; options.Cookie.IsEssential = true; }); //... } ``` 这样就可以在 .NET Core 3.1 中实现 Session 验证过滤器了。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值