使用Visual Studio Code開發Asp.Net Core WebApi學習筆記（四）-- Middleware

本文記錄了Asp.Net管道模型和Asp.Net Core的Middleware模型的對比，並在上一篇的基礎上增加Middleware功能支持。

在演示Middleware功能之前，先要了解一下Asp.Net管道模型發生了什么樣的變化。

第一部分：管道模型

1. Asp.Net管道

在之前的Asp.Net里，主要的管道模型流程如下圖所示：

請求進入Asp.Net工作進程后，由進程創建HttpWorkRequest對象，封裝此次請求有關的所有信息，然后進入HttpRuntime類進行進一步處理。HttpRuntime通過請求信息創建HttpContext上下文對象，此對象將貫穿整個管道，直到響應結束。同時創建或從應用程序池里初始化一個HttpApplication對象，由此對象開始處理之前注冊的多個HttpModule。之后調用HandlerFactory創建Handler處理程序，最終處理此次請求內容，生成響應返回。

下面用一個簡單的Asp.Net程序來驗證這個流程。

使用VS2015創建一個空的Asp.Net項目，根據向導添加HttpModule.cs、HttpHandler.cs、Global.asax文件

using System.Web;

namespace WebApplicationTest
{
    public class HttpModule1 : IHttpModule
    {
        public void Dispose()
        {

        }

        public void Init(HttpApplication context)
        {
            context.BeginRequest += (sender, e) =>
            {
                context.Response.Write("HttpModule1 request begin....<br />");
            };

            context.EndRequest += (sender, e) =>
            {
                context.Response.Write("HttpModule1 request end!<br />");
            };
        }
    }

    public class HttpModule2 : IHttpModule
    {
        public void Dispose()
        {

        }

        public void Init(HttpApplication context)
        {
            context.BeginRequest += (sender, e) =>
            {
                context.Response.Write("HttpModule2 request begin....<br />");
            };

            context.EndRequest += (sender, e) =>
            {
                context.Response.Write("HttpModule2 request end!<br />");
            };
        }
    }

    public class HttpModule3 : IHttpModule
    {
        public void Dispose()
        {

        }

        public void Init(HttpApplication context)
        {
            context.BeginRequest += (sender, e) =>
            {
                context.Response.Write("HttpModule3 request begin....<br />");
            };

            context.EndRequest += (sender, e) =>
            {
                context.Response.Write("HttpModule3 request end!<br />");
            };
        }
    }
}

using System.Web;

namespace WebApplicationTest
{
    public class HttpHandler : IHttpHandler
    {
        public bool IsReusable
        {
            get
            {
                return true;
            }
        }

        public void ProcessRequest(HttpContext context)
        {
            context.Response.ContentType = "text/html";
            context.Response.Write("Hello world!<br />");
            context.Response.End();
        }
    }
}

配置Web.Config。以下是在IIS7環境下的配置內容。

<?xml version="1.0" encoding="utf-8"?>
<!--
  有關如何配置 ASP.NET 應用程序的詳細信息，請訪問
  http://go.microsoft.com/fwlink/?LinkId=169433
  -->
<configuration>
  <system.web>
    <compilation debug="true" targetFramework="4.5"/>
    <httpRuntime targetFramework="4.5"/>
  </system.web>
  <system.webServer>
    <validation validateIntegratedModeConfiguration="false"/>
    <handlers>
      <add name="handler" verb="GET" path="index.handler" type="WebApplicationTest.HttpHandler,WebApplicationTest"/>
    </handlers>
    <modules>
      <add name="module1" type="WebApplicationTest.HttpModule1,WebApplicationTest"/>
      <add name="module2" type="WebApplicationTest.HttpModule2,WebApplicationTest"/>
      <add name="module3" type="WebApplicationTest.HttpModule3,WebApplicationTest"/>
    </modules>
  </system.webServer>
</configuration>

啟動調試，訪問地址 http://localhost:5383/index.handler ，可以看到頁面內容。

之前版本的Asp.Net MVC正是通過 UrlRoutingModule.cs 類和 MvcHandler.cs 類進行擴展從而實現了MVC框架。

2、Asp.Net Core管道

而在Asp.Net Core里面，管道模型流程發生了很大的變化：

IHttpModule和IHttpHandler不復存在，取而代之的是一個個中間件(Middleware)。

Server將接收到的請求直接向后傳遞，依次經過每一個中間件進行處理，然后由最后一個中間件處理並生成響應內容后回傳，再反向依次經過每個中間件，直到由Server發送出去。

中間件就像一層一層的“濾網”，過濾所有的請求和相應。這一設計非常適用於“請求-響應”這樣的場景——消息從管道頭流入最后反向流出。

接下來將演示在Asp.Net Core里如何實現中間件功能。

 

第二部分、Middleware

其實，在這個系列的第一篇里面，已經展示了管道的一個簡單用法。這里再詳細講解一下如何實現自定義管道。

Middleware支持Run、Use和Map三種方法進行注冊，下面將展示每一種方法的使用方式。

一、Run方法

所有需要實現的自定義管道都要在 Startup.cs 的 Configure 方法里添加注冊。

        public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory)
        {
            // 添加日志支持
            loggerFactory.AddConsole();
            loggerFactory.AddDebug();
            
            // 添加NLog日志支持
            loggerFactory.AddNLog();

            // 添加自定義中間件
            app.Run(async context =>
            {
                await context.Response.WriteAsync("Hello World!");
            });

            // 添加MVC中間件
            //app.UseMvc();
        }

啟動調試，訪問地址 http://localhost:5000/ ，頁面顯示Hello World！字樣。

再次添加一個Run方法

        public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory)
        {
            // 添加日志支持
            loggerFactory.AddConsole();
            loggerFactory.AddDebug();
            
            // 添加NLog日志支持
            loggerFactory.AddNLog();

            // 添加自定義中間件
            app.Run(async context =>
            {
                await context.Response.WriteAsync("Hello World!");
            });

            app.Run(async context =>
            {
                await context.Response.WriteAsync("Hello World too!");
            });

            // 添加MVC中間件
            //app.UseMvc();
        }

啟動調試，再次訪問發現頁面上只有Hello World!字樣。

原因是：Run的這種用法表示注冊的此中間件為管道內的最后一個中間件，由它處理完請求后直接返回。

二、Use方法 

        public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory)
        {
            // 添加日志支持
            loggerFactory.AddConsole();
            loggerFactory.AddDebug();
            
            // 添加NLog日志支持
            loggerFactory.AddNLog();

            // 添加自定義中間件
            app.Use(async (context, next) =>
            {
                await context.Response.WriteAsync("Hello World!");
            });

            // 添加MVC中間件
            //app.UseMvc();
        }

啟動調試，訪問頁面同樣顯示Hello World!字樣。我們發現使用Use方法替代Run方法，一樣可以實現同樣的功能。

再次添加一個Use方法，將原來的Use方法內容稍作調整，嘗試實現頁面顯示兩個Hello World!字樣。

        public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory)
        {
            // 添加日志支持
            loggerFactory.AddConsole();
            loggerFactory.AddDebug();
            
            // 添加NLog日志支持
            loggerFactory.AddNLog();

            // 添加自定義中間件
            app.Use(async (context, next) =>
            {
                await context.Response.WriteAsync("Hello World!");
                await next();
            });

            app.Use(async (context, next) =>
            {
                await context.Response.WriteAsync("Hello World too!");
            });

            // 添加MVC中間件
            //app.UseMvc();
        }

啟動調試，訪問頁面

將兩個Use方法換個順序，稍微調整一下內容，再次啟動調試，訪問頁面，發現字樣輸出順序也發生了變化。

        public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory)
        {
            // 添加日志支持
            loggerFactory.AddConsole();
            loggerFactory.AddDebug();
            
            // 添加NLog日志支持
            loggerFactory.AddNLog(); HelloworldMiddleware.cs 

            // 添加自定義中間件
            app.Use(async (context, next) =>
            {
                await context.Response.WriteAsync("Hello World too!");
                await next();
            });

            app.Use(async (context, next) =>
            {
                await context.Response.WriteAsync("Hello World!");
            });

            // 添加MVC中間件
            //app.UseMvc();
        }

從上面的例子可以發現，通過Use方法注冊的中間件，如果不調用next方法，效果等同於Run方法。當調用next方法后，此中間件處理完后將請求傳遞下去，由后續的中間件繼續處理。

當注冊中間件順序不一樣時，處理的順序也不一樣，這一點很重要，當注冊的自定義中間件數量較多時，需要考慮哪些中間件先處理請求，哪些中間件后處理請求。

另外，我們可以將中間件單獨寫成獨立的類，通過UseMiddleware方法同樣可以完成注冊。下面將通過獨立的中間件類重寫上面的演示功能。

新建兩個中間件類： HelloworldMiddleware.cs 、 HelloworldTooMiddleware.cs  

using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;

namespace WebApiFrame.Core.Middlewares
{
    public class HelloworldMiddleware
    {
        private readonly RequestDelegate _next;

        public HelloworldMiddleware(RequestDelegate next){
            _next = next;
        }

        public async Task Invoke(HttpContext context){
            await context.Response.WriteAsync("Hello World!");
            await _next(context);
        }
    }
}

using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;

namespace WebApiFrame.Core.Middlewares
{
    public class HelloworldTooMiddleware
    {
        private readonly RequestDelegate _next;

        public HelloworldTooMiddleware(RequestDelegate next){
            _next = next;
        }

        public async Task Invoke(HttpContext context){
            await context.Response.WriteAsync("Hello World too!");
        }
    }
}

修改 Startup.cs 的Configure方法內容

        public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory)
        {
            // 添加日志支持
            loggerFactory.AddConsole();
            loggerFactory.AddDebug();
            
            // 添加NLog日志支持
            loggerFactory.AddNLog();

            // 添加自定義中間件
            app.UseMiddleware<HelloworldMiddleware>();
            app.UseMiddleware<HelloworldTooMiddleware>();

            // 添加MVC中間件
            //app.UseMvc();
        }

啟動調試，訪問頁面，可以看到同樣的效果。

三、Map方法

Map方法主要通過請求路徑和其他自定義條件過濾來指定注冊的中間件，看起來更像一個路由。

修改 Startup.cs 的Configure方法內容，增加靜態方法MapTest

        public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory)
        {
            // 添加日志支持
            loggerFactory.AddConsole();
            loggerFactory.AddDebug();
            
            // 添加NLog日志支持
            loggerFactory.AddNLog();

            // 添加自定義中間件
            app.Map("/test", MapTest);

            // 添加MVC中間件
            //app.UseMvc();
        }

        private static void MapTest(IApplicationBuilder app){
            app.Run(async context => {
                await context.Response.WriteAsync("Url is " + context.Request.PathBase.ToString());
            });
        }

啟動調試，訪問路徑 http://localhost:5000/test ，頁面顯示如下內容

但是訪問其他路徑時，頁面沒有內容顯示。從這個可以看到，Map方法通過類似路由的機制，將特定的Url地址請求引導到固定的方法里，由特定的中間件處理。

另外，Map方法還可以實現多級Url“路由”，其實就是Map方法的嵌套使用

            // 添加自定義中間件
            app.Map("/level1", lv1App => {
                app.Map("/level1.1", lv11App => {
                    // /level1/level1.1

                });
                
                app.Map("/level1.2", lv12App => {
                    // /level1/level1.2

                });
            });

也可以通過MapWhen方法使用自定義條件進行“路由”

        public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory)
        {
            // 添加日志支持
            loggerFactory.AddConsole();
            loggerFactory.AddDebug();
            
            // 添加NLog日志支持
            loggerFactory.AddNLog();

            // 添加自定義中間件
            app.MapWhen(context =>
            {
                return context.Request.Query.ContainsKey("a");
            }, MapTest);

            // 添加MVC中間件
            //app.UseMvc();
        }

        private static void MapTest(IApplicationBuilder app)
        {
            app.Run(async context =>
            {
                await context.Response.WriteAsync($"Url is {context.Request.Path.ToString()}{context.Request.QueryString.Value}");
            });

        }

啟動調試，訪問路徑 http://localhost:5000/path?a=1&b=2 ，頁面顯示如下內容

只有當請求參數中含有a時，頁面才正常顯示內容。

四、其他內置的中間件

Asp.Net Core框架內置了幾個中間件

 

最后，用自定義中間件實現一個簡單的訪問日志記錄功能，記錄每一次請求的內容和響應時間。

1. 添加日志模型 VisitLog.cs 

using System;
using System.Collections.Generic;
using System.Linq;

namespace WebApiFrame.Models
{
    public class VisitLog
    {
        public string Url { get; set; }

        public IDictionary<string, string> Headers { get; set; } = new Dictionary<string, string>();

        public string Method { get; set; }

        public string RequestBody { get; set; }

        public DateTime ExcuteStartTime { get; set; }

        public DateTime ExcuteEndTime { get; set; }

        public override string ToString()
        {
            string headers = "[" + string.Join(",", this.Headers.Select(i => "{" + $"\"{i.Key}\":\"{i.Value}\"" + "}")) + "]";
            return $"Url: {this.Url},\r\nHeaders: {headers},\r\nMethod: {this.Method},\r\nRequestBody: {this.RequestBody},\r\nExcuteStartTime: {this.ExcuteStartTime.ToString("yyyy-MM-dd HH:mm:ss.fff")},\r\nExcuteStartTime: {this.ExcuteEndTime.ToString("yyyy-MM-dd HH:mm:ss.fff")}";
        }
    }
}

2. 添加訪問日志記錄中間件 VisitLogMiddleware.cs ，同時添加UseVisitLogger擴展方法。

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Logging;
using System;
using System.IO;
using System.Linq;
using System.Threading.Tasks;
using WebApiFrame.Models;

namespace WebApiFrame.Core.Middlewares
{
    public class VisitLogMiddleware
    {
        private readonly RequestDelegate _next;

        private readonly ILogger logger;

        private VisitLog visitLog;

        public VisitLogMiddleware(RequestDelegate next, ILoggerFactory loggerFactory)
        {
            _next = next;
            logger = loggerFactory.CreateLogger<VisitLogMiddleware>();
        }

        public async Task Invoke(HttpContext context)
        {
            visitLog = new VisitLog();
            HttpRequest request = context.Request;
            visitLog.Url = request.Path.ToString();
            visitLog.Headers = request.Headers.ToDictionary(k => k.Key, v => string.Join(";", v.Value.ToList()));
            visitLog.Method = request.Method;
            visitLog.ExcuteStartTime = DateTime.Now;

            using (StreamReader reader = new StreamReader(request.Body))
            {
                visitLog.RequestBody = reader.ReadToEnd();
            }

            context.Response.OnCompleted(ResponseCompletedCallback, context);
            await _next(context);
        }

        private Task ResponseCompletedCallback(object obj)
        {
            visitLog.ExcuteEndTime = DateTime.Now;
            logger.LogInformation($"VisitLog: {visitLog.ToString()}");
            return Task.FromResult(0);
        }
    }

    public static class VisitLogMiddlewareExtensions
    {
        public static IApplicationBuilder UseVisitLogger(this IApplicationBuilder builder)
        {
            return builder.UseMiddleware<VisitLogMiddleware>();
        }
    }
}

3. 在 Startup.cs 添加中間件支持

        public void Configure(IApplicationBuilder app, ILoggerFactory loggerFactory)
        {
            // 添加日志支持
            loggerFactory.AddConsole();
            loggerFactory.AddDebug();
            
            // 添加NLog日志支持
            loggerFactory.AddNLog();

            // 添加自定義中間件
            app.UseVisitLogger();

            app.Run(async context =>
            {
                await context.Response.WriteAsync("Hello World!");
            });


            // 添加MVC中間件
            //app.UseMvc();
        }

4. 啟動調試，訪問地址 http://localhost:5000/ ，查看調試控制台日志打印信息。

另外，如果你比較細心會發現，在Configure方法里有這樣一句代碼： app.UseMvc(); ，Asp.Net Core Mvc正是通過這個方法借用中間件來擴展實現了MVC框架。