.Net Core 中间件

最新推荐文章于 2024-01-14 14:03:39 发布
最新推荐文章于 2024-01-14 14:03:39 发布
阅读量398 收藏
点赞数 2
分类专栏： .net core 文章标签： 中间件
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_33649351/article/details/119593502
版权

.Net Core 中间件

中间件的工作原理

中间件的设计模式是责任链模式，下图是微软官方的中间件执行流程图：
微软官方的中间件执行流程图

中间件的执行顺序

  • 当接收到请求时，中间件会按注册顺序依次执行处理逻辑；
  • 响应请求时，中间件会按注册顺序导入执行响应处理逻辑；
  • 中间件可以起到断路器的作用，中断执行后注册的中间件。

两个核心对象

  • IApplicationBuilder ：用于注册Middleware。
  • RequestDelegate ：处理HTTP请求的函数委托；参数是请求上下文 HttpContext ；可以将其理解为ASP.NET Core中对一切HTTP请求处理的抽象，没有它整个框架就失去了对HTTP请求的处理能力。

中间件的使用

使用 Use 注入委托：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    app.Use(async (context, next) =>
    {
        await next(); // 交由下一中间件处理
        if (context.Response.HasStarted)
        {
            // 一旦已经开始输出，则不能再修改响应头的内容
        }
        await context.Response.WriteAsync("Hello");
    });
}

使用 Map ：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    app.Map("/abc", abcBuilder =>
    {
        abcBuilder.Use(async (context, next) =>
        {
            await next();
            await context.Response.WriteAsync("Hello");
        });
    });
}

使用 MapWhen ：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
     app.MapWhen(context =>
     {
         return context.Request.Query.Keys.Contains("abc");
     }, builder =>
     {
         builder.Run(async context =>
         {
             await context.Response.WriteAsync("new abc");
         });
     });
}

自定义中间件

自定义中间件需要包含 public async Task InvokeAsync(HttpContext context) 方法：

class MyMiddleware
{
    RequestDelegate _next;
    ILogger _logger;
    public MyMiddleware(RequestDelegate next, ILogger<MyMiddleware> logger)
    {
        _next = next;
        _logger = logger;
    }

    public async Task InvokeAsync(HttpContext context)
    {
        using (_logger.BeginScope("TraceIdentifier:{TraceIdentifier}", context.TraceIdentifier))
        {
            _logger.LogDebug("开始执行");
            
            await _next(context);

            _logger.LogDebug("执行结束");
        }
    }
}

扩展 IApplicationBuilder ：

public static class MyBuilderExtensions
{
    public static IApplicationBuilder UseMyMiddleware(this IApplicationBuilder app)
    {
        return app.UseMiddleware<MyMiddleware>();
    }
}

注册 MyMiddleware ：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    app.UseMyMiddleware();
}

异常处理中间件

处理异常有以下几种方式：

  • 异常处理页
  • 异常处理匿名委托方法
  • IExceptionFilter
  • ExceptionFilterAttribute

异常处理页

在研发环境下，可以使用 UseDeveloperExceptionPage 中间件，可以将异常详细的展示出来，便于定位问题：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
	if (env.IsDevelopment())
	{
	    app.UseDeveloperExceptionPage();
	}
}

在实际生成环境下，可以使用 UseExceptionHandler 跳转到自定义异常页面：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
	app.UseExceptionHandler("/error");
}

异常处理匿名委托方法

在前后端分离的项目中，可以使用匿名委托的方式返回错误码及错误信息给前端。
首先先定义服务的业务异常：

    public interface IKnownException
    {
        public string Message { get; }

        public int ErrorCode { get; }

        public object[] ErrorData { get; }
    }

    public class KnownException : IKnownException
    {
        public string Message { get; private set; }

        public int ErrorCode { get; private set; }

        public object[] ErrorData { get; private set; }

        public readonly static IKnownException Unknown = new KnownException { Message = "未知错误", ErrorCode = 9999 };

        public static IKnownException FromKnownException(IKnownException exception)
        {
            return new KnownException { Message = exception.Message, ErrorCode = exception.ErrorCode, ErrorData = exception.ErrorData };
        }
    }
    
    public class MyServerException : Exception, IKnownException
    {
        public MyServerException(string message, int errorCode, params object[] errorData) : base(message)
        {
            this.ErrorCode = errorCode;
            this.ErrorData = errorData;
        }

        public int ErrorCode { get; private set; }
        public object[] ErrorData { get; private set; }
    }

然后使用匿名委托注入异常处理逻辑：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    app.UseExceptionHandler(errApp =>
    {
        errApp.Run(async context =>
        {
            var exceptionHandlerPathFeature = context.Features.Get<IExceptionHandlerPathFeature>();
            IKnownException knownException = exceptionHandlerPathFeature.Error as IKnownException;
            if (knownException == null)
            {
                var logger = context.RequestServices.GetService<ILogger<Startup>>();
                logger.LogError(exceptionHandlerPathFeature.Error, exceptionHandlerPathFeature.Error.Message);
                knownException = KnownException.Unknown;
                context.Response.StatusCode = StatusCodes.Status500InternalServerError;
            }
            else
            {
                knownException = KnownException.FromKnownException(knownException);
                context.Response.StatusCode = StatusCodes.Status200OK;
            }
            var jsonOptions = context.RequestServices.GetService<IOptions<JsonOptions>>();
            context.Response.ContentType = "application/json; charset=utf-8";
            await context.Response.WriteAsync(System.Text.Json.JsonSerializer.Serialize(knownException, jsonOptions.Value.JsonSerializerOptions));
        });
    });
}

异常抛出：

//throw new Exception("报个错");
throw new MyServerException("服务出错了", 65);

异常处理结果：

{
message: "服务出错了",
errorCode: 65,
errorData: [ ]
}

IExceptionFilter

使用 IExceptionFilter 时，能捕获到在 Controller 里面输出的错误；如果是在 MVC 的中间件之前输出的错误，它是没办法处理的。如果需要对 Controller 进行特殊的异常处理，可以使用 IExceptionFilter 。
使用时，先定义自己的 ExceptionFilter ：

public class MyExceptionFilter : IExceptionFilter
{
    public void OnException(ExceptionContext context)
    {
        IKnownException knownException = context.Exception as IKnownException;
        if (knownException == null)
        {
            var logger = context.HttpContext.RequestServices.GetService<ILogger<MyExceptionFilter>>();
            logger.LogError(context.Exception, context.Exception.Message);
            knownException = KnownException.Unknown;
            context.HttpContext.Response.StatusCode = StatusCodes.Status500InternalServerError;
        }
        else
        {
            knownException = KnownException.FromKnownException(knownException);
            context.HttpContext.Response.StatusCode = StatusCodes.Status200OK;
        }
        context.Result = new JsonResult(knownException)
        {
            ContentType = "application/json; charset=utf-8"
        };
    }
}

在 ConfigureServices 方法中添加自定义异常过滤器：

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc(mvcOptions =>
    {
        mvcOptions.Filters.Add<MyExceptionFilter>();
    });
}

ExceptionFilterAttribute

ExceptionFilterAttribute 可以更细粒度的控制异常的处理。
先定义自己的 ExceptionFilterAttribute ：

public class MyExceptionFilterAttribute : ExceptionFilterAttribute
{
    public override void OnException(ExceptionContext context)
    {
        IKnownException knownException = context.Exception as IKnownException;
        if (knownException == null)
        {
            var logger = context.HttpContext.RequestServices.GetService<ILogger<MyExceptionFilterAttribute>>();
            logger.LogError(context.Exception, context.Exception.Message);
            knownException = KnownException.Unknown;
            context.HttpContext.Response.StatusCode = StatusCodes.Status500InternalServerError;
        }
        else
        {
            knownException = KnownException.FromKnownException(knownException);
            context.HttpContext.Response.StatusCode = StatusCodes.Status200OK;
        }
        context.Result = new JsonResult(knownException)
        {
            ContentType = "application/json; charset=utf-8"
        };
    }
}

然后再在需要处理异常的 Controller 或者 Action 上打上 [MyExceptionFilter] 标签即可。
当然 ExceptionFilterAttribute 也继承了 IExceptionFilter 接口，这使得我们也可以在 ConfigureServices 中对 ExceptionFilterAttribute 进行全局注册对所有 Controller 进行异常处理：

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc(mvcOptions =>
    {
        mvcOptions.Filters.Add<MyExceptionFilterAttribute>();
    });
}

异常处理技巧

  • 用特定的异常类或接口表示业务逻辑异常
  • 为业务逻辑异常定义全局错误码
  • 为未知异常定义特定的输出信息和错误码
  • 对于已知业务逻辑异常响应 HTTP 200 (监控系统友好)
  • 对于未预见的异常响应 HTTP 500
  • 为所有的异常记录详细的日志

静态文件中间件

静态文件中间件的能力：

  • 支持指定相对路径
  • 支持目录浏览
  • 支持设置默认文档
  • 支持多目录映射

使用 UseStaticFiles 静态文件中间件启用静态文件，静态文件存放于 wwwroot 文件夹下 ：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    app.UseStaticFiles();
}

UseStaticFiles 的重载方法，输入 StaticFileOptions 参数，启用指定目录下的文件为静态文件：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    app.UseStaticFiles(new StaticFileOptions
    {
        RequestPath = "/files",
        FileProvider = new PhysicalFileProvider(Path.Combine(Directory.GetCurrentDirectory(), "file"))
    });
}

使用 UseDefaultFiles 中间件开启默认文件，默认文件为 index.html ：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    app.UseDefaultFiles();
}

UseDefaultFiles 中间件也提供了重载方法，输入 DefaultFilesOptions 参数来自定义默认文件。
实现所有非API请求重定向到指定页面：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    app.UseStaticFiles();
    app.MapWhen(context =>
    {
        return !context.Request.Path.Value.StartsWith("/api");
    }, appBuilder =>
    {
    	// 重写url
        var option = new RewriteOptions();
        option.AddRewrite(".*", "/index.html", true);
        appBuilder.UseRewriter(option);
        appBuilder.UseStaticFiles();
    });
}
Aoss丶
关注
  • 2
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
ASP.NET Core中间件计算Http请求时间示例详解
01-01
ASP.NET Core通过RequestDelegate这个委托类型来定义中间件 public delegate Task RequestDelegate(HttpContext context); 可将一个单独的请求委托并行指定为匿名方法（称为并行中间件），或在类中对其进行定义。可...
.Net Core中间件
xxxcAxx的博客
12-17 5745
中间件
asp.net core 自定义中间件 的基本使用
q8812345qaz的博客
10-07 462
asp.net core 中间件 ：基本 理解 和 Filter类似。区别： filter是mvc中包含的功能，针对 action方法。必须有 async Task InvokeAsync方法 参数为 HttpContext 并且 方法名不能写错。下面 自定义中间件 的基本使用，一般中间件 都在 Program.cs中。推荐使用下面的 中间件类。可以在管道中的下一个中间件前后执行一些工作。选择是否将请求传递给管道中的下一个中间件。中间件类 不要 继承 和实现接口 但是必须规范。最后结果 执行 顺序为。
从零开始学习ASP.NET CORE（五）中间件
father6的博客
02-06 535
中间件
使用Visual Studio Code开发Asp.Net Core WebApi学习笔记（五）-- Filter
weixin_30505225的博客
07-18 257
在上一篇里，介绍了中间件的相关内容和使用方法。本篇将介绍Asp.Net Core MVC框架的过滤器的相关内容和使用方法，并简单说明一下与中间件的区别。 第一部分、MVC框架内置过滤器 下图展示了Asp.Net Core MVC框架默认实现的过滤器的执行顺序： Authorization Filters：身份验证过滤器，处在整个过滤器通道的最顶层。对应的类型为：Authoriz...
ASP.NET Core 中间件介绍与理解
yinuns的博客
06-20 572
中间件名称如何使用及说明App.UseAuthentication，验证当前请求的用户，并设置HttpContext.User，当OAuth callbacks时，会中止执行下一个中间件。放到要用到用户验证的中间件前面app.UseStaticFiles()，判断当前请求是否为静态文件，如果是则中止执行下一个中间件，否则继续下一个中间件。放到管道的最前app.UseResponseCaching()，缓存中间件MVC。
Asp.Net Core中间件编写Demo
11-05
关于.Net Core中间件编写，做了一个简单的Demo，了解中间件封装使用的过程
ASP.NET Core中间件设置教程（7）
10-19
主要为大家详细介绍了ASP.NET Core中间件的设置教程，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
.net core中间件（附详细注释）
04-13
一步一步实现一个简单的.net core中间件，并且附带详细的注释。
如何给asp.net core写个中间件记录接口耗时
01-21
asp.net core 的运行是一个又一个的中间件来完成的，因此我们只需要定义自己的中间件，记录请求开始处理前的时间和处理结束后的时间，这里的中间件把请求的耗时输出到日志里了，你也可以根据需要输出到响应头或其他...
Net Core初步使用过滤器，中间件
憨态可掬的博客
07-06 1211
Net Core中 由于各个模块基本都是拆开的，零散的。所以一些之前在Framework中的用法有些不同了，这次主要就是讲讲 api拦截器，action拦截器，以及中间件的一些用法信息，这个只是我个人的一些理解，大家可以扩展的。。。
.net core中间件
小柚子~的博客
06-29 1812
中间件是应用管道用来处理请求和响应的组件
ASP.NET Core 中间件和过滤器的区别
djwuhjwiwhe的博客
02-17 402
ASP.NET Core 中间件 中间件和过滤器的区别
AspNetCore中的中间件详解【超详细】
contact97的博客
05-08 2342
虽然中间件的本质是一个Func middleware 对象，中间件的类型可分为两种,下面自定义实现以及记录请求IP地址的中间件弱类型中间件（1） 定义Ip中间件//调用下一个请求中间件 await requestDelegate . Invoke(context);} }（2）增加Use的拓展方法。
【ASP.NET Core 基础知识】--中间件--什么是中间件
喵叔
01-13 1376
在软件开发中，中间件是连接两个不同应用程序或软件组件的软件层。它位于两个系统或组件之间，充当通信、数据传递或功能交互的桥梁。中间件的主要目标是简化系统集成和提供一致的接口，使得不同组件能够有效地协同工作。在ASP.NET Core中，中间件是一种特定类型的组件，用于处理HTTP请求和响应。ASP.NET Core中间件在请求管道中按照顺序执行，每个中间件执行特定的任务或操作。这些中间件可以包括预处理请求、进行身份验证、记录日志、路由请求等功能。
【ASP.NET Core 基础知识】--中间件--内置中间件的使用
最新发布
喵叔
01-14 1113
在ASP.NET Core中，静态文件中间件是一种用于处理和提供静态文件的内置中间件。静态文件通常包括像样式表、脚本文件、图像以及其他客户端可以直接请求的文件。静态文件中间件能够有效地处理这些文件的请求，提高应用程序的性能。配置静态文件中间件要使用静态文件中间件，首先需要在Startup.cs文件的Configure方法中进行配置。以下是一个简单的配置示例：else// 配置静态文件中间件// 其他中间件和配置设置静态文件路径和缓存静态文件中间件默认会查找wwwroot。
ASP.NET Core 各版本 中间件或过滤器中获取Post参数方法
最数据的专栏
09-09 3916
2、当在动作过滤器（ActionFilter）或者需要多次读取 request.body 的时候，.net core 可以通过调用request.EnableRewind()实现，可以重置读取位置 ，但是在过滤器中使用此方法时出现异常，request.body的长度总是为0，说明在请求到达过滤器时Steam已经被读取了。1、权限（AuthorizationFilters）验证器中读取并只读取有一次请求串的方法。项目中，框架为.NET5，启动倒带方式,为。3、在任意想要读取的位置重复读取。
谈谈ASP.NET Core过滤器和中间件的区别
寒冰屋的专栏
12-05 353
中间件Middleware是所有请求都会执行的,适合用在权限校验,一些公用字段处理,例如分页信息获取.asp.net core 提供了IApplicationBuilder接口来让把中间件注册到asp.net的管道请求当中去，中间件是一个典型的AOP应用。
ASP.NET Core 中间件
weixin_46681279的博客
08-10 255
以下示例演示了一个中间件顺序，其中静态文件请求先由静态文件中间件处理，然后再由响应压缩中间件处理。使用前面的代码，可以通过缓存压缩响应来减少 CPU 使用率，但最终可能会使用不同的压缩算法（例如 Gzip 或 Brotli）缓存资源的多种表示形式。解释了 ASP.NET Core 和 ASP.NET 4.x 中请求管道之间的差异，并提供了其他中间件示例。静态文件中间件在管道的早期被调用，以便它可以处理请求和短路，而无需通过其余组件。请求管道中的每个中间件组件负责调用管道中的下一个组件或短路管道。
.net core 中间件读取请求参数不对
01-10
在.NET Core中，中间件负责处理HTTP请求和响应。中间件可以在请求到达控制器之前对请求进行操作，或在响应离开控制器之前对响应进行操作。 如果中间件无法正确读取请求参数，可能有几个原因导致这种情况。以下是...

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值