AspNetCore(二)-中间件(Middleware)

1、简介

什么是中间件?
简单来说,就像一个管道一样,一个请求到应用程序之后,会一步一步的经过你定义的每一个管道,流程图如下:


流程图

2、app.Use()

在Startup中的Configure方法中我们可以使用app.Use()来注册一个中间件,简单实例如下:

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {

            app.Use(async (context, next) =>
            {
                context.Response.ContentType = "text/plain; charset=utf-8;";
                await context.Response.WriteAsync("进入第一个中间件 \r\n");
                await next();
                await context.Response.WriteAsync("离开第一个中间件 \r\n");
            });
            app.Use(async (context, next) =>
            {
                await context.Response.WriteAsync("进入第二个中间件 \r\n");
                await next();
                await context.Response.WriteAsync("离开第二个中间件 \r\n");
            });
            app.Run(async context =>
            {
                await context.Response.WriteAsync("Hello World! \r\n");
            });
        }

输出如下:


输出内容

可以看到输出的过程,可以更加容易的理解在1中的流程图。
app.Use()传递的是一个Func的委托。
第一个参数为HttpContext,第二个参数是下一个中间件。
而app.Run()是最后一个中间件,相当于上图中的Action,所以他只有一个HttpContext,没有next这个参数。
如果不执行下一个中间件他就会直接返回了。
例如我们将第二个中间件的await next();去掉则会出现:


image

3、app.Map()

  • 第一个参数是一个路径(url)
  • 第二个参数是一个Action委托是IApplicationBuilder的实例
    app.Map()和app.Use()不一样,app.Map()必须有自己的终节点,相当于管道中的管道,也可以说是一个分支,一旦进入就不会再进入以后的中间件。
    实例如下:
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {

            app.Use(async (context, next) =>
            {
                context.Response.ContentType = "text/plain; charset=utf-8;";
                await context.Response.WriteAsync("进入第一个中间件 \r\n");
                await next();
                await context.Response.WriteAsync("离开第一个中间件 \r\n");
            });
            app.Map("/shisan",myapp => {
                myapp.Use(async (context, next) =>
                {
                    await context.Response.WriteAsync("这里是十三 \r\n");
                    await next();
                });
                myapp.Run(async context =>
                {
                    await context.Response.WriteAsync("Hello 十三! \r\n");
                });
            });
            app.Run(async context =>
            {
                await context.Response.WriteAsync("Hello World! \r\n");
            });
        }

启动程序输出:

启动程序输出

而改变Url为http://localhost:5000/shisan输出:
改变Url输出

4、app.MapWhen()

app.MapWhen()和app.Map()相似,简单来说就是满足一定的条件,才能进入该中间件。

  • 第一个参数是一个Func委托返回bool值。当为true继续执行
  • 第二个参数和Map一样是一个Action委托是IApplicationBuilder的实例
    实例如下:
 public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            app.MapWhen(context => context.Request.Query.ContainsKey("name"), myapp1 =>
            {
                myapp1.Use(async (context, next) =>
                {
                    context.Response.ContentType = "text/plain; charset=utf-8;";
                    await context.Response.WriteAsync("这里是MapWhen \r\n");
                    await next();
                });
                myapp1.Run(async context =>
                {
                    await context.Response.WriteAsync("Hello MapWhen! \r\n");
                });
            });
            app.Run(async context =>
            {
                await context.Response.WriteAsync("Hello World! \r\n");
            });
        }

启动程序只会输出:Hello World!
如果把Url修改成含有参数为Name的,就会进入MapWhen管道:


MapWhen

5、app.UseMiddleware()自定义中间件委托函数

如果都把中间件放在Startup中,是很难维护的,所以需要把他分离开来.
自定义使用中间件有两种方式:

  • 通过继承IMiddleware实现(需要注入服务)
  • 通过约定实现
    一、通过继承IMiddleware实现
    1、新创建一个类写上如下代码:
public class CustomMiddleWare : IMiddleware
    {
        public Task InvokeAsync(HttpContext context, RequestDelegate next)
        {
            context.Response.WriteAsync("这是自定义的中间件类");
            return next(context);
        }
    }

2、在Startup类中添加服务

public void ConfigureServices(IServiceCollection services)
        {
            services.AddSingleton<CustomMiddleWare>();
        }

3、在Startup注入中间件

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            app.Use(async (context, next) =>
            {
                context.Response.ContentType = "text/plain; charset=utf-8;";
                await context.Response.WriteAsync("进入第一个中间件 \r\n");
                await next();
                await context.Response.WriteAsync("离开第一个中间件 \r\n");
            });
            app.UseMiddleware<CustomMiddleWare>();
            app.Run(async context =>
            {
                await context.Response.WriteAsync("Hello World! \r\n");
            });
        }

4、如果你想像微软一样Use开头,可以再定义一个扩展方法如下:

public static class MiddleWareExtensions
    {
        public static IApplicationBuilder UseWriteContent(this IApplicationBuilder app)
        {
            return app.UseMiddleware<CustomMiddleWare>();
        }
    }

此时就可以在Startup中用app.UseWriteContent();来使用该中间件。
二、通过约定实现
需要将继承IMiddleware的类修改一下

public class CustomMiddleWare
    {
        public readonly RequestDelegate _next;
        public CustomMiddleWare(RequestDelegate next)
        {
            _next = next;
        }
        public Task InvokeAsync(HttpContext context)
        {
            context.Response.WriteAsync("这是自定义的中间件类");
            return _next(context);
        }
    }

注意:需要将Startup添加的服务删掉,否则会报错。
二种自定义中间件的方式选择其中之一就可以了。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,454评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,553评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,921评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,648评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,770评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,950评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,090评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,817评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,275评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,592评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,724评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,409评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,052评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,815评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,043评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,503评论 2 361
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,627评论 2 350

推荐阅读更多精彩内容