淺談ASP.NET Core 2.0 帶初始參數(shù)的中間件(譯)

更新時(shí)間：2017年10月23日 17:07:09 作者：三生石上(FineUI控件)

這篇文章主要介紹了淺談ASP.NET Core 2.0 帶初始參數(shù)的中間件(譯)，非常具有實(shí)用價(jià)值，需要的朋友可以參考下

問(wèn)題

如何在ASP.NET Core 2.0向中間件傳入初始參數(shù)？

答案

在一個(gè)空項(xiàng)目中，創(chuàng)建一個(gè)POCO（Plain Old CLR Object）來(lái)保存中間件所需的參數(shù)：

public class GreetingOptions
{
  public string GreetAt { get; set; }
  public string GreetTo { get; set; }
}

添加一個(gè)中間件：

public class GreetingMiddleware
{
  private readonly RequestDelegate _next;
  private readonly GreetingOptions _options;

  public GreetingMiddleware(RequestDelegate next, GreetingOptions options)
  {
    _next = next;
    _options = options;
  }

  public async Task Invoke(HttpContext context)
  {
    var message = $"Good {_options.GreetAt} {_options.GreetTo}";
    await context.Response.WriteAsync(message);
  }
}

答案1：實(shí)例類(lèi)型

添加一個(gè)擴(kuò)展方法來(lái)配置中間件：

public static IApplicationBuilder UseGreetingMiddleware(this IApplicationBuilder app, GreetingOptions options)
{
  return app.UseMiddleware<GreetingMiddleware>(options);
}

使用中間件：

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
  app.UseGreetingMiddleware(new GreetingOptions {
    GreetAt = "Morning",
    GreetTo = "Tahir"
  });
}

答案2：函數(shù)類(lèi)型

添加一個(gè)擴(kuò)展方法來(lái)配置中間件：


public static IApplicationBuilder UseGreetingMiddlewareAction(this IApplicationBuilder app, Action<GreetingOptions> optionsAction)
{
  var options = new GreetingOptions();
  optionsAction(options);

  return app.UseMiddleware<GreetingMiddleware>(options);
}

使用中間件：

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
  app.UseGreetingMiddlewareAction(options =>
  {
    options.GreetAt = "Morning";
    options.GreetTo = "Tahir";
  });
}

上述兩種方法結(jié)果一致。

運(yùn)行，此時(shí)頁(yè)面顯示：

討論

之前我們?cè)懻撨^(guò)，在單獨(dú)的類(lèi)中定義中間件并使用擴(kuò)展方法將其添加到請(qǐng)求管道中是最佳實(shí)踐。我們也可能需要向中間件傳入?yún)?shù)，通過(guò)對(duì)ASP.NET Core源代碼以及其他在線示例的學(xué)習(xí)，我總結(jié)出來(lái)上面兩種模式。

上述的兩種解決方法都非常直觀。我們將參數(shù)封裝到一個(gè)POCO類(lèi)中，然后創(chuàng)建一個(gè)擴(kuò)展方法來(lái)接受下面的參數(shù)：

1. POCO實(shí)例

2. 需要調(diào)用的函數(shù)（在函數(shù)內(nèi)設(shè)置POCO）

注：POCO實(shí)例通過(guò)構(gòu)造函數(shù)傳入中間件。UseMiddleware()方法接收可變參數(shù)params object[]，并將這些參數(shù)傳入中間件構(gòu)造函數(shù)。

配置服務(wù)

這些模式也能用于向服務(wù)容器中添加服務(wù)實(shí)例。為了便于說(shuō)明，我們先添加一個(gè)服務(wù)：

public interface IMessageService
{
  string FormatMessage(string message);
}

public class MessageService : IMessageService
{
  private readonly GreetingOptions _options;

  public MessageService(GreetingOptions options)
  {
    _options = options;
  }

  public string FormatMessage(string message)
  {
    return $"Good {_options.GreetAt} {_options.GreetTo} - {message}";
  }
}

添加如下任一個(gè)擴(kuò)展方法來(lái)配置服務(wù)：

public static IServiceCollection AddMessageService(this IServiceCollection services, GreetingOptions options)
{
  return services.AddScoped<IMessageService>(factory => new MessageService(options));
}

public static IServiceCollection AddMessageServiceAction(this IServiceCollection services, Action<GreetingOptions> optionsAction)
{
  var options = new GreetingOptions();
  optionsAction(options);

  return services.AddScoped<IMessageService>(factory => new MessageService(options));
}

在Configure()中使用此服務(wù)：

public void ConfigureServices(IServiceCollection services)
{
  services.AddMessageService(new GreetingOptions
  {
    GreetAt = "Morning",
    GreetTo = "Tahir"
  });

  services.AddMessageServiceAction(options =>
  {
    options.GreetAt = "Morning";
    options.GreetTo = "Tahir";
  });
}

因?yàn)镃onfigureServices()先于Configure()執(zhí)行，因此我們可以直接在Configure()注入此服務(wù)：

public void Configure(IApplicationBuilder app, IHostingEnvironment env, IMessageService msg)
{
  app.Run(async (context) =>
  {
    await context.Response.WriteAsync(msg.FormatMessage("by sanshi"));
  });
}

運(yùn)行，此時(shí)頁(yè)面顯示：