AspNetCore.Docs/aspnetcore/fundamentals/middleware/extensibility-third-party-c...

7.1 KiB

title author description monikerRange ms.author ms.custom ms.date uid
Middleware activation with a third-party container in ASP.NET Core rick-anderson Learn how to use strongly-typed middleware with factory-based activation and a third-party container in ASP.NET Core. >= aspnetcore-2.1 riande mvc 09/22/2019 fundamentals/middleware/extensibility-third-party-container

Middleware activation with a third-party container in ASP.NET Core

:::moniker range=">= aspnetcore-3.0"

This article demonstrates how to use xref:Microsoft.AspNetCore.Http.IMiddlewareFactory and xref:Microsoft.AspNetCore.Http.IMiddleware as an extensibility point for middleware activation with a third-party container. For introductory information on IMiddlewareFactory and IMiddleware, see xref:fundamentals/middleware/extensibility.

View or download sample code (how to download)

The sample app demonstrates middleware activation by an IMiddlewareFactory implementation, SimpleInjectorMiddlewareFactory. The sample uses the Simple Injector dependency injection (DI) container.

The sample's middleware implementation records the value provided by a query string parameter (key). The middleware uses an injected database context (a scoped service) to record the query string value in an in-memory database.

[!NOTE] The sample app uses Simple Injector purely for demonstration purposes. Use of Simple Injector isn't an endorsement. Middleware activation approaches described in the Simple Injector documentation and GitHub issues are recommended by the maintainers of Simple Injector. For more information, see the Simple Injector documentation and Simple Injector GitHub repository.

IMiddlewareFactory

xref:Microsoft.AspNetCore.Http.IMiddlewareFactory provides methods to create middleware.

In the sample app, a middleware factory is implemented to create a SimpleInjectorActivatedMiddleware instance. The middleware factory uses the Simple Injector container to resolve the middleware:

[!code-csharp]

IMiddleware

xref:Microsoft.AspNetCore.Http.IMiddleware defines middleware for the app's request pipeline.

Middleware activated by an IMiddlewareFactory implementation (Middleware/SimpleInjectorActivatedMiddleware.cs):

[!code-csharp]

An extension is created for the middleware (Middleware/MiddlewareExtensions.cs):

[!code-csharp]

Startup.ConfigureServices must perform several tasks:

  • Set up the Simple Injector container.
  • Register the factory and middleware.
  • Make the app's database context available from the Simple Injector container.

[!code-csharp]

The middleware is registered in the request processing pipeline in Startup.Configure:

[!code-csharp]

:::moniker-end

:::moniker range="< aspnetcore-3.0"

This article demonstrates how to use xref:Microsoft.AspNetCore.Http.IMiddlewareFactory and xref:Microsoft.AspNetCore.Http.IMiddleware as an extensibility point for middleware activation with a third-party container. For introductory information on IMiddlewareFactory and IMiddleware, see xref:fundamentals/middleware/extensibility.

View or download sample code (how to download)

The sample app demonstrates middleware activation by an IMiddlewareFactory implementation, SimpleInjectorMiddlewareFactory. The sample uses the Simple Injector dependency injection (DI) container.

The sample's middleware implementation records the value provided by a query string parameter (key). The middleware uses an injected database context (a scoped service) to record the query string value in an in-memory database.

[!NOTE] The sample app uses Simple Injector purely for demonstration purposes. Use of Simple Injector isn't an endorsement. Middleware activation approaches described in the Simple Injector documentation and GitHub issues are recommended by the maintainers of Simple Injector. For more information, see the Simple Injector documentation and Simple Injector GitHub repository.

IMiddlewareFactory

xref:Microsoft.AspNetCore.Http.IMiddlewareFactory provides methods to create middleware.

In the sample app, a middleware factory is implemented to create a SimpleInjectorActivatedMiddleware instance. The middleware factory uses the Simple Injector container to resolve the middleware:

[!code-csharp]

IMiddleware

xref:Microsoft.AspNetCore.Http.IMiddleware defines middleware for the app's request pipeline.

Middleware activated by an IMiddlewareFactory implementation (Middleware/SimpleInjectorActivatedMiddleware.cs):

[!code-csharp]

An extension is created for the middleware (Middleware/MiddlewareExtensions.cs):

[!code-csharp]

Startup.ConfigureServices must perform several tasks:

  • Set up the Simple Injector container.
  • Register the factory and middleware.
  • Make the app's database context available from the Simple Injector container.

[!code-csharp]

The middleware is registered in the request processing pipeline in Startup.Configure:

[!code-csharp]

:::moniker-end

Additional resources