.Net Core中间件

目录

一、什么是中间件

二、中间件的用途

三、中间件的三个概念

四、自定义中间件

五、ASP.NET Core附带中间件组件

六、中间件和过滤器的区别

---

一、什么是中间件

         在浏览网站或者使用手机App加载内容的时候，浏览器或者手机App其实在向Web服务器发送HTTP请求。服务器在收到HTTP请求后会对用户的请求进行一系列的处理，比如检查请求的身份验证信息、处理请求报文头、检查是否存在对应的服务器端响应缓存、找到和请求对应的控制器类中的操作方法等，当控制器类中的操作方法执行完成后，服务器也会对相应进行一系列处理，比如保存响应缓存、设置缓存报文头、设置CORS报文头、压缩响应内容等。这一系列操作如果全部都硬编码在ASP.NET Core中，会使代码耦合度太高，无法做到按需组装处理逻辑。因此基础框架只完成HTTP请求的调度、报文的解析等必要的工作，其他可选的工作都由不同的中间件来提供。 

 中间件指的是系统软件和应用软件之间连接的软件，以便于软件之间的沟通，这些中间件组成一个管道，整个ASP.NET Core的执行过程就是HTTP请求和响应按照中间件组装的顺序在中间件之间流转的过程。开发人员可以对组成管道的中间件按照需要进行自由组合，比如调整中间件的顺序、添加或者删除中间件、定义中间件等。

总结：

1.中间件是组装到应用程序管道中以处理请求和响应的软件。
2.每个组件选择是否将请求传递给管道中的下一个组件。
3.每个组件可以在调用管道中的下一个组件之前和之后执行工作。
4.请求委托（Request delegates）用于构建请求管道，处理每个HTTP请求。

二、中间件的用途

中间件的一个常见的场景，就是日志记录。中间件可以轻松地将请求（包括URL和路由）记录到日志系统中，以便以后进行分析。

中间件也是进行授权和身份验证、诊断、异常记录和处理的好地方。

简而言之，中间件可以用于那些不是特定于业务领域的逻辑，以及需要在每个请求或大多数请求中发生的操作。

三、中间件的三个概念

Map、Use、Run。

Map：用来定义一个管道可以处理哪些请求

Use和Run：用来定义管道，一个管道由若干个Use和一个Run组成，每个Use引入一个中间件，而Run用来执行最终的核心应用逻辑 

1、Run()方法中只有一个RequestDelegate委托类型的参数，没有Next参数，所以Run()方法也叫终端中间件，不会将请求传递给下一个中间件，也就是发生了“短路” 。

// Run方法向应用程序的请求管道中添加一个RequestDelegate委托
// 放在管道最后面，终端中间件
app.Run(handler: async context =>
{
    await context.Response.WriteAsync(text: "Hello World1\r\n");
});
app.Run(handler: async context =>
{
    await context.Response.WriteAsync(text: "Hello World2\r\n");
});

2、Use()方法的参数是一个Func委托，输入参数是一个RequestDelegate类型的委托，返回参数也是一个RequestDelegate类型的委托，这里表示调用下一个中间件

// 向应用程序的请求管道中添加一个Func委托，这个委托其实就是所谓的中间件。
// context参数是HttpContext，表示HTTP请求的上下文对象
// next参数表示管道中的下一个中间件委托,如果不调用next，则会使管道短路
// 用Use可以将多个中间件链接在一起
app.Use(async (context, next) =>
{
    await context.Response.WriteAsync(text: "hello Use1\r\n");
    // 调用下一个委托
    await next();
});
app.Use(async (context, next) =>
{
    await context.Response.WriteAsync(text: "hello Use2\r\n");
    // 调用下一个委托
    await next();
});

四、自定义中间件

      中间件遵循显示依赖原则，并在其构造函数中暴露所有依赖项。中间件能够利用UseMiddleware扩展方法的优势，直接通过它们的构造函数注入服务。依赖注入服务是自动完成填充的。

ASP.NET Core约定中间件类必须包括以下内容：

1、具有类型为RequestDelegate参数的公共构造函数。

2、必须有名为Invoke或InvokeAsync的公共方法，此方法必须满足两个条件：方法返回类型是Task、方法的第一个参数必须是HttpContext类型。

自定义一个记录IP的中间件，新建一个类RequestIPMiddleware

using Microsoft.AspNetCore.Http;
using System.Threading.Tasks;
namespace MiddlewareDemo.Middleware
{
    /// <summary>
    /// 记录IP地址的中间件
    /// </summary>
    public class RequestIPMiddleware
    {
        // 私有字段
        private readonly RequestDelegate _next;
        /// <summary>
        /// 公共构造函数，参数是RequestDelegate类型
        /// 通过构造函数进行注入，依赖注入服务会自动完成注入
        /// </summary>
        /// <param name="next"></param>
        public RequestIPMiddleware(RequestDelegate next)
        {
            _next = next;
        }
        /// <summary>
        /// Invoke方法
        /// 返回值是Task，参数类型是HttpContext
        /// </summary>
        /// <param name="context">Http上下文</param>
        /// <returns></returns>
        public async Task Invoke(HttpContext context)
        {
            await context.Response.WriteAsync($"User IP:{context.Connection.RemoteIpAddress.ToString()}\r\n");
            // 调用管道中的下一个委托
            await _next.Invoke(context);
        }
    }
}

创建一个扩展方法，对IApplicationBuilder进行扩展

using Microsoft.AspNetCore.Builder;
namespace MiddlewareDemo.Middleware
{
    public static class RequestIPExtensions
    {
        /// <summary>
        /// 扩展方法，对IApplicationBuilder进行扩展
        /// </summary>
        /// <param name="builder"></param>
        /// <returns></returns>
        public static IApplicationBuilder UseRequestIP(this IApplicationBuilder builder)
        {
            // UseMiddleware<T>
            return builder.UseMiddleware<RequestIPMiddleware>();
        }
    }
}

最后在Startup类的Configure方法中使用自定义中间件

// 使用自定义中间件
app.UseRequestIP();

五、ASP.NET Core附带中间件组件

六、中间件和过滤器的区别

       中间件和过滤器都是一种AOP的思想。过滤器更加贴合业务，它关注于应用程序本身，关注的是如何实现业务，比如对输出结果进行格式化，对请求的ViewModel进行数据校验，这时就肯定要使用过滤器了。过滤器是MVC的一部分，它可以拦截到你Action上下文的一些信息，而中间件是没有这个能力的。可以认为过滤器是附加性的一种功能，它只是中间件附带表现出来的特征。中间件是管道模型里重要的组成部分，不可或缺，而过滤器可以没有。