ASP.NET Core 中间件基本用法
原文:
ASP.NET Core 中间件基本用法
ASP.NET Core 中间件ASP.NET Core的处理流程是一个管道,而中间件是装配到管道中的用于处理请求和响应的组件。中间件按照装配的先后顺序执行,并决定是否进入下一个组件。中间件管道的处理流程如下图(图片来源于官网): 管道式的处理方式,更加方便我们对程序进行扩展。 使用中间件ASP.NET Core中间件模型是我们能够快捷的开发自己的中间件,完成对应用的扩展,我们先从一个简单的例子了解一下中间件的开发。 Run首先,我们创建一个ASP.NET Core 应用,在Startup.cs中有如下代码: app.Run(async (context) => { await context.Response.WriteAsync("Hello World!"); }); 这段代码中,使用Run方法运行一个委托,这就是最简单的中间件,它拦截了所有请求,返回一段文本作为响应。Run委托终止了管道的运行,因此也叫作终端中间件。 Use我们再看另外一个例子: app.Use(async (context,next) => { //Do something here //Invoke next middleware await next.Invoke(); //Do something here }); 这段代码中,使用Use方法运行一个委托,我们可以在Next调用之前和之后分别执行自定义的代码,从而可以方便的进行日志记录等工作。这段代码中,使用next.Invoke()方法调用下一个中间件,从而将中间件管道连贯起来;如果不调用next.Invoke()方法,则会造成管道短路。 Map和MapWhen处理上面两种方式,ASP.NET Core 还可以使用Map创建基于路径匹配的分支、使用MapWhen创建基于条件的分支。代码如下: private static void HandleMap(IApplicationBuilder app) { app.Run(async context => { await context.Response.WriteAsync("Handle Map"); }); } 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,IHostingEnvironment env) { app.Map("/map",HandleMap); app.MapWhen(context => context.Request.Query.ContainsKey("branch"),HandleBranch); app.Run(async context => { await context.Response.WriteAsync("Hello World!"); }); } 上面的代码演示了如何使用Map和MapWhen创建基于路径和条件的分支。另外,Map方法还支持层级的分支,我们参照下面的代码: app.Map("/level1",level1App => { level1App.Map("/level2a",level2AApp => { // "/level1/level2a" processing }); level1App.Map("/level2b",level2BApp => { // "/level1/level2b" processing }); }); 需要注意,使用 Map 时,将从 HttpRequest.Path 中删除匹配的Path,并针对每个请求将该线段追加到 HttpRequest.PathBase。例如对于路径 开发中间件看到这里,我们已经知道中间件的基本用法,是时候写一个真正意义的中间件了。在 ASP.NET Core 官网上面提供了一个简单的例子,通过中间件来设置应用的区域信息,代码如下: 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}"); }); } 通过这段代码,我们可以通过QueryString的方式设置应用的区域信息。但是这样的代码怎样复用呢?注意,中间件一定要是可复用、方便复用的。我们来改造这段代码: public class RequestCultureMiddleware { private readonly RequestDelegate _next; public RequestCultureMiddleware(RequestDelegate next) { _next = next; } public async Task InvokeAsync(HttpContext context) { //...... // Call the next delegate/middleware in the pipeline await _next(context); } } 这里定义一个委托,用于执行具体的业务逻辑,然后在Configure中调用这个委托: app.UseMiddleware<RequestCultureMiddleware>(); 这样还是不太方便,不像我们使用app.UseMvc()这么方便,那么我们来添加一个扩展方法,来实现更方便的复用: public static class RequestCultureMiddlewareExtensions { public static IApplicationBuilder UseRequestCulture( this IApplicationBuilder builder) { return builder.UseMiddleware<RequestCultureMiddleware>(); } } 然后我们就可以这样使用中间件了: app.UseRequestCulture(); 通过委托构造中间件,应用程序在运行时创建这个中间件,并将它添加到管道中。这里需要注意的是,中间件的创建是单例的,每个中间件在应用程序生命周期内只有一个实例。那么问题来了,如果我们业务逻辑需要多个实例时,该如何操作呢?请继续往下看。 中间件的依赖注入通过上面的代码我们已经知道了如何编写一个中间件,如何方便的复用这个中间件。在中间件的创建过程中,容器会为我们创建一个中间件实例,并且整个应用程序生命周期中只会创建一个该中间件的实例。通常我们的程序不允许这样的注入逻辑。 其实,我们可以把中间件理解成业务逻辑的入口,真正的业务逻辑是通过Application Service层实现的,我们只需要把应用服务注入到Invoke方法中即可。 ASP.NET Core为我们提供了这种机制,允许我们按照请求进行依赖的注入,也就是每次请求创建一个服务。代码如下: public class CustomMiddleware { private readonly RequestDelegate _next; public CustomMiddleware(RequestDelegate next) { _next = next; } // IMyScopedService is injected into Invoke public async Task Invoke(HttpContext httpContext,IMyScopedService svc) { svc.MyProperty = 1000; await _next(httpContext); } } 在这段代码中,CustomMiddleware的实例仍然是单例的,但是IMyScopedService是按照请求进行注入的,每次请求都会创建IMyScopedService的实例,svc对象的生命周期是PerRequest的。 完整的中间件示例这里提供一个完整的示例,可以理解为一个中间件的开发模板,方便以后使用的时候参考。整个过程分以下几步:
代码如下: namespace MiddlewareDemo { using Microsoft.AspNetCore.Http; using System.Threading.Tasks; //1.定义并实现业务逻辑 public interface IMyScopedService { int MyProperty { get; set; } } public class MyScopedService : IMyScopedService { public int MyProperty { get; set; } } //2.创建中间件代理类 public class CustomMiddleware { private readonly RequestDelegate _next; public CustomMiddleware(RequestDelegate next) { _next = next; } // IMyScopedService is injected into Invoke public async Task Invoke(HttpContext httpContext,IMyScopedService svc) { svc.MyProperty = 1000; await _next(httpContext); } } } //3.1 添加依赖服务注册 namespace Microsoft.Extensions.DependencyInjection { using MiddlewareDemo; public static partial class CustomMiddlewareExtensions { /// <summary> /// 添加服务的依赖注册 /// </summary> public static IServiceCollection AddCustom(this IServiceCollection services) { return services.AddScoped<IMyScopedService,MyScopedService>(); } } } //3.2 创建中间件扩展类 namespace Microsoft.AspNetCore.Builder { using MiddlewareDemo; public static partial class CustomMiddlewareExtensions { /// <summary> /// 使用中间件 /// </summary> public static IApplicationBuilder UseCustom(this IApplicationBuilder builder) { return builder.UseMiddleware<CustomMiddleware>(); } } } //4. 使用中间件 public void ConfigureServices(IServiceCollection services) { services.AddCustom(); } public void Configure(IApplicationBuilder app,IHostingEnvironment env) { app.UseCustom(); } 参考文档
(编辑:李大同) 【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容! |
- 取消选中时,ASP.NET CheckBox不会启动CheckedChanged事件
- asp.net – 如何在SQL Server 2008中的单个存储过程中编写两
- asp.net-mvc – ActionLink无法在“if”块内渲染
- asp.net-mvc – 如何确定视图是否为ASP.NET MVC中的GET或PO
- asp.net – 在IE7 / IE8兼容模式下,ModalPopupExtender不会
- asp.net – 在后面的代码中通过jquery添加列表框项的问题
- asp.net-mvc-2 – Plus()在MVC中的参数引起404在IIS 7.0
- asp.net-mvc – WebService还是一个简单的MVC控制器?
- asp.net-core – 如何在Asp.net Core中使用soap web服务?
- asp.net-mvc – 在修改现有子实体框架的同时添加新的子对象
- ASP.NET MVC 3使用子集合进行不显眼的jQuery客户
- asp.net-mvc – 如何在验证汇总中显示MVC 3客户端
- asp.net-mvc – asp.net mvc ajax post – redir
- asp.net-mvc – ASP.NET MVC应用程序的论坛解决方
- asp.net-mvc – ASP.net MVC控制器 – 构造函数的
- IIS中的Asp.Net核心MVC应用程序Windows身份验证
- 在ASP.NET Core Web API中为RESTful服务增加对HA
- asp.net-mvc – ASP.NET MVC泛型基础视图类
- asp.net-mvc – 在MVC3中使用Html.BeginForm是什
- asp.net-mvc-2 – 如何在asp.net mvc 2中使用fak