理解ASP.NET 5的中间件

今天推荐的这篇文章,讲述了如何实现和使用ASP.NET 5的中间件。

虽然在ASP.NET 5中,微软没有再强调OWIN(Open Web Interface for .NET)及其微软官方的OWIN实现Katana,但是其中涉及到一些原则和设计思想依然被ASP.NET 5以自己的方式所承载下来。比如,解耦服务器和应用程序的关系,应用程序委托,环境状态这些特性都能在ASP.NET 5中找到,且进行了更多加强。

那么什么是“中间件”呢?OWIN的规范中如此定义:“中间件即是在服务器和应用程序之间的管道传入的一些组件,为了特定目的监测、路由或编辑请求和回应消息。”这样的定义对于ASP.NET 5同样适用,或者可以被认为就是传统ASP.NET中的HTTP模块和处理器。某些中间件会完成一些中间任务,比如处理请求的验证、会话状态获取和持久保持、日志记录诸如此类;有一些中间件会最终生成回应消息。

要编写ASP.NET 5的中间件,有一种非常简单的方式,一段Lambda表达式就可以搞定:

.csharpcode, .csharpcode pre
{
font-size: small;
color: black;
font-family: consolas, "Courier New", courier, monospace;
background-color: #ffffff;
/*white-space: pre;*/
}
.csharpcode pre { margin: 0em; }
.csharpcode .rem { color: #008000; }
.csharpcode .kwrd { color: #0000ff; }
.csharpcode .str { color: #006080; }
.csharpcode .op { color: #0000c0; }
.csharpcode .preproc { color: #cc6633; }
.csharpcode .asp { background-color: #ffff00; }
.csharpcode .html { color: #800000; }
.csharpcode .attr { color: #ff0000; }
.csharpcode .alt
{
background-color: #f4f4f4;
width: 100%;
margin: 0em;
}
.csharpcode .lnum { color: #606060; }

public class Startup
{
    public void Configure(IApplicationBuilder app)
    {
        app.Run(async context =>
        {
            context.Response.ContentType = "text/plain";
            await context.Response.WriteAsync("Hello ASP.NET 5!");
        });
    }
}

在上述代码中,传递给IApplicationBuilder.Run方法的是一个委托:RequestDelegate,其定义如下:

public delegate Task RequestDelegate(HttpContext context);

RequestDelegate等效于OWIN中的AppFunc。其接受状态信息HttpContext作为输入参数,返回一个Task。注意,此HttpContext非SystemWeb中的HttpContext,这是封装请求处理状态且对服务器透明(不特定于某种服务器)的上下文状态对象。而返回Task可以让调用者能够等待你的中间件完成工作后才进行后续任务执行。Run方法还有多个重载,以便让你注入相关依赖。

RequestDelegate同样也可以用于把中间件串接到执行管道中:

public class Startup
{
    public void Configure(IApplicationBuilder app)
    {
        app.Use(next => async context =>
        {
            // do your stuff here before calling the next middleware
            // in the pipeline

            await next.Invoke(context); // call the next guy

            // do some more stuff here as the call is unwinding
        });

        app.Run(async context =>
        {
            context.Response.ContentType = "text/plain";
            await context.Response.WriteAsync("Hello ASP.NET 5!");
        });
    }
}

通过使用IApplicationBuilder.Use方法就可以把自己的中间件代码串到其他中间件的前面。其中next这个参数,就是下一个中间件的实例。其方法定义如下:

IApplicationBuilder Use(Func<RequestDelegate, RequestDelegate

上面是用Lambda表达式来实现中间件,不过在实际开发当中涉及的代码都比较庞杂,所以最好是放到一个单独的类当中,并提供相应的测试代码。这样你可以单独编译打包分发这个中间件。文章作者Andrei Dzimchuk以实现HTTP Basic验证的一个简单中间件为例给出了如下代码:

public class BasicAuthentication
{
    private readonly RequestDelegate next;

    public BasicAuthentication(RequestDelegate next)
    {
        this.next = next;
    }

    public async Task Invoke(HttpContext context,
                             IAuthenticationService authenticationService)
    {
        try
        {
            var parser = new BasicAuthenticationParser(context);
            var username = parser.GetUsername();
            var password = parser.GetPassword();

            await authenticationService.AuthenticateAsync(username, password);
            await next(context);
        }
        catch (InvalidCredentialsException)
        {
            context.Response.StatusCode = 401;
            context.Response.Headers.Add("WWW-Authenticate",
                new[] { "Basic" });
        }
    }
}

这个类非常有意思。首先让我们非常奇怪的是,它没有继承任何基类或者实现任何接口。由此可知,微软开始在ASP.NET 5中推崇“约定胜于接口”的思想。我们只要实现一个接受RequestDelegate为参数的构造器,和一个方法签名同RequestDelegate一致的Invoke方法。当然本例中Invoke还接受了另外一个参数,这就是第二个奇怪的地方,我们能够在中间件里直接使用依赖注入。本例中就是注入了一个IAuthenticationService。

要使用编写好的中间件也是非常简单。首先引用一个依赖包“Microsoft.AspNet.RequestContainer ”,然后就可以使用Microsoft.AspNet.Http.Extensions的扩展方法IApplicationBuilder.UseMiddleware来加载中间件,如下:

builder.UseMiddleware<BasicAuthentication>();

通常,我们会把单独编写一个扩展类,来提供一个语义根据明确的扩展方法。最终Startup文件就可以编写为:

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

        app.Run(async context =>
        {
            context.Response.ContentType = "text/plain";
            await context.Response.WriteAsync("Hello ASP.NET 5!");
        });
    }
}

到此,我们就完成了中间件的编写和使用。当然还需要完成注册IAuthenticationService这样的代码,这个就涉及到ASP.NET 5的依赖注入特性,有机会下次介绍。

原文地址在:http://dzimchuk.net/post/Understanding-ASPNET-5-middleware

时间: 2024-08-07 10:12:12

理解ASP.NET 5的中间件的相关文章

如何理解ASP Session 对象

ASP Session 对象 Previous Page Next Page Session 对象用于存储用户的信息.存储于 session 对象中的 变量握有单一用户的信息,并且对于一个应用程序中的所有页面都是可用的. Session 对象 当您操作某个应用程序时,您打开它,做些改变,然后将它关闭.这很像一次对话(Session). 计算机知道您是谁.它清楚您在何时打开和关闭应用程序.但是在因特网上有一个问题: 由于 HTTP 地址无法存留状态,web 服务器并不知道您是谁以及您做什么. AS

理解ASP.NET 5运行时命令:DNVM, DNX, 和DNU

ASP.NET 5 引入了一个新型的运行时,让我们可以现场交付模式组合式构建应用程序,而不依赖于宿主机上的.NET框架.这种新模式为我们提供了命令行工具(DNVM.DNX.DNU)用于管理我们的.net 版本,依赖的库和运行环境,我们可以不需要Visual Studio,只需要一个文本编辑器和命令行就可以开发一个应用程序. 了解.NET 版本管理器 (DNVM) 之间 ,.NET 执行环境 (DNX) 和.NET 开发实用程序 (DNU) 之间的关系是开发 ASP.NET 5的根本.在这篇文章我

深入理解ASP.NET MVC Day1

深入理解ASP.NET MVC ASP.NET vs MVC vs WebForms 许多ASP.NET开发人员开始接触MVC认为MVC与ASP.NET完全没有关系,是一个全新的Web开发,事实上ASP.NET是创建WEB应用的框架而MVC是能够用更好的方法来组织并管理代码的一种更高级架构体系,所以可以称之为ASP.NET MVC. 我们可将原来的ASP.NET称为 ASP.NET Webforms,新的MVC 称为ASP.NET MVC. ASP.NET Web Form ASP.NET 在过

理解ASP.NET的IDataReader

理解ASP.NET的IDataReader ADO.NET DataReader对象可以从数据库中检索只读.只进的数据流.因为每次在内存中的数据只有一行,所以使用DataReader可提高应用程序的性能并减少系统开销.它还提供了未缓冲的数据流,该数据流使过程逻辑可以有效地按顺序处理从数据源中返回的结果.由于数据不在内存中缓存,所以在检索大量数据时,DataReader是一种合适的选择.

七天学会ASP.NET MVC (一)——深入理解ASP.NET MVC

ASP.NET vs MVC vs WebForms 许多ASP.NET开发人员开始接触MVC认为MVC与ASP.NET完全没有关系,是一个全新的Web开发,事实上ASP.NET是创建WEB应用的框架而MVC是能够用更好的方法来组织并管理代码的一种更高级架构体系,所以可以称之为ASP.NET MVC. 我们可将原来的ASP.NET称为 ASP.NET Webforms,新的MVC 称为ASP.NET MVC. ASP.NET Web Form ASP.NET 在过去的十二年里,已经服务并成功实现

理解asp.net中DropDownList编辑数据源,绑定数据库数据。

一.理解asp.net绑定数据库 终于学习到了连接数据库部分的内容,杨中科老师视频看起来挺轻松的,如果是高清版就更ok了. 我发现我学习新的编程语言会有一个特点,都想要赶紧学习数据库,数据就是一切,有了数据才能操作一切的原因吧.现在能连上数据库特别心安.把过程记录一下,成为学习轨迹的一部分. 环境是VS2013.MSSQLSERVER(2012) (一)我想实现的效果是:一个下拉菜单DropDownList,从数据库那边获取数据过来,显示在下单菜单里. (二)实现的过程 首先,我把数据库跟数据表

深入理解ASP.NET MVC(6)

系列目录 Action全局观 在上一篇最后,我们进行到了Action调用的“门口”: 1 if (!ActionInvoker.InvokeAction(ControllerContext, actionName)) 在深入研究调用过程的细节前,先有一个总体的认识是很有帮助的.InvokeAction方法大致是按照这样的顺序进行的: 查找action:MVC内部查找action的方法似乎有点复杂,涉及到一个ActionDescriptor的东西,但是原理上是通过反射,在以后的文章中会有所涉及.

深入理解ASP.NET MVC(5)

系列目录 回顾 系列的前4节深入剖析了ASP.NET URL路由机制,以及MVC在此基础上是如何实现Areas机制的,同时涉及到inbound和outbound很多细节部分.第2节中提到MvcRouteHandler是MVC框架的入口,这节开始,从MvcRouteHandler往下说开去. Controller的创建过程:Builder和Factory MvcRouteHandler的实现仅仅是通过GetHttpHandler方法返回一个MvcHandler实例,MvcHandler从Route

[转载] ASP.NET MVC (一)——深入理解ASP.NET MVC

个人认为写得比较透彻得Asp.net mvc 文章,所以转载过来,原文链接在最后: ASP.NET vs MVC vs WebForms 许多ASP.NET开发人员开始接触MVC认为MVC与ASP.NET完全没有关系,是一个全新的Web开发,事实上ASP.NET是创建WEB应用的框架而MVC是能够用更好的方法来组织并管理代码的一种更高级架构体系,所以可以称之为ASP.NET MVC. 我们可将原来的ASP.NET称为 ASP.NET Webforms,新的MVC 称为ASP.NET MVC. A