11 KiB
| title | author | description | monikerRange | ms.author | ms.custom | ms.date | uid |
|---|---|---|---|---|---|---|---|
| App startup in ASP.NET Core | tdykstra | Learn how the Startup class in ASP.NET Core configures services and the app's request pipeline. | >= aspnetcore-2.1 | tdykstra | mvc | 01/17/2019 | fundamentals/startup |
App startup in ASP.NET Core
By Tom Dykstra, Luke Latham, and Steve Smith
The Startup class configures services and the app's request pipeline.
The Startup class
ASP.NET Core apps use a Startup class, which is named Startup by convention. The Startup class:
- Optionally includes a xref:Microsoft.AspNetCore.Hosting.StartupBase.ConfigureServices* method to configure the app's services. A service is a reusable component that provides app functionality. Services are configured—also described as registered—in
ConfigureServicesand consumed across the app via dependency injection (DI) or xref:Microsoft.AspNetCore.Builder.IApplicationBuilder.ApplicationServices*. - Includes a xref:Microsoft.AspNetCore.Hosting.StartupBase.Configure* method to create the app's request processing pipeline.
ConfigureServices and Configure are called by the runtime when the app starts:
The Startup class is specified to the app when the app's host is built. The app's host is built when Build is called on the host builder in the Program class. The Startup class is usually specified by calling the WebHostBuilderExtensions.UseStartup<TStartup> method on the host builder:
The host provides services that are available to the Startup class constructor. The app adds additional services via ConfigureServices. Both the host and app services are then available in Configure and throughout the app.
A common use of dependency injection into the Startup class is to inject:
- xref:Microsoft.AspNetCore.Hosting.IHostingEnvironment to configure services by environment.
- xref:Microsoft.Extensions.Configuration.IConfiguration to read configuration.
- xref:Microsoft.Extensions.Logging.ILoggerFactory to create a logger in
Startup.ConfigureServices.
An alternative to injecting IHostingEnvironment is to use a conventions-based approach. When the app defines separate Startup classes for different environments (for example, StartupDevelopment), the appropriate Startup class is selected at runtime. The class whose name suffix matches the current environment is prioritized. If the app is run in the Development environment and includes both a Startup class and a StartupDevelopment class, the StartupDevelopment class is used. For more information, see Use multiple environments.
To learn more about the host, see The host. For information on handling errors during startup, see Startup exception handling.
The ConfigureServices method
The xref:Microsoft.AspNetCore.Hosting.StartupBase.ConfigureServices* method is:
- Optional.
- Called by the host before the
Configuremethod to configure the app's services. - Where configuration options are set by convention.
The typical pattern is to call all the Add{Service} methods and then call all of the services.Configure{Service} methods. For example, see Configure Identity services.
The host may configure some services before Startup methods are called. For more information, see The host.
For features that require substantial setup, there are Add{Service} extension methods on xref:Microsoft.Extensions.DependencyInjection.IServiceCollection. A typical ASP.NET Core app registers services for Entity Framework, Identity, and MVC:
Adding services to the service container makes them available within the app and in the Configure method. The services are resolved via dependency injection or from xref:Microsoft.AspNetCore.Builder.IApplicationBuilder.ApplicationServices*.
The Configure method
The xref:Microsoft.AspNetCore.Hosting.StartupBase.Configure* method is used to specify how the app responds to HTTP requests. The request pipeline is configured by adding middleware components to an xref:Microsoft.AspNetCore.Builder.IApplicationBuilder instance. IApplicationBuilder is available to the Configure method, but it isn't registered in the service container. Hosting creates an IApplicationBuilder and passes it directly to Configure.
The ASP.NET Core templates configure the pipeline with support for:
- Developer Exception Page
- Exception handler
- HTTP Strict Transport Security (HSTS)
- HTTPS redirection
- Static files
- General Data Protection Regulation (GDPR)
- ASP.NET Core MVC and Razor Pages
Each Use extension method adds one or more middleware components to the request pipeline. For instance, the UseMvc extension method adds Routing Middleware to the request pipeline and configures MVC as the default handler.
Each middleware component in the request pipeline is responsible for invoking the next component in the pipeline or short-circuiting the chain, if appropriate. If short-circuiting doesn't occur along the middleware chain, each middleware has a second chance to process the request before it's sent to the client.
Additional services, such as IHostingEnvironment and ILoggerFactory, may also be specified in the Configure method signature. When specified, additional services are injected if they're available.
For more information on how to use IApplicationBuilder and the order of middleware processing, see xref:fundamentals/middleware/index.
Convenience methods
To configure services and the request processing pipeline without using a Startup class, call ConfigureServices and Configure convenience methods on the host builder. Multiple calls to ConfigureServices append to one another. If multiple Configure method calls exist, the last Configure call is used.
Extend Startup with startup filters
Use xref:Microsoft.AspNetCore.Hosting.IStartupFilter to configure middleware at the beginning or end of an app's Configure middleware pipeline. IStartupFilter is useful to ensure that a middleware runs before or after middleware added by libraries at the start or end of the app's request processing pipeline.
IStartupFilter implements a single method, xref:Microsoft.AspNetCore.Hosting.StartupBase.Configure*, which receives and returns an Action<IApplicationBuilder>. An xref:Microsoft.AspNetCore.Builder.IApplicationBuilder defines a class to configure an app's request pipeline. For more information, see Create a middleware pipeline with IApplicationBuilder.
Each IStartupFilter implements one or more middlewares in the request pipeline. The filters are invoked in the order they were added to the service container. Filters may add middleware before or after passing control to the next filter, thus they append to the beginning or end of the app pipeline.
The following example demonstrates how to register a middleware with IStartupFilter.
The RequestSetOptionsMiddleware middleware sets an options value from a query string parameter:
The RequestSetOptionsMiddleware is configured in the RequestSetOptionsStartupFilter class:
The IStartupFilter is registered in the service container in xref:Microsoft.AspNetCore.Hosting.StartupBase.ConfigureServices* and augments Startup from outside of the Startup class:
When a query string parameter for option is provided, the middleware processes the value assignment before the MVC middleware renders the response:
Middleware execution order is set by the order of IStartupFilter registrations:
- Multiple
IStartupFilterimplementations may interact with the same objects. If ordering is important, order theirIStartupFilterservice registrations to match the order that their middlewares should run. - Libraries may add middleware with one or more
IStartupFilterimplementations that run before or after other app middleware registered withIStartupFilter. To invoke anIStartupFiltermiddleware before a middleware added by a library'sIStartupFilter, position the service registration before the library is added to the service container. To invoke it afterward, position the service registration after the library is added.
Add configuration at startup from an external assembly
An xref:Microsoft.AspNetCore.Hosting.IHostingStartup implementation allows adding enhancements to an app at startup from an external assembly outside of the app's Startup class. For more information, see xref:fundamentals/configuration/platform-specific-configuration.