在 ASP.NET Core 中使用扩展方法中的中间件配置

Question

我开发了一个 ASP.NET Core 中间件。我在这篇文章中简化了中间件，让问题更清晰。

中间件在Startup.cs中配置如下：

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    ...
    app.UseMyMiddleware(42);
    ...
}

整数（42）存储在中间件实例中，一切正常。

现在我想创建一些辅助方法作为扩展方法：

public static int Add(this int i)
{
    return i + TODO;
}

我想要将i 的值添加到发送到中间件的值（42）的方法。

目前我已将42 的值保存在中间件内的公共静态变量中，并通过我的扩展方法访问它：

public static int Add(this int i)
{
    return i + MyMiddleware.Value;
}

出于各种原因，我不喜欢这个解决方案。任何关于如何以更好的方式解决此问题的想法都将受到高度赞赏。

Answer 1

一般来说，这不适用于扩展方法。扩展方法是静态的，因此只能访问其他静态成员。然而，ASP.NET Core 按设计不使用任何静态，并广泛使用 dependency injection 来管理对象的生命周期和访问依赖项。

所以通常，正确的方法是将扩展方法移动到某种非静态帮助对象中，然后您可以将其注入到您需要访问它的位置。当然，这不会让您在任何需要的地方轻松调用它，而是要求您显式依赖它（这是依赖注入的要点之一）。

话虽如此，您的明确案例有点不同。从你的linked pull request 可以看出，你的扩展方法是这样的（注意，我在这里结合了两种方法来说明）：

public static async Task ShipAsync(this Exception exception, HttpContext context)
{
    await MessageShipper.ShipAsync(
        ElmahIoMiddleware.ApiKey.AssertApiKeyInMiddleware(),
        ElmahIoMiddleware.LogId.AssertLogIdInMiddleware(),
        exception.Message, context, new ElmahIoSettings(), exception);
}

为什么这很重要？因为您正在传递HttpContext。 HTTP 上下文使我们能够访问依赖注入。所以我们实际上可以从依赖注入容器中解决问题：

public static async Task ShipAsync(this Exception exception, HttpContext context)
{
    var elmahIoConfig = context.RequestServices.GetService<ElmahIoConfiguration>();

    await MessageShipper.ShipAsync(
        elmahIoConfig.ApiKey,
        elmahIoConfig.LogId,
        exception.Message, context, new ElmahIoSettings(), exception);
}

现在，您只需确保在注册中间件时正确填写 ElmahIoConfiguration。请注意，我不是在这里请求中间件实例，因为中间件通常没有注册依赖注入。引入一个单独的对象更有意义，然后您可以将其注入中间件并在那里初始化。

在您的情况下，您应该真正将中间件配置移动到您的应用程序设置中，并使用IOptions<> 模式在ConfigureServices 级别对其进行配置。在将中间件添加到 Configure 中的管道时配置中间件不再是 ASP.NET Core 2 中的常见模式。

Answer 2

为什么不使用 appsettings.json 来存储这些信息，然后使用内置的 DI 将其注入到您的中间件中？

appsettings.json

{
    "MiddlewareConfiguration":
    {
        "MiddlewareValue":42,
    }
}

Startup.cs

public IServiceProvider ConfigureServices(IServiceCollection services)
{
    services.Configure<MiddlewareConfiguration>(configuration.GetSection("MiddlewareConfiguration"));
}

MiddlewareConfiguration.cs

public class MiddlewareConfiguration
{
    public int MiddlewareValue { get; set; }
}

然后您可以将其注入到您的中间件中，例如：

public async Task Invoke(HttpContext context, IOptions<MiddlewareConfiguration> config)