11 KiB
| title | author | description | ms.author | ms.date | uid |
|---|---|---|---|---|---|
| Dependency injection into views in ASP.NET Core | rick-anderson | Learn how ASP.NET Core supports dependency injection into MVC views. | riande | 10/14/2016 | mvc/views/dependency-injection |
Dependency injection into views in ASP.NET Core
:::moniker range=">= aspnetcore-6.0"
ASP.NET Core supports dependency injection into views. This can be useful for view-specific services, such as localization or data required only for populating view elements. Most of the data views display should be passed in from the controller.
View or download sample code (how to download)
Configuration injection
The values in settings files, such as appsettings.json and appsettings.Development.json, can be injected into a view. Consider the appsettings.Development.json from the sample code:
The following markup displays the configuration value in a Razor Pages view:
The following markup displays the configuration value in a MVC view:
For more information, see xref:fundamentals/configuration/index
Service injection
A service can be injected into a view using the @inject directive.
This view displays a list of ToDoItem instances, along with a summary showing overall statistics. The summary is populated from the injected StatisticsService. This service is registered for dependency injection in ConfigureServices in Program.cs:
The StatisticsService performs some calculations on the set of ToDoItem instances, which it accesses via a repository:
The sample repository uses an in-memory collection. An in-memory implementation shouldn't be used for large, remotely accessed data sets.
The sample displays data from the model bound to the view and the service injected into the view:
Populating Lookup Data
View injection can be useful to populate options in UI elements, such as dropdown lists. Consider a user profile form that includes options for specifying gender, state, and other preferences. Rendering such a form using a standard approach might require the controller or Razor Page to:
- Request data access services for each of the sets of options.
- Populate a model or
ViewBagwith each set of options to be bound.
An alternative approach injects services directly into the view to obtain the options. This minimizes the amount of code required by the controller or razor Page, moving this view element construction logic into the view itself. The controller action or Razor Page to display a profile editing form only needs to pass the form the profile instance:
The HTML form used to update the preferences includes dropdown lists for three of the properties:
These lists are populated by a service that has been injected into the view:
The ProfileOptionsService is a UI-level service designed to provide just the data needed for this form:
Note an unregistered type throws an exception at runtime because the service provider is internally queried via xref:Microsoft.Extensions.DependencyInjection.ServiceProviderServiceExtensions.GetRequiredService%2A.
Overriding Services
In addition to injecting new services, this technique can be used to override previously injected services on a page. The figure below shows all of the fields available on the page used in the first example:
The default fields include Html, Component, and Url. To replace the default HTML Helpers with a custom version, use @inject:
See Also
- Simon Timms Blog: Getting Lookup Data Into Your View
:::moniker-end
:::moniker range="< aspnetcore-6.0"
ASP.NET Core supports dependency injection into views. This can be useful for view-specific services, such as localization or data required only for populating view elements. You should try to maintain separation of concerns between your controllers and views. Most of the data your views display should be passed in from the controller.
View or download sample code (how to download)
Configuration injection
appsettings.json values can be injected directly into a view.
Example of an appsettings.json file:
{
"root": {
"parent": {
"child": "myvalue"
}
}
}
The syntax for @inject:
@inject <type> <name>
An example using @inject:
@using Microsoft.Extensions.Configuration
@inject IConfiguration Configuration
@{
string myValue = Configuration["root:parent:child"];
...
}
Service injection
A service can be injected into a view using the @inject directive. You can think of @inject as adding a property to the view, and populating the property using DI.
This view displays a list of ToDoItem instances, along with a summary showing overall statistics. The summary is populated from the injected StatisticsService. This service is registered for dependency injection in ConfigureServices in Startup.cs:
The StatisticsService performs some calculations on the set of ToDoItem instances, which it accesses via a repository:
The sample repository uses an in-memory collection. The implementation shown above (which operates on all of the data in memory) isn't recommended for large, remotely accessed data sets.
The sample displays data from the model bound to the view and the service injected into the view:
Populating Lookup Data
View injection can be useful to populate options in UI elements, such as dropdown lists. Consider a user profile form that includes options for specifying gender, state, and other preferences. Rendering such a form using a standard MVC approach would require the controller to request data access services for each of these sets of options, and then populate a model or ViewBag with each set of options to be bound.
An alternative approach injects services directly into the view to obtain the options. This minimizes the amount of code required by the controller, moving this view element construction logic into the view itself. The controller action to display a profile editing form only needs to pass the form the profile instance:
The HTML form used to update these preferences includes dropdown lists for three of the properties:
These lists are populated by a service that has been injected into the view:
The ProfileOptionsService is a UI-level service designed to provide just the data needed for this form:
[!IMPORTANT] Don't forget to register types you request through dependency injection in
Startup.ConfigureServices. An unregistered type throws an exception at runtime because the service provider is internally queried via xref:Microsoft.Extensions.DependencyInjection.ServiceProviderServiceExtensions.GetRequiredService%2A.
Overriding Services
In addition to injecting new services, this technique can also be used to override previously injected services on a page. The figure below shows all of the fields available on the page used in the first example:
As you can see, the default fields include Html, Component, and Url (as well as the StatsService that we injected). If for instance you wanted to replace the default HTML Helpers with your own, you could easily do so using @inject:
If you want to extend existing services, you can simply use this technique while inheriting from or wrapping the existing implementation with your own.
See Also
- Simon Timms Blog: Getting Lookup Data Into Your View
:::moniker-end