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添加的服务删掉，否则会报错。
二种自定义中间件的方式选择其中之一就可以了。
网友评论