讀ASP.NET 5 中Middleware有什么用

本篇文章給大家分享的是有關(guān)讀ASP.NET 5 中Middleware有什么用，小編覺得挺實(shí)用的，因此分享給大家學(xué)習(xí)，希望大家閱讀完這篇文章后可以有所收獲，話不多說，跟著小編一起來看看吧。

Middleware的注冊(cè)和配置

在ASP.NET5中，request請(qǐng)求管線（Pipeline）的訪問是在Startup類中進(jìn)行的，該類時(shí)一個(gè)約定類，并且里面的ConfigureServices方法、Configure方法、以及相應(yīng)的參數(shù)也是事先約定的，所以不能進(jìn)行改動(dòng)。

Middleware中的依賴處理：ConfigureServices方法

在ASP.NET5中的各種默認(rèn)的Middleware中，都使用了依賴注入的功能，所以在使用Middleware中的功能時(shí)，需要提前將依賴注入所需要的類型及映射關(guān)系都注冊(cè)到依賴注入管理系統(tǒng)中，即IServiceCollection集合，而ConfigureServices方法接收的就一個(gè)IServiceCollection類型的參數(shù)，該參數(shù)就是所有注冊(cè)過類型的集合，通過原生的依賴注入組件進(jìn)行管理（關(guān)于ASP.NET5中的依賴注入，我們會(huì)在單獨(dú)章節(jié)中進(jìn)行講解），在該方法內(nèi)，我們可以向該集合中添加新的類型和類型映射關(guān)系，示例如下：

// Add MVC services to the services container.
services.AddMvc();

示例中的代碼用于向系統(tǒng)添加Mvc模塊相關(guān)的Service類型以支撐MVC功能，該方法是一個(gè)擴(kuò)展方法，用于在集合中添加與MVC相關(guān)的多個(gè)類型。

Middleware的注冊(cè)和配置：Configure方法

Configure方法的簽名如下：

public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerfactory)
{
 // ...
}

Configure方法接收了三個(gè)參數(shù)：IApplicationBuilder類型的參數(shù)用于構(gòu)建整個(gè)應(yīng)用程序的配置信息，IHostingEnvironment類的env參數(shù)用于訪問系統(tǒng)環(huán)境變量相關(guān)的內(nèi)容，ILoggerFactory類型的loggerfactory用于日志相關(guān)的內(nèi)容處理，其中IApplicationBuilder類型的參數(shù)最為重要，該參數(shù)實(shí)例app上有一系列的擴(kuò)展方法用于將各種Middleware注冊(cè)到request請(qǐng)求管線（Pipeline）中。這種方式和之前ASP.NET中的HTTP管線的主要區(qū)別是：新版本中的組合模型替換了舊版本中的事件模型。這也就要求，在新版ASP.NET中，Middleware組件注冊(cè)的順序是非常重要的，因?yàn)楹笠粋€(gè)組件可能要使用到前一個(gè)組件，所以必須按照依賴的先后順序進(jìn)行注冊(cè)，舉例如下，當(dāng)前MVC項(xiàng)目的模板代碼示例如下：

// Add static files to the request pipeline.
app.UseStaticFiles();

// Add cookie-based authentication to the request pipeline.
app.UseIdentity();

// Add MVC to the request pipeline.
app.UseMvc(routes =>{ /*...*/});

示例中的UseStaticFiles、UseIdentity、UseMvc都是IApplicationBuilder上的擴(kuò)展方法，在擴(kuò)展方法中，都會(huì)通過調(diào)用擴(kuò)展方法app.UseMiddleware方法，最終再調(diào)用app.Use方法來注冊(cè)新的Middleware，該方法定義如下：

public interface IApplicationBuilder
{
 //...
 IApplicationBuilder Use(Func<RequestDelegate, RequestDelegate> middleware);
}

通過代碼，可以看出，middleware是Func<RequestDelegate, RequestDelegate>的一個(gè)實(shí)例，該Func接收一個(gè)RequestDelegate的參數(shù)，并返回一個(gè)RequestDelegate類型的值。RequestDelegate的源碼如下：

public delegate Task RequestDelegate(HttpContext context);

通過源碼，我們可以看出，RequestDelegate是一個(gè)委托函數(shù)，其接收HttpContext類型的實(shí)例，并返回一個(gè)Task類型的異步對(duì)象。也就是說RequestDelegate是一個(gè)可以返回自身RequestDelegate類型函數(shù)的函數(shù)，整個(gè)ASP.NET也就是利用這種方式構(gòu)建了管線（Pipelien）的組成，在這里，每個(gè)middleware都鏈?zhǔn)降较乱粋€(gè)middleware上，并在整個(gè)過程中可以對(duì)HttpConext對(duì)象進(jìn)行修改或維護(hù)，當(dāng)然，HttpContext中就包括了我們常操作的HttpRequest和HttpResponse實(shí)例對(duì)象。

注意：HttpContext、HttpRequest、HttpResponse在ASP.NET 5中都是重新定義的新類型。

Middleware的定義

既然每個(gè)middleare都是Func<RequestDelegate, RequestDelegate>的一個(gè)實(shí)例，那是不是Middleware的定義要滿足一個(gè)規(guī)則？是繼承于一個(gè)抽象基類還是借口？通過翻查相關(guān)的代碼，我們看到，Middleware是基于約定的形式來定義的，具體約定規(guī)則如下：

構(gòu)造函數(shù)的第一個(gè)參數(shù)必須是處理管線中的下一個(gè)處理函數(shù)，即RequestDelegate；必須有一個(gè) Invoke 函數(shù)， 并接受上下文參數(shù)（即HttpContent）， 然后返回 Task；

示例如下：

public class MiddlewareName
{
 RequestDelegate _next;

 public MiddlewareName(RequestDelegate next)
 {
  _next = next;// 接收傳入的RequestDelegate實(shí)例
 }

 public async Task Invoke(HttpContext context)
 {
  // 處理代碼，如處理context.Request中的內(nèi)容

  Console.WriteLine("Middleware開始處理");

  await _next(context);

  Console.WriteLine("Middleware結(jié)束處理");

  // 處理代碼，如處理context.Response中的內(nèi)容
 }
}

通過該模板代碼可以看到，首先一個(gè)Middleware的構(gòu)造函數(shù)要接收一個(gè)RequestDelegate的實(shí)例，先保存在一個(gè)私有變量里，然后通過調(diào)用Invoke方法（并接收HttpContent實(shí)例）并返回一個(gè)Task，并且在調(diào)用Invoke的方法中，要通過await _next(context);語句，鏈?zhǔn)降较乱粋€(gè)Middleware上，我們的處理代碼主要就是在鏈?zhǔn)秸Z句的前后執(zhí)行相關(guān)的代碼。

舉個(gè)例子，如果我們要想記錄頁面的執(zhí)行時(shí)間，首先，我們先定義一個(gè)TimeRecorderMiddleware，代碼如下：

public class TimeRecorderMiddleware
{
 RequestDelegate _next;

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

 public async Task Invoke(HttpContext context)
 {
  var sw = new Stopwatch();
  sw.Start();


  await _next(context);

  var newDiv = @"<div id=""process"">頁面處理時(shí)間：{0} 毫秒</div></body>";
  var text = string.Format(newDiv, sw.ElapsedMilliseconds);
  await context.Response.WriteAsync(text);
 }
}

Middleware的注冊(cè)有很多種方式，如下是實(shí)例型注冊(cè)代碼：

app.Use(next => new TimeRecorderMiddleware(next).Invoke);

或者，你也可以使用UseMiddleware擴(kuò)展方法進(jìn)行注冊(cè)，示例如下：

app.UseMiddleware<TimeRecorderMiddleware>();
//app.UseMiddleware(typeof(TimeRecorderMiddleware)); 兩種方式都可以

當(dāng)然，你也可以定義一個(gè)自己的擴(kuò)展方法用于注冊(cè)該Middleware，代碼如下：

public static IApplicationBuilder UseTimeRecorderMiddleware(this IApplicationBuilder app)
{
 return app.UseMiddleware<TimeRecorderMiddleware>();
}

最后在Startup類的Configure方法內(nèi)進(jìn)行注冊(cè)，代碼如下：

public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerfactory)
{
 app.UseTimeRecorderMiddleware(); // 要放在前面，以便進(jìn)行統(tǒng)計(jì)，如果放在Mvc后面的話，就統(tǒng)計(jì)不了時(shí)間了。

 // 等等
}

編譯，重啟，并訪問頁面，在頁面的底部即可看到頁面的運(yùn)行時(shí)間提示內(nèi)容。

常用Middleware功能的使用

app.UseErrorPage()
在IHostingEnvironment.EnvironmentName為Development的情況下，才顯示錯(cuò)誤信息，并且錯(cuò)誤信息的顯示種類，可以通過額外的ErrorPageOptions參數(shù)來設(shè)定，可以設(shè)置全部顯示，也可以設(shè)置只顯示Cookies、Environment、ExceptionDetails、Headers、Query、SourceCode SourceCodeLineCount中的一種或多種。

app.UseErrorHandler("/Home/Error")
捕獲所有的程序異常錯(cuò)誤，并將請(qǐng)求跳轉(zhuǎn)至指定的頁面，以達(dá)到友好提示的目的。

app.UseStaticFiles()
開啟靜態(tài)文件也能走該P(yáng)ipeline管線處理流程的功能。

app.UseIdentity()
開啟以cookie為基礎(chǔ)的ASP.NET identity認(rèn)證功能，以支持Pipeline請(qǐng)求處理。

直接使用委托定義Middleware的功能

由于Middleware是Func<RequestDelegate, RequestDelegate>委托類型的實(shí)例，所以我們也可以不必定義一個(gè)單獨(dú)的類，在Startup類里，使用委托調(diào)用的方式就可以了，示例如下：

public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerfactory)
{
 app.Use(new Func<RequestDelegate, RequestDelegate>(next => content => Invoke(next, content)));
 // 其它
}

// 注意Invoke方法的參數(shù)
private async Task Invoke(RequestDelegate next, HttpContext content)
{
 Console.WriteLine("初始化組件開始");
 await next.Invoke(content);
 Console.WriteLine("管道下步執(zhí)行完畢");
}

做個(gè)簡便的Middleware基類

雖然有約定方法，但有時(shí)候我們?cè)陂_發(fā)的時(shí)候往往會(huì)犯迷糊，想不起來到底是什么樣的約定，所以，在這里我們可以定義一個(gè)抽象基類，然后以后所有的Middleware在定義的時(shí)候都繼承該抽象類并重載Invoke方法即可，從而可以避免約定忘記的問題。代碼如下：

/// <summary>
/// 抽象基類
/// </summary>
public abstract class AbstractMiddleware
{
 protected RequestDelegate Next { get; set; }
 protected AbstractMiddleware(RequestDelegate next)
 {
  this.Next = next;
 }
 public abstract Task Invoke(HttpContext context);
}

/// <summary>
/// 示例Middleware
/// </summary>
public class DemoMiddleware : AbstractMiddleware
{
 public DemoMiddleware(RequestDelegate next) : base(next)
 {
 }
 public async override Task Invoke(HttpContext context)
 {
  Console.WriteLine("DemoMiddleware Start.");
  await Next.Invoke(context);
  Console.WriteLine("DemoMiddleware End.");
 }
}

使用方法和上面的一樣。

終止鏈?zhǔn)秸{(diào)用或阻止所有的Middleware

在有些情況下，當(dāng)然根據(jù)某些條件判斷以后，可能不在需要繼續(xù)往下執(zhí)行下去了，而是想知己誒返回結(jié)果，那么你可以在你的Middleware里忽略對(duì)await next.Invoke(content);的調(diào)用，直接使用·Response.WriteAsync·方法輸出內(nèi)容。

另外，在有些情況下，你可能需要實(shí)現(xiàn)類似之前版本中的handler的功能，即不經(jīng)常任何Pipeline直接對(duì)Response進(jìn)行響應(yīng)，新版ASP.NET里提供了一個(gè)run方法用于實(shí)現(xiàn)該功能，只需要在Configure方法里調(diào)用如下代碼即可實(shí)現(xiàn)類似的內(nèi)容輸出。

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

關(guān)于ASP.NET 5 Runtime的內(nèi)容，請(qǐng)?jiān)L問：https://msdn.microsoft.com/en-us/magazine/dn913182.aspx

遺留問題

在Mvc項(xiàng)目中，所有的依賴注入類型都是通過IServiceProvider實(shí)例來獲取的，目前可以通過以下形式獲取該實(shí)例：

var services = Context.RequestServices; // Controller中
var services = app.ApplicationServices; // Startup中

獲取了該實(shí)例以后，即可通過如下方法來獲取某個(gè)類型的對(duì)象：

var controller = (AccountController)services.GetService(typeof(AccountController));
// 要判斷獲取到的對(duì)象是否為null

如果你引用了Microsoft.Framework.DependencyInjection命名空間的話，還可以使用如下三種擴(kuò)展方法：

var controller2 = (AccountController)services.GetService<AccountController>(); 
// 要判斷獲取到的對(duì)象是否為null

//如下兩種方式，如果獲取到的AccountController實(shí)例為null的話，就會(huì)字段拋異常，而不是返回null
var controller3 = (AccountController)services.GetRequiredService(typeof(AccountController));
var controller4 = (AccountController)services.GetRequiredService<AccountController>();

那么問題來了？如何不在Startup和Controller里就可以獲取到HttpContext和IApplicationBuilder實(shí)例以便使用這些依賴注入服務(wù)？

如何獲取IApplicationBuilder實(shí)例？
答案：在Startup里將IApplicationBuilder實(shí)例保存在一個(gè)單例中的變量上，后期全站就可以使用了。

如何獲取HttpContext實(shí)例？
答案：參考依賴注入章節(jié)的普通類的依賴注入

以上就是讀ASP.NET 5 中Middleware有什么用，小編相信有部分知識(shí)點(diǎn)可能是我們?nèi)粘９ぷ鲿?huì)見到或用到的。希望你能通過這篇文章學(xué)到更多知識(shí)。更多詳情敬請(qǐng)關(guān)注億速云行業(yè)資訊頻道。