广告

扫码关注官方微信

扫码下载APP
返回顶部
首页 > 资讯 > 后端开发 > ASP.NET >详解ASP.NETCore中间件Middleware
  • 205

0
分享到

详解ASP.NETCore中间件Middleware

2024-04-02 19:04:59 205人浏览 八月长安
摘要

本文为官方文档译文，官方文档现已非机器翻译 https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/middleware/

本文为官方文档译文，官方文档现已非机器翻译 https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/middleware/?view=aspnetcore-2.1

什么是中间件（Middleware）？

中间件是组装到应用程序管道中以处理请求和响应的软件。 每个组件：

  • 选择是否将请求传递给管道中的下一个组件。
  • 可以在调用管道中的下一个组件之前和之后执行工作。

请求委托（Request delegates）用于构建请求管道，处理每个Http请求。

请求委托使用Run，Map和Use扩展方法进行配置。单独的请求委托可以以内联匿名方法（称为内联中间件）指定，或者可以在可重用的类中定义它。这些可重用的类和内联匿名方法是中间件或中间件组件。请求流程中的每个中间件组件都负责调用流水线中的下一个组件，如果适当，则负责链接短路。

将HTTP模块迁移到中间件解释了ASP.net core和以前版本（asp.net）中的请求管道之间的区别，并提供了更多的中间件示例。

使用 IApplicationBuilder 创建中间件管道

ASP.net core请求流程由一系列请求委托组成，如下图所示（执行流程遵循黑色箭头）：

每个委托可以在下一个委托之前和之后执行操作。委托还可以决定不将请求传递给下一个委托，这称为请求管道的短路。短路通常是可取的，因为它避免了不必要的工作。例如，静态文件中间件可以返回一个静态文件的请求，并使管道的其余部分短路。需要在管道早期调用异常处理委托，因此它们可以捕获后面管道的异常。

最简单的可能是ASP.Net Core应用程序建立一个请求的委托，处理所有的请求。此案例不包含实际的请求管道。相反，针对每个HTTP请求都调用一个匿名方法。

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;

public class Startup
{
    public void Configure(IApplicationBuilder app)
    {
        app.Run(async context =>
        {
            await context.Response.WriteAsync("Hello, World!");
        });
    }
}

第一个 app.Run 委托终止管道。

有如下代码：

通过浏览器访问，发现确实在第一个app.Run终止了管道。

您可以将多个请求委托与app.Use连接在一起。 next参数表示管道中的下一个委托。 （请记住，您可以通过不调用下一个参数来结束流水线。）通常可以在下一个委托之前和之后执行操作，如下例所示：

public class Startup
{
    public void Configure(IApplicationBuilder app)
    {
        app.Use(async (context, next) =>
	        {
				await context.Response.WriteAsync("进入第一个委托 执行下一个委托之前\r\n");
				//调用管道中的下一个委托
		        await next.Invoke();
		        await context.Response.WriteAsync("结束第一个委托 执行下一个委托之后\r\n");
			});
	        app.Run(async context =>
	        {
		        await context.Response.WriteAsync("进入第二个委托\r\n");
				await context.Response.WriteAsync("Hello from 2nd delegate.\r\n");
		        await context.Response.WriteAsync("结束第二个委托\r\n");
			});
    }
}

使用浏览器访问有如下结果：

可以看出请求委托的执行顺序是遵循上面的流程图的。

注意：

响应发送到客户端后，请勿调用next.Invoke。 响应开始之后，对HttpResponse的更改将抛出异常。 例如，设置响应头，状态代码等更改将会引发异常。在调用next之后写入响应体。

  • 可能导致协议违规。 例如，写入超过content-length所述内容长度。
  • 可能会破坏响应内容格式。 例如，将html页脚写入CSS文件。

HttpResponse.HasStarted是一个有用的提示，指示是否已发送响应头和/或正文已写入。

顺序

在Startup。Configure方法中添加中间件组件的顺序定义了在请求上调用它们的顺序，以及响应的相反顺序。 此排序对于安全性，性能和功能至关重要。

Startup.Configure方法（如下所示）添加了以下中间件组件：

  • 异常/错误处理
  • 静态文件服务
  • 身份认证
  • mvc
public void Configure(IApplicationBuilder app)
{
    app.UseExceptionHandler("/Home/Error"); // Call first to catch exceptions
                                            								// thrown in the following middleware.

    app.UseStaticFiles();                   // Return static files and end pipeline.

    app.UseAuthentication();               // Authenticate before you access
                                           					// secure resources.

    app.UseMvcWithDefaultRoute();          // Add MVC to the request pipeline.
}

上面的代码，UseExceptionHandler是添加到管道中的第一个中间件组件，因此它捕获以后调用中发生的任何异常。

静态文件中间件在管道中提前调用，因此可以处理请求和短路，而无需通过剩余的组件。 静态文件中间件不提供授权检查。 由其提供的任何文件，包括wwwroot下的文件都是公开的。

如果请求没有被静态文件中间件处理，它将被传递给执行身份验证的Identity中间件（app.UseAuthentication）。 身份不会使未经身份验证的请求发生短路。 虽然身份认证请求，但授权（和拒绝）仅在MVC选择特定的Razor页面或控制器和操作之后才会发生。

授权（和拒绝）仅在MVC选择特定的Razor页面或Controller和Action之后才会发生。

以下示例演示了中间件顺序，其中静态文件的请求在响应压缩中间件之前由静态文件中间件处理。 静态文件不会按照中间件的顺序进行压缩。 来自UseMvcWithDefaultRoute的MVC响应可以被压缩。

public void Configure(IApplicationBuilder app)
{
    app.UseStaticFiles();         // Static files not compressed
    app.UseResponseCompression();
    app.UseMvcWithDefaultRoute();
}

Use, Run, 和 Map

你可以使用Use，Run和Map配置HTTP管道。Use方法可以使管道短路（即，可以不调用下一个请求委托）。Run方法是一个约定， 并且一些中间件组件可能暴露在管道末端运行的Run [Middleware]方法。Map*扩展用作分支管道的约定。映射根据给定的请求路径的匹配来分支请求流水线，如果请求路径以给定路径开始，则执行分支。

public class Startup
{
    private static void HandleMapTest1(IApplicationBuilder app)
    {
        app.Run(async context =>
        {
            await context.Response.WriteAsync("Map Test 1");
        });
    }

    private static void HandleMapTest2(IApplicationBuilder app)
    {
        app.Run(async context =>
        {
            await context.Response.WriteAsync("Map Test 2");
        });
    }

    public void Configure(IApplicationBuilder app)
    {
        app.Map("/map1", HandleMapTest1);

        app.Map("/map2", HandleMapTest2);

        app.Run(async context =>
        {
            await context.Response.WriteAsync("Hello from non-Map delegate. <p>");
        });
    }
}

下表显示了使用以前代码的 http://localhost:19219 的请求和响应：

请求响应
localhost:1234Hello from non-Map delegate.
localhost:1234/map1Map Test 1
localhost:1234/map2Map Test 2
localhost:1234/map3Hello from non-Map delegate.

当使用Map时，匹配的路径段将从HttpRequest.Path中删除，并为每个请求追加到Http Request.PatHBase。

MapWhen根据给定谓词的结果分支请求流水线。 任何类型为Func<HttpContext,bool>的谓词都可用于将请求映射到管道的新分支。 在以下示例中，谓词用于检测查询字符串变量分支的存在：

public class Startup
{
    private static void HandleBranch(IApplicationBuilder app)
    {
        app.Run(async context =>
        {
            var branchVer = context.Request.Query["branch"];
            await context.Response.WriteAsync($"Branch used = {branchVer}");
        });
    }

    public void Configure(IApplicationBuilder app)
    {
        app.MapWhen(context => context.Request.Query.ContainsKey("branch"),
                               HandleBranch);

        app.Run(async context =>
        {
            await context.Response.WriteAsync("Hello from non-Map delegate. <p>");
        });
    }
}

以下下表显示了使用上面代码 http://localhost:19219 的请求和响应：

请求响应
localhost:1234Hello from non-Map delegate.
localhost:1234/?branch=1Branch used = master

Map支持嵌套，例如：

app.Map("/level1", level1App => {
       level1App.Map("/level2a", level2AApp => {
           // "/level1/level2a"
           //...
       });
       level1App.Map("/level2b", level2BApp => {
           // "/level1/level2b"
           //...
       });
   });

Map也可以一次匹配多个片段，例如：

app.Map("/level1/level2", HandleMultiSeg);

内置中间件

ASP.net Core附带以下中间件组件：

中间件描述
Authentication提供身份验证支持
CORS配置跨域资源共享
Response Caching提供缓存响应支持
Response Compression提供响应压缩支持
Routing定义和约束请求路由
Session提供用户会话管理
Static Files为静态文件和目录浏览提供服务提供支持
URL Rewriting Middleware用于重写 Url，并将请求重定向的支持

编写中间件

中间件通常封装在一个类中，并使用扩展方法进行暴露。 查看以下中间件，它从查询字符串设置当前请求的Culture：

public class Startup
{
    public void Configure(IApplicationBuilder app)
    {
        app.Use((context, next) =>
        {
            var cultureQuery = context.Request.Query["culture"];
            if (!string.IsNullOrWhiteSpace(cultureQuery))
            {
                var culture = new CultureInfo(cultureQuery);

                CultureInfo.CurrentCulture = culture;
                CultureInfo.CurrentUICulture = culture;
            }

            // Call the next delegate/middleware in the pipeline
            return next();
        });

        app.Run(async (context) =>
        {
            await context.Response.WriteAsync(
                $"Hello {CultureInfo.CurrentCulture.DisplayName}");
        });

    }
}

您可以通过传递Culture来测试中间件，例如 http://localhost:19219/?culture=zh-CN

以下代码将中间件委托移动到一个类：

using Microsoft.AspNetCore.Http;
using System.Globalization;
using System.Threading.Tasks;

namespace Culture
{
    public class RequestCultureMiddleware
    {
        private readonly RequestDelegate _next;

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

        public Task Invoke(HttpContext context)
        {
            var cultureQuery = context.Request.Query["culture"];
            if (!string.IsNullOrWhiteSpace(cultureQuery))
            {
                var culture = new CultureInfo(cultureQuery);

                CultureInfo.CurrentCulture = culture;
                CultureInfo.CurrentUICulture = culture;

            }

            // Call the next delegate/middleware in the pipeline
            return this._next(context);
        }
    }
}

以下通过IApplicationBuilder的扩展方法暴露中间件：

using Microsoft.AspNetCore.Builder;

namespace Culture
{
    public static class RequestCultureMiddlewareExtensions
    {
        public static IApplicationBuilder UseRequestCulture(
            this IApplicationBuilder builder)
        {
            return builder.UseMiddleware<RequestCultureMiddleware>();
        }
    }
}

以下代码从Configure调用中间件：

public class Startup
{
    public void Configure(IApplicationBuilder app)
    {
        app.UseRequestCulture();

        app.Run(async (context) =>
        {
            await context.Response.WriteAsync(
                $"Hello {CultureInfo.CurrentCulture.DisplayName}");
        });

    }
}

中间件应该遵循显式依赖原则，通过在其构造函数中暴露其依赖关系。 中间件在应用程序生命周期构建一次。 如果您需要在请求中与中间件共享服务，请参阅以下请求相关性。

中间件组件可以通过构造方法参数来解析依赖注入的依赖关系。 UseMiddleware也可以直接接受其他参数。

每个请求的依赖关系

因为中间件是在应用程序启动时构建的，而不是每个请求，所以在每个请求期间，中间件构造函数使用的作用域生命周期服务不会与其他依赖注入类型共享。 如果您必须在中间件和其他类型之间共享作用域服务，请将这些服务添加到Invoke方法的签名中。 Invoke方法可以接受由依赖注入填充的其他参数。 例如：

public class MyMiddleware
{
    private readonly RequestDelegate _next;

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

    public async Task Invoke(HttpContext httpContext, IMyScopedService svc)
    {
        svc.MyProperty = 1000;
        await _next(httpContext);
    }
}

到此这篇关于ASP.NET Core中间件Middleware详解的文章就介绍到这了。希望对大家的学习有所帮助，也希望大家多多支持编程网。

点击免费下载>>软考高级考试备考技巧/历年真题/备考精华资料

--结束END--

本文标题: 详解ASP.NETCore中间件Middleware

本文链接: https://www.lsjlt.com/news/162438.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑，方便收藏和打印～

下载Word文档
去做题
猜你喜欢
  • 详解ASP.NETCore中间件Middleware
    本文为官方文档译文，官方文档现已非机器翻译 https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/middleware/...
    99+
    2022-11-12
  • Node.js使用Middleware中间件教程详解
    目录中间件依赖注入应用中间件路由通配符中间件消费者路由排除函数式中间件多个中间件全局中间件中间件 中间件是一个在路由处理程序之前被调用的函数。中间件函数可以访问请求和响应对象，以及应...
    99+
    2023-05-15
    Node.js Middleware Node.js 中间件
  • ASP.NETCore中间件
    目录1.前言2.使用中间件2.1 Run2.2 Use2.3 Map和MapWhen3.顺序4.编写中间件（重点）4.1中间件类4.2中间件扩展方法5.按每次请求创建依赖注入（DI）...
    99+
    2022-11-13
  • 理解ASP.NET Core 中间件(Middleware)
    目录中间件中间件管道RunUseUseWhenMapMapWhenRun & Use & UseWhen & Map & Map编写中间件并激活基于约...
    99+
    2022-11-12
  • ASP.NETCore基础之中间件
    什么是ASP.NET Core Middleware？ ASP.NET Core中间件组件是被组装到应用程序管道中以处理HTTP请求和响应的软件组件（从技术上来说，组件只是C＃类）。...
    99+
    2022-11-13
  • laravel的中间件middleware怎么用
    这篇文章将为大家详细讲解有关laravel的中间件middleware怎么用，小编觉得挺实用的，因此分享给大家做个参考，希望大家阅读完这篇文章后可以有所收获。中间件可以对请求进行过滤，这里可以利用中间件来验证用户是否登录，如果用户登录则可以...
    99+
    2023-06-21
  • Node.js怎么使用Middleware中间件
    今天小编给大家分享一下Node.js怎么使用Middleware中间件的相关知识点，内容详细，逻辑清晰，相信大部分人都还太了解这方面的知识，所以分享这篇文章给大家参考一下，希望大家阅读完这篇文章后有所收获，下面我们一起来了解一下吧。中间件中...
    99+
    2023-07-06
  • ASP.NET Core中间件Middleware是什么
    本篇内容介绍了“ASP.NET Core中间件Middleware是什么”的有关知识，在实际案例的操作过程中，不少人都会遇到这样的困境，接下来就让小编带领大家学习一下如何处理这些情况吧！希望大家仔细阅读，能够学有所成！什么是中间件...
    99+
    2023-06-26
  • ASP.NETCore基础之异常中间件
    了解异常中间件 首先，使用ASP.NET模板创建一个核心应用程序。默认情况下，ASP.NET核心应用程序只是返回应用程序未处理的异常的状态代码。如下所示，我们引发异常。 运行应用程...
    99+
    2022-11-13
  • Scrapy 之中间件(Middleware)的具体使用
    目录一、下载器中间件（Downloader Middleware）process_request(request, spider)process_response(request, ...
    99+
    2022-11-11
  • ASP.NETCore实现中间件的几种方式
    前言 ASP.NET Core 中 HTTP 管道使用中间件组合处理的方式, 换句人话来说, 对于写代码的人而言,一切皆中间件. 业务逻辑/数据访问/等等一切都需要以中间件的方式来呈...
    99+
    2022-11-13
  • 手把手带你定制.NET 6.0的Middleware中间件
    目录前言技术准备中间件简介编写自定义中间件中间件的潜力使用/map分支管道使用MapWhen分支管道使用中间件构造条件在ASP.NET Core 3.0及更高版本中使用中间件重写终止...
    99+
    2022-12-20
    .net 6.0 middleware中间件 .net中间件有哪些 .net 6.0 中间件
  • redux功能强大的Middleware中间件使用学习
    目录引言redux中的Middleware记录日志手动记录redux-sagaGenerator函数实际使用场景引言 上一节我们学习了redux在实际项目的应用细节，这一节我们来学习...
    99+
    2022-11-13
  • AspNetCore中的中间件详解
    目录1 什么叫做中间件？2 请求短路与中间件顺序3 中间件配置方法Use、Run、Map3.1Use 方法配置中间件3.2Run 方法配置中间件3.2Map 方法配置中间件4 自定义...
    99+
    2023-05-20
    AspNetCore中间件 AspNet中间件
  • 数据库中间件详解
    导读：本文详细介绍了中间件，主要从数据库拆分过程及挑战、主流数据库中间件设计方案、读写分离核心要点、分库分表核心要点展开说明。  1. 数据库拆分过程及挑战 互联网当下的数据库拆分过程...
    99+
    2022-10-18
  • express的中间件basicAuth详解
    basicAuth中间件为网站添加身份认证功能.在使用了该中间件后, 用户访问网站时必须输入用户名与密码,在用户输入了用户名与密码并通过验证之后才能访问网站. 当用户输入的用户名和密码符合条件,中间件会返回...
    99+
    2022-06-04
    详解 中间件 express
  • express的中间件bodyParser详解
    bodyParser用于解析客户端请求的body中的内容,内部使用JSON编码处理,url编码处理以及对于文件的上传处理. 下面是一个文件上传的例子. 建立一个1.html页面 <!DOCTYPE ...
    99+
    2022-06-04
    详解 中间件 express
  • express的中间件cookieParser详解
    cookieParser中间件用于获取web浏览器发送的cookie中的内容.在使用了cookieParser中间件后, 代表客户端请求的htto.IncomingMessage对象就具有了一个cookie...
    99+
    2022-06-04
    详解 中间件 express
  • ASP.NETCore模仿中间件方式实现列表过滤功能
    我们的很多功能当中都会遇到对版本进行过滤的场合，例如你可能需要对列表中的数据的时间进行过滤、版本过滤、渠道以及地区信息进行过滤。 原本的做法：设计很多个过滤方法，通过枚举的方式组合，...
    99+
    2022-11-13
  • Laravel中间件的使用详解
    目录一：创建中间件二：前置和后置中间件1：前置中间件2：后置中间件三：注册中间件1：注册全局中间件2：为路由分配中间件3：中间件组4：排序中间件5：中间件参数6：Terminable...
    99+
    2023-02-08
    Laravel中间件使用 Laravel中间件
软考高级职称资格查询
软考职称历年真题下载
软考职称资料下载
热门wiki
近期文章
推荐阅读
热门问答
热门标签
编程网，编程工程师的家园，是目前国内优秀的开源技术社区之一，形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容，为IT开发者提供了一个发现、使用、并交流开源技术的平台。

  • 官方手机版

  • 微信公众号

  • 商务合作