How to use dependency injection in ASP.Net Core
Support for dependency injection is built into ASP.Net Core, Microsoft’s open source, cross platform, lean, and modular framework for building high performance, scalable web applications. In ASP.Net Core, both framework services and application services can be injected into your classes, rather than being tightly coupled. In this article we’ll look at how we can work with dependency injection in ASP.Net Core.
Dependency injection (also known as DI) is a design pattern in which a class or object has its dependent classes injected (passed to it by another class or object) rather than create them directly. Dependency injection facilitates loose coupling and promotes testability and maintenance. Moreover, dependency injection allows you to change your implementations without having to change the classes or interfaces that leverage those implementations.
Making a service available via dependency injection in ASP.Net
We will now build a simple service in Visual Studio using ASP.Net Core and illustrate how we can add it to the dependency injection container, register it with the pipeline, and then consume it in our application. Follow these steps to create a new ASP.Net Core project in Visual Studio 2017 or Visual Studio 2015. If you’re using Visual Studio 2015, make sure you have .Net Core installed.
- Open Visual Studio
- Click File -> New -> Project
- In the New Project Dialog Window, select the “ASP.NET Core Web Application” project template
- Specify the name and location for your project and click OK to save
Now, create the following POCO (plain old CLI object) class. This class contains just one property – it represents all of the topic areas covered by the authors of a particular publishing company.
public class TopicArea
{
public string Name { get; set; }
}
Consider the following interface named ITopicAreaService that represents the contract for the TopicAreaService.
public interface ITopicAreaService
{
IEnumerable<TopicArea> GetAllTopicAreas();
}
The ITopicAreaService interface contains the declaration of one method called GetAllTopicAreas(). The TopicAreaService class implements the ITopicAreaService as shown below.
public class TopicAreaService : ITopicAreaService
{
public IEnumerable<TopicArea> GetAllTopicAreas()
{
return new List<TopicArea>
{
new TopicArea {Name =".NET Core" },
new TopicArea {Name ="Docker" },
new TopicArea { Name ="C#" }
};
}
}
Registering services for dependency injection in ASP.Net
The next step is to register the TopicAreaService with the dependency injection container available as part of ASP.Net Code. To do this, write the following piece of code in the ConfigureServices method in the Startup.cs file. The ConfigureServices method adds services to the services container, which makes them available in your app via dependency injection. It is called by the runtime automatically.
public void ConfigureServices(IServiceCollection services)
{
services.AddTransient<ITopicAreaService, TopicAreaService>();
// Add framework services.
services.AddMvc();
}
If you have multiple services that need to be registered, you can use an extension method as shown below.
public static class ServiceExtensions
{
public static IServiceCollection RegisterServices(
this IServiceCollection services)
{
services.AddTransient<ITopicAreaService, TopicAreaService>();
// Add all other services here.
return services;
}
}
Using the RegisterServices method allows you to keep your ConfigureServices method lean and maintainable. Instead of specifying each service in ConfigureServices, all you need to do is call the RegisterServices extension method once in your ConfigureServices method as shown in the code snippet below.
public void ConfigureServices(IServiceCollection services)
{
services.RegisterServices();
// Add framework services.
services.AddMvc();
}
Dependency injection lifetimes in ASP.Net
The dependency injection lifetime is used to specify when the dependent objects are created and re-created. As far as lifetimes for dependency injection instances in ASP.Net Core applications is concerned, there are three possibilities:
- Singleton: This implies only a single instance will be created and shared by all consumers.
- Scoped: This implies that one instance per scope (i.e., one instance per request to the application) will be created.
- Transient: This implies that the components will not be shared but will be created each time they are requested.
Note that in this example we have used the Transient type. The following code snippet illustrates how you can use the other types of lifetime when registering your service.
services.AddScoped<ISecurityService, SecurityService>();
services.AddSingleton<ICachingService, CachingService>();
Using a service via dependency injection in ASP.Net
Now that the service we implemented has been added to the pipeline, you can use it in any of the controllers in your ASP.Net Core project. The following code snippet illustrates how you can request an instance of the TopicAreaService in your controller.
private readonly ITopicAreaService _topicAreaService;
public DefaultController(ITopicAreaService topicAreaService)
{
_topicAreaService = topicAreaService;
}
Here’s how the GetAllTopicAreas method of the TopicAreaService is called from your controller’s action method.
[HttpGet]
public IEnumerable<TopicArea> GetAllTopicAreas()
{
return _topicAreaService.GetAllTopicAreas();
}
Given below is the complete code listing of the controller class for your reference.
using Microsoft.AspNetCore.Mvc;
using System.Collections.Generic;
namespace IDGASPNETCoreDI.Controllers
{
[Produces(“application/json”)]
[Route(“api/Default”)]
public class DefaultController : Controller
{
private readonly ITopicAreaService _topicAreaService;
public DefaultController(ITopicAreaService topicAreaService)
{
_topicAreaService = topicAreaService;
}
[HttpGet]
public IEnumerable<TopicArea> GetAllTopicAreas()
{
return _topicAreaService.GetAllTopicAreas();
}
}
}
You can leverage the in-built support for dependency injection in ASP.Net Core to build applications that are modular, lean, and clean, easy to maintain and test. The built-in dependency injection provider in ASP.Net Core is not as feature-rich as containers like StructureMap and Ninject, but it is quite fast and, as we’ve seen, easy to configure and use.