前言
其實(shí)地上本沒有路，走的人多了，也便成了路。 -- 魯迅
就像上面魯迅說的那樣，其實(shí)在我們開發(fā)中間件的過程中，微軟并沒有制定一些策略或者文檔來約束你如何編寫一個(gè)中間件程序， 但是其中卻存在者一些最佳實(shí)踐的方法，大多數(shù)人來使用這種方法來使應(yīng)用程序變得更加容易理解并且易于維護(hù)，這就叫“路”，在2017年，這叫套路。
在掌握了這些套路之后，能夠幫助你迅速的搭建一個(gè)中間件的基本框架，并且易于擴(kuò)展和維護(hù)，下面我們就來看看怎么樣從頭開始開發(fā)一個(gè)中間件吧。
如果你對(duì) ASP.NET Core HTTP 管道還不太清楚的話，下面這篇文章將有助于你對(duì)其進(jìn)行一個(gè)系統(tǒng)的了解：
http://www.cnblogs.com/savorboard/p/aspnetcore-http-pipeline.html
Getting Started
說明： 這只是通常情況下，具體的情況還請(qǐng)使用具體的套路。
Setup 1 創(chuàng)建擴(kuò)展類
如果你的中間件需要一個(gè)向 ASP.NET Core 的 DI 容器中添加默認(rèn)的一些服務(wù)的話，那么你就編寫一個(gè)需要擴(kuò)展類，用來在 Startup.cs 中的 ConfigureServices 中注冊(cè)服務(wù)。
舉例，Microsoft.AspNetCore.ResponseCompression 這是一個(gè)用來壓縮請(qǐng)求內(nèi)容的一個(gè)中間件，那么它就需要一個(gè)服務(wù)用來處理壓縮相關(guān)的東西，所以它擴(kuò)展了 IServiceCollection 并且添加了自己的 Services。
整個(gè)中間件的核心代碼并非在這里，這里只是一個(gè)開始，那么有同學(xué)可能會(huì)問了，什么情況下我們需要提前向一個(gè)DI里面注入我們中間件需要的服務(wù)呢？ 答案是，如果你不知道或者不確定你需要什么樣的服務(wù)的時(shí)候，跳過此步驟，進(jìn)入下一步，再等你需要的時(shí)候再回頭來補(bǔ)上就是。
那么，我們先看一下編寫一個(gè)擴(kuò)展Service的靜態(tài)類應(yīng)該怎么做？
首先，新建一個(gè)以 xxxServicesExtensions 文件名結(jié)尾的靜態(tài)類，用來編寫注入DI的擴(kuò)展方法。
類建立完成之后，需要向里面添加內(nèi)容了。通常情況下，中間件中 Service 的擴(kuò)展方法都是以 Addxxx(this IServiceCollection services) 開頭來命名。在這里有一個(gè)需要注意的地方就是它的命名空間，通常情況下我們使用 using Microsoft.AspNetCore.Builder 這個(gè)命名空間。
然后，方法里面就是需要注冊(cè)的服務(wù)了。假設(shè)我們需要向里面注冊(cè)一個(gè) IResponseCompressionProvider 和 它的實(shí)現(xiàn)類 ResponseCompressionProvider，那么最終的擴(kuò)展方法可能看起來是這樣的。
using System;
using Microsoft.AspNetCore.ResponseCompression;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.DependencyInjection.Extensions;
namespace Microsoft.AspNetCore.Builder
{
public static IServiceCollection AddResponseCompression(this IServiceCollection services)
{
if (services == null)
{
throw new ArgumentNullException(nameof(services));
}
services.TryAddSingleton<IResponseCompressionProvider, ResponseCompressionProvider>();
return services;
}
}
Setup 2 創(chuàng)建配置類
有的時(shí)候，用戶在使用我們編寫的中間件的時(shí)候，我們需要向提供者提供一些配置項(xiàng)，這些配置項(xiàng)在中間件執(zhí)行之前用來傳遞一些必要參數(shù)信息或者是一些設(shè)置信息。舉個(gè)我們熟悉例子，我們?cè)谑褂?MVC 中間件的時(shí)候，可能會(huì)看到以下寫法：
// Startup.cs
public void ConfigureServices(IServiceCollection services)
{
var userDefinedFilter = new xxxFilter();
services.AddMvc(x => x.Filters.Add(userDefinedFilter));
}
可以看到，用戶可將一些自定義的 Filter 傳入到中間件的，然后中間件在運(yùn)行的時(shí)候，我們傳入的 Filter 就生效了。
注意，中間件使用的配置項(xiàng)有兩種添加方法，一種是添加到 AddMiddleware(Action<xxxOptions> option) 另外一種是 UseMiddleware<>(Action<xxxOptions> option)，那么這兩種有什么區(qū)別呢？
那么，前者Add中的配置項(xiàng)一般情況下是中間執(zhí)行之前就需要的一些信息，也就是說中間件的啟動(dòng)就依賴于這些配置項(xiàng)，他放置于容器配置（Add DI Service）的時(shí)候添加進(jìn)去更加方便或者合適的時(shí)候使用它，另外一種（后者）是容器已經(jīng)構(gòu)建完畢，不需要依賴于容器提供的配置項(xiàng)可以使用此種方式。
同樣的道理，當(dāng)你自己為你的用戶編寫一個(gè)中間件的時(shí)候，當(dāng)你也需要用戶可以自定義一些配置或者需要傳入一些參數(shù)的時(shí)候，你也可以這么做。那到底怎么樣做呢？ 我們一起來看看。
首先，我們需要一個(gè) xxxOptions 結(jié)尾的配置類，用來配置我們中間件需要的一些配置項(xiàng)。我們還是以上面的壓縮中間件舉例。
public class GzipCompressionProviderOptions : IOptions<GzipCompressionProviderOptions>
{
public CompressionLevel Level { get; set; } = CompressionLevel.Fastest;
GzipCompressionProviderOptions IOptions<GzipCompressionProviderOptions>.Value => this;
}
它其中配置了一個(gè)壓縮的等級(jí) CompressionLevel ，這是一個(gè)枚舉字段。 然后我們可以看到，這個(gè)類它繼承了 IOptions<out T> 接口，這是一個(gè)知識(shí)點(diǎn)，什么意思呢？ IOptions<out TOptions> 是 ASP.NET Core 新的一個(gè)配置體系里面的一個(gè)接口，當(dāng)你實(shí)現(xiàn)這個(gè)接口之后，ASP.NET Core DI 容器提供了了一個(gè) services.Configure<xxxOptions> 這樣的方法來讓你把配置項(xiàng)注入到容器中，當(dāng)然你也可以將配置項(xiàng)和 appsetting.json 中的配置關(guān)聯(lián)起來，以便于配置一些在運(yùn)行期可能需要變動(dòng)信息。更多關(guān)于 IOptions<T> 的信息可以看 這里的翻譯。
這個(gè) xxxOptions 類通常情況下會(huì)提供一些默認(rèn)值，也就是說當(dāng)用戶不提供這些參數(shù)的時(shí)候，你需要有一個(gè)合理的機(jī)制或者默認(rèn)值來正常運(yùn)行你的中間件。
假如你的配置項(xiàng)有很多，也就是說還有進(jìn)一步比較細(xì)化的配置，那么你可以做一個(gè)封裝，就像MVC的Options類一樣，這樣能夠給你的中間件提供更加合理的維護(hù)和擴(kuò)展。
Setup 3 核心中間件
接下來，就是我們的核心代碼類了，通常情況下會(huì)有一個(gè) xxxMiddleware 結(jié)尾的類用來處理 HTTP 管道請(qǐng)求中的一些業(yè)務(wù)，這個(gè)類的構(gòu)造函數(shù)中已經(jīng)可以使用在Setup1或者Setup2中向DI容器中注冊(cè)的服務(wù)了。
按照約定，Middleware 類中需要有一個(gè) Invoke 方法，用來處理中間件的核心業(yè)務(wù)，它的簽名如下：
public Task Invoke(HttpContext httpContext);
注意，這是一個(gè)約定方法，并沒有接口來約束它。在 Invoke 方法中，是中間件實(shí)現(xiàn)的核心代碼。 示例如下：
public class xxxMiddleware
{
private readonly RequestDelegate _next;
public xxxMiddleware(RequestDelegate next)
{
if (next == null)
{
throw new ArgumentNullException(nameof(next));
}
_next = next;
}
public async Task Invoke(HttpContext context)
{
// ......
await _next(context);
return;
}
}
在 xxxMiddleware 這個(gè)里面有一個(gè)構(gòu)造函數(shù)參數(shù) RequestDelegate，它是一個(gè)委托，代表的需要執(zhí)行的下一個(gè)中間件，通常情況下我們會(huì)把它放到我們業(yè)務(wù)代碼的末尾。
Setup 4 中間件擴(kuò)展注冊(cè)
中間件有三種注冊(cè)方法（Run，Map，Use），我們暫不考慮Run和Map，因?yàn)樗麄冎贿m用于很小和少的一些情況
完成了以上工作后，接下來，我們需要把中間件注冊(cè)到我們的 ASP.NET Core 的執(zhí)行，這個(gè)時(shí)候我們需要一個(gè) xxxBuilderExtensions 類，它也是一個(gè)靜態(tài)類，注意它的命名空間通常為
Microsoft.AspNetCore.Builder，因?yàn)檫@個(gè)用戶在使用我們的中間件的時(shí)候就不必再添加額外的命令空間，依靠 Visual Studio 的智能提示就可以很快速的搜索到。我們來看一下示例：
using System;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.DependencyInjection.Extensions;
namespace Microsoft.AspNetCore.Builder
{
public static class xxxBuilderExtensions
{
public static IApplicationBuilder UseResponseCompression(this IApplicationBuilder builder)
{
if (builder == null)
{
throw new ArgumentNullException(nameof(builder));
}
return builder.UseMiddleware<xxxMiddleware>();
}
}
}
Yeoman 一秒鐘
有同學(xué)可能會(huì)說了，這些套路既然是這樣的，那么有沒有什么代碼生成工具來幫我做這些事情呢？答案是肯定的。
博主已經(jīng)幫你們把工具做好了，它使用的是當(dāng)今最流行的腳手架工具 npm 中的 Yeoman 。使用它可以幫助你迅速的搭建一個(gè)中間件解決方案代碼模板，讓你專注于業(yè)務(wù)開發(fā)。
我已經(jīng)把這個(gè)模板上傳于 Yeoman 的倉庫中，你只需要按照如下命令就可以幫你自動(dòng)生成一套 ASP.NET Core 中間件解決方案代碼模板了，當(dāng)然單元測(cè)試也包含其中。
npm 工具的安裝相信你自己可以的。下面是安裝 Yeoman 工具和博主的模板工具。
// 安裝 Yeoman 腳手架工具 -g 命令為全局安裝
npm install -g yo
// 安裝博主的 Yeoman(ASP.NET Core Middleware)模板
npm install -g generator-aspnetcore-middleware
然后選擇你需要生成解決方案的文件夾，使用如下命令生成。
yo aspnetcore-middleware
注意：生成的過程中需要輸入你中間件的名稱。按要求輸入即可。
總結(jié)
本篇文章主要講述了從頭創(chuàng)建一個(gè) ASP.NET Core 的流程，這適用于大多數(shù)場(chǎng)合，但是并不代表所有的場(chǎng)合，在實(shí)際開發(fā)的過程中還需要具體的考慮一下。接著博主提供了一個(gè)yo自動(dòng)化腳手架模板用來快速創(chuàng)建一個(gè)中間件解決方案。
如果你覺得這篇文章對(duì)你有幫助的話，謝謝你的【推薦】。
如果你對(duì) .NET Core 感興趣可以關(guān)注我，我會(huì)定期在博客分享關(guān)于 .NET Core 的學(xué)習(xí)心得。
本文地址：http://www.cnblogs.com/savorboard/p/generator-aspnetcore-middleware.html
作者博客：Savorboard
歡迎轉(zhuǎn)載，請(qǐng)?jiān)诿黠@位置給出出處及鏈接