AddTransient, AddScoped and AddSingleton Services Differences

Question

I want to implement dependency injection (DI) in ASP.NET Core. So after adding this code to ConfigureServices method, both ways work.

What is the difference between the services.AddTransient and service.AddScoped methods in ASP.NET Core?

public void ConfigureServices(IServiceCollection services)
{
    // Add framework services.

    // Add application services.
    services.AddTransient<IEmailSender, AuthMessageSender>();
    services.AddScoped<IEmailSender, AuthMessageSender>();
}

Answer 1

TL;DR

Transient objects are always different; a new instance is provided to every controller and every service.

Scoped objects are the same within a request, but different across different requests.

Singleton objects are the same for every object and every request.

For more clarification, this example from .NET documentation shows the difference:

To demonstrate the difference between these lifetime and registration options, consider a simple interface that represents one or more tasks as an operation with a unique identifier, OperationId. Depending on how we configure the lifetime for this service, the container will provide either the same or different instances of the service to the requesting class. To make it clear which lifetime is being requested, we will create one type per lifetime option:

using System;

namespace DependencyInjectionSample.Interfaces
{
    public interface IOperation
    {
        Guid OperationId { get; }
    }

    public interface IOperationTransient : IOperation
    {
    }

    public interface IOperationScoped : IOperation
    {
    }

    public interface IOperationSingleton : IOperation
    {
    }

    public interface IOperationSingletonInstance : IOperation
    {
    }
}

We implement these interfaces using a single class, Operation, that accepts a GUID in its constructor, or uses a new GUID if none is provided:

using System;
using DependencyInjectionSample.Interfaces;
namespace DependencyInjectionSample.Classes
{
    public class Operation : IOperationTransient, IOperationScoped, IOperationSingleton, IOperationSingletonInstance
    {
        Guid _guid;
        public Operation() : this(Guid.NewGuid())
        {

        }

        public Operation(Guid guid)
        {
            _guid = guid;
        }

        public Guid OperationId => _guid;
    }
}

Next, in ConfigureServices, each type is added to the container according to its named lifetime:

services.AddTransient<IOperationTransient, Operation>();
services.AddScoped<IOperationScoped, Operation>();
services.AddSingleton<IOperationSingleton, Operation>();
services.AddSingleton<IOperationSingletonInstance>(new Operation(Guid.Empty));
services.AddTransient<OperationService, OperationService>();

Note that the IOperationSingletonInstance service is using a specific instance with a known ID of Guid.Empty, so it will be clear when this type is in use. We have also registered an OperationService that depends on each of the other Operation types, so that it will be clear within a request whether this service is getting the same instance as the controller, or a new one, for each operation type. All this service does is expose its dependencies as properties, so they can be displayed in the view.

using DependencyInjectionSample.Interfaces;

namespace DependencyInjectionSample.Services
{
    public class OperationService
    {
        public IOperationTransient TransientOperation { get; }
        public IOperationScoped ScopedOperation { get; }
        public IOperationSingleton SingletonOperation { get; }
        public IOperationSingletonInstance SingletonInstanceOperation { get; }

        public OperationService(IOperationTransient transientOperation,
            IOperationScoped scopedOperation,
            IOperationSingleton singletonOperation,
            IOperationSingletonInstance instanceOperation)
        {
            TransientOperation = transientOperation;
            ScopedOperation = scopedOperation;
            SingletonOperation = singletonOperation;
            SingletonInstanceOperation = instanceOperation;
        }
    }
}

To demonstrate the object lifetimes within and between separate individual requests to the application, the sample includes an OperationsController that requests each kind of IOperation type as well as an OperationService. The Index action then displays all of the controller’s and service’s OperationId values.

using DependencyInjectionSample.Interfaces;
using DependencyInjectionSample.Services;
using Microsoft.AspNetCore.Mvc;

namespace DependencyInjectionSample.Controllers
{
    public class OperationsController : Controller
    {
        private readonly OperationService _operationService;
        private readonly IOperationTransient _transientOperation;
        private readonly IOperationScoped _scopedOperation;
        private readonly IOperationSingleton _singletonOperation;
        private readonly IOperationSingletonInstance _singletonInstanceOperation;

        public OperationsController(OperationService operationService,
            IOperationTransient transientOperation,
            IOperationScoped scopedOperation,
            IOperationSingleton singletonOperation,
            IOperationSingletonInstance singletonInstanceOperation)
        {
            _operationService = operationService;
            _transientOperation = transientOperation;
            _scopedOperation = scopedOperation;
            _singletonOperation = singletonOperation;
            _singletonInstanceOperation = singletonInstanceOperation;
        }

        public IActionResult Index()
        {
            // ViewBag contains controller-requested services
            ViewBag.Transient = _transientOperation;
            ViewBag.Scoped = _scopedOperation;
            ViewBag.Singleton = _singletonOperation;
            ViewBag.SingletonInstance = _singletonInstanceOperation;

            // Operation service has its own requested services
            ViewBag.Service = _operationService;
            return View();
        }
    }
}

Now two separate requests are made to this controller action:

Observe which of the OperationId values varies within a request, and between requests.

• Transient objects are always different; a new instance is provided to every controller and every service.

• Scoped objects are the same within a request, but different across different requests

• Singleton objects are the same for every object and every request (regardless of whether an instance is provided in ConfigureServices)

Answer 2

In .NET's dependency injection there are three major lifetimes:

Singleton which creates a single instance throughout the application. It creates the instance for the first time and reuses the same object in the all calls.

Scoped lifetime services are created once per request within the scope. It is equivalent to a singleton in the current scope. For example, in MVC it creates one instance for each HTTP request, but it uses the same instance in the other calls within the same web request.

Transient lifetime services are created each time they are requested. This lifetime works best for lightweight, stateless services.

Here you can find and examples to see the difference:

ASP.NET 5 MVC6 Dependency Injection in 6 Steps (web archive link due to dead link)

Your Dependency Injection ready ASP.NET : ASP.NET 5

And this is the link to the official documentation:

Dependency injection in ASP.NET Core

Answer 3

Which one to use

Transient

• since they are created every time they will use more memory & Resources and can have a negative impact on performance
• use this for the lightweight service with little or no state.

Scoped

• better option when you want to maintain state within a request.

Singleton

• memory leaks in these services will build up over time.
• also memory efficient as they are created once reused everywhere.

Use Singletons where you need to maintain application wide state. Application configuration or parameters, Logging Service, caching of data is some of the examples where you can use singletons.

Injecting service with different lifetimes into another

1. Never inject Scoped & Transient services into Singleton service. ( This effectively converts the transient or scoped service into the singleton.)

2. Never inject Transient services into scoped service ( This converts the transient service into the scoped.)

Note: I think it's fair to say that the above advice is seriously disputed. Many developers think it's fine to inject, for example, a transient into a singleton.

Answer 4

This image illustrates this concept well. Unfortunately, I could not find the source of this image, but someone made it, he has shown this concept very well in the form of an image.

Update: Image reference : ASP.NET Core Service Lifetimes (Infographic) , Author: @WaqasAnwar

Answer 5

Transient, scoped and singleton define object creation process in ASP.NET MVC core DI(Dependency Injection) when multiple objects of the same type have to be injected. In case you are new to dependency injection you can see this DI IoC video.

You can see the below controller code in which I have requested two instances of "IDal" in the constructor. Transient, Scoped and Singleton define if the same instance will be injected in "_dal" and "_dal1" or different.

public class CustomerController : Controller
{
    IDal dal = null;

    public CustomerController(IDal _dal,
                              IDal _dal1)
    {
        dal = _dal;
        // DI of MVC core
        // inversion of control
    }
}

Transient: In transient, new object instances will be injected in a single request and response. Below is a snapshot image where I displayed GUID values.

Scoped: In scoped, the same object instance will be injected in a single request and response.

Singleton: In singleton, the same object will be injected across all requests and responses. In this case one global instance of the object will be created.

Below is a simple diagram which explains the above fundamental visually.

The above image was drawn by the SBSS team when I was taking ASP.NET MVC training in Mumbai. A big thanks goes to the SBSS team for creating the above image.

Answer 6

AddSingleton()

AddSingleton() creates a single instance of the service when it is first requested and reuses that same instance in all the places where that service is needed.

AddScoped()

In a scoped service, with every HTTP request, we get a new instance. However, within the same HTTP request, if the service is required in multiple places, like in the view and in the controller, then the same instance is provided for the entire scope of that HTTP request. But every new HTTP request will get a new instance of the service.

AddTransient()

With a transient service, a new instance is provided every time a service instance is requested whether it is in the scope of the same HTTP request or across different HTTP requests.

Answer 7

• Singleton is a single instance for the lifetime of the application domain.
• Scoped is a single instance for the duration of the scoped request, which means per HTTP request in ASP.NET.
• Transient is a single instance per code request.

Normally the code request should be made through a constructor parameter, as in

public MyConsumingClass(IDependency dependency)

I wanted to point out in @akazemis's answer that "services" in the context of DI does not imply RESTful services; services are implementations of dependencies that provide functionality.

Answer 8

After looking for an answer for this question I found a brilliant explanation with an example that I would like to share with you.

You can watch a video that demonstrate the differences HERE

In this example we have this given code:

public interface IEmployeeRepository
{
    IEnumerable<Employee> GetAllEmployees();
    Employee Add(Employee employee);
}

public class Employee
{
    public int Id { get; set; }
    public string Name { get; set; }
}

public class MockEmployeeRepository : IEmployeeRepository
{
    private List<Employee> _employeeList;

    public MockEmployeeRepository()
    {
        _employeeList = new List<Employee>()
    {
        new Employee() { Id = 1, Name = "Mary" },
        new Employee() { Id = 2, Name = "John" },
        new Employee() { Id = 3, Name = "Sam" },
    };
    }

    public Employee Add(Employee employee)
    {
        employee.Id = _employeeList.Max(e => e.Id) + 1;
        _employeeList.Add(employee);
        return employee;
    }

    public IEnumerable<Employee> GetAllEmployees()
    {
        return _employeeList;
    }
}

HomeController

public class HomeController : Controller
{
    private IEmployeeRepository _employeeRepository;

    public HomeController(IEmployeeRepository employeeRepository)
    {
        _employeeRepository = employeeRepository;
    }

    [HttpGet]
    public ViewResult Create()
    {
        return View();
    }

    [HttpPost]
    public IActionResult Create(Employee employee)
    {
        if (ModelState.IsValid)
        {
            Employee newEmployee = _employeeRepository.Add(employee);
        }

        return View();
    }
}

Create View

@model Employee
@inject IEmployeeRepository empRepository

<form asp-controller="home" asp-action="create" method="post">
    <div>
        <label asp-for="Name"></label>
        <div>
            <input asp-for="Name">
        </div>
    </div>

    <div>
        <button type="submit">Create</button>
    </div>

    <div>
        Total Employees Count = @empRepository.GetAllEmployees().Count().ToString()
    </div>
</form>

Startup.cs

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc();
    services.AddSingleton<IEmployeeRepository, MockEmployeeRepository>();
}

Copy-paste this code and press on the create button in the view and switch between AddSingleton , AddScoped and AddTransient you will get each time a different result that will might help you understand this.

AddSingleton() - As the name implies, AddSingleton() method creates a Singleton service. A Singleton service is created when it is first requested. This same instance is then used by all the subsequent requests. So in general, a Singleton service is created only one time per application and that single instance is used throughout the application life time.

AddTransient() - This method creates a Transient service. A new instance of a Transient service is created each time it is requested.

AddScoped() - This method creates a Scoped service. A new instance of a Scoped service is created once per request within the scope. For example, in a web application it creates 1 instance per each http request but uses the same instance in the other calls within that same web request.

Answer 9

DI containers can be pretty mystifying at first, especially with regard to lifetimes. After all, containers use reflection to make everything "just work." It helps to think about what containers are actually accomplishing for you under the hood: composing object graphs.

For a .NET web app, the alternative to using a DI container is to replace the default controller activator with your own, which must manage lifetimes and construct dependency graphs manually. For learning purposes, pretend you have a controller activator that is hard-coded to return one particular controller each time there is a web request:

// This class is created once per application during startup.  In DI terms, it is the
// "composition root."
public class DumbControllerActivator
{
    // Shared among all consumers from all requests
    private static readonly Singleton1 singleton1 = new Singleton1();
    private static readonly Singleton2 singleton2 = new Singleton2();

    // This method's responsibility is to construct a FooController and its dependecies.
    public FooController HandleFooRequest()
    {
        // Shared among all consumers in this request
        var scoped1 = new Scoped1();
        var scoped2 = new Scoped2(singleton1, scoped1);

        return new FooController(
            singleton1,
            scoped1,
            new Transient1(                     // Fresh instance
                singleton2,
                new Transient2(scoped2)),       // Fresh instance
            new Transient3(                     // Fresh instance
                singleton1,
                scoped1,
                new Transient1(                 // Fresh instance
                    singleton2,
                    new Transient2(scoped2)));  // Fresh instance
    }
}

• The activator creates each singleton instance only once and then holds onto it throughout the lifetime of the application. Each consumer shares that single instance (even consumers from separate requests).
• For scoped dependencies, the activator creates one instance per web request. Within that request, every consumer shares that single instance, but from request to request, the instances are different.
• For transient dependencies, each consumer gets its own private instance. There is no sharing at all.

For a much deeper dive into DI, I highly recommend the book Dependency Injection Principles, Practices, and Patterns. My answer is basically just repeating what I learned there.

Answer 10

I like to draw what I understand.

Answer 11

Adding to all the fantastic answers here. This answer will explain the different lifetime and when it is appropriate to choose them.As with many things in software development, there are no absolutes and many condition can affect the best choices, so please treat this answer as a general guidance.

ASP.NET Core ships with its own built-in Dependency Injection Container which it uses to resolve the services it needs during the request lifecycle. All framework services, for example, like Logging, configuration, Routing etc.., use dependency injection and they are registered with the Dependency Injection Container when the application host is built. Internally, the ASP.NET Core framework provides the dependencies required when activating framework components, such as Controllers and Razor pages.

A Dependency Injection Container, sometimes referred to as an Inversion of Control, or IoC Container, is a software component that manages the instantiation and configuration of objects. The dependency Injection Container is not a requirement to apply the dependency injection pattern, but as your application grows using one can greatly simply the management of dependencies, including their lifetimes. Services are registered with the container at start up and resolved from the container at runtime whenever they are required. The container is responsible for creating and disposing of instances of required services, maintaining them for a specified lifetime.

There are two primary interfaces that we code against when using the Microsoft Dependency Injection Container.

1. The IServiceCollection interface defines a contract for registering and configuring a collection of service descriptors. From the IServiceCollection we build an IServiceProvider.
2. IServiceProvider, defines a mechanism for resolving a service at runtime.

When registering a service with the container, a service lifetime should be chosen for the service. The service lifetime controls how long a resolved object will live for after the container has created it. The lifetime can be defined by using the appropriate extension method on the IServiceCollection when registering the service. There are three lifetimes available for use with the Microsoft Dependency Injection Container.

1. Transient
2. Singleton
3. Scoped

The Dependency Injection Container keeps track of all the instances of services it creates, and they are disposed of or released for garbage collection once their lifetime has ended. The chosen lifetime affects whether the same service instance may be resolved and injected into more than one dependent consumer. It is crucial, therefore, to choose the lifetime of services very wisely.

Transient Services

When a service is registered as Transient, a new instance of that service is created and returned by the container every time the service is resolved. In other words, every dependent class that accepts a Transient service via injection from the container will receive its own unique instance. Because each dependent class receives its own instance, methods on the instance are safe to mutate internal state without fear of access by other consumers and threads.

Uses/ Characteristics of Transient Services

1. Transient service is most useful when the service contains mutable state and is not considered thread safe.
2. Using Transient services can come with a small performance cost, although that cost may be negligible for applications under general load.
3. Whenever an instance is resolved, which could be as often as every request, memory for that instance must be allocated. This leads to additional work for the garbage collector in order to clean up those short lived objects.
4. Transient service are easiest to reason about because instances are never shared; therefore they tend to be safest choice when it is unclear which lifetime is going to be the best option when you register a service.

Singleton Services

An application service registered with the singleton lifetime will be created only once during the lifetime of the Dependency Injection Container. In ASP.NET Core, this is equivalent to the lifetime of the while we application. The first time the service is required, the container will create an instance. After that, the same instance can be reused and injected into all dependent classes. The instance will remain reachable for the lifetime of the container, so it does not require disposal or garbage collection.

Uses/ Characteristics of Singleton Service

1. Suppose the service is required frequently, such as per request. This can improve application performance by avoiding repeated allocation of new objects, each of which may require garbage collection only moments later.
2. Additionally, if the object is expensive to construct, limiting this to a single instance can improve your application performance, as it only takes place one time when the service is first used.
3. When choosing to register a service with Singleton lifetime, you must consider thread safety. Because the same instance of a Singleton service can be used by multiple requests concurrently. Any mutable state without suitable locking mechanism could lead to unexpected behaviour.
4. Singleton are very well suited to functional-style services, where the methods take an input and return an output, with no shared state being used.
5. A reasonable use case for Singleton lifetime in ASP.NET Core is for the memory cache, where the state must be shared for the cache to function.
6. When registering services for Singleton, consider the implications of a single instance remaining allocated for the life of the application. a. It is possible to create memory leaks is the instance holds large amount of memory b. This can be especially problematic if memory usage can grow during the instance’s lifetime, given that it will never be released for garbage collection. c. If a service has high memory requirements but is used very infrequently, then the singleton lifetime may not be the most appropriate choice.

Scoped Services

Scoped services sit in a middle ground between Transient and Singleton. An Instance of the scoped service lives for the length of the scope from which it is resolved. InASP.NET Core, a scope is created within your application for each request it handles. Any scope services will be created once per scope, so that they act similarly to singleton services, but within the context of the scope. All framework components such as middleware and MVC controllers get the same instance of a scoped service when handling a particular request.

Uses/ Characteristics of Scoped Services

1. The container creates a new instance per request.
2. Because the container resolves a new instance of the type per request, it is not generally required to be thread safe.
3. Components within the request life cycle are invoked in sequence, so the shared instance is not used concurrently.
4. Scoped services are useful if multiple consumers may require the same dependency during a request. a. An excellent example of such a case is when using Entity Framework Core. By default, the DbContext is registered with the scoped lifetime. Change tracking, therefore, applies across the entire request. Multiple components can make changes to the shared DbContext.

Avoiding Captive Dependencies

When registering your dependencies, it is crucial to ensure that the chosen lifetime is appropriate considering any dependencies that the service has of its own. This is necessary to avoid something called captive dependencies, which is where a service may live longer than is intended.

The thumb rule is, a service should not depend on a service with a lifetime shorter than its own. For example, a service registered with the singleton lifetime should not depend on a transient service. Doing so would result in the transient service being captured by the singleton service, with the instance unintentionally being referenced for the life of the application. This can lead to problematic and sometime hard to track down runtime bugs and behaviours, such as accidentally sharing non-thread safe services between threads or allowing objects to live past their intended lifetime. To visualize this, let us consider which lifetimes can safely depend on services using another lifetime.

1. Since it will be a short-lived service, a transient service can safely depend on service that have transient, scoped or singleton lifetime
2. Scope services are little tricky. If they depend on a transient service, then a single instance of that transient service will live for the life of the scope across the whole request. You may or may not want this behaviour. To be absolutely safe, you might choose not to depend on transient services from scoped services, but it is safe for a scoped service to depend on other scoped or singleton services.
3. A singleton service is most restrictive in terms of its dependencies, and it should not depend on transient or scoped services, but can depend upon other singleton services. Capture of scope services by singletons is one of the more dangerous possibilities. Because scoped services could be disposed of then the scope ends, It is possible that the singleton may try and access them after their disposal. This could lead to runtime exceptions in production, a really bad situation.

Answer 12

Probably the best illustration of the lifetime comes into play with the EntityFramework/Core via DbContext.

It is recommended that DbContext and repositories that interact with DbContext should be wired up with a Scoped lifetime because a DbContext is obviously a stateful construct. So you'd not want to use a Singleton because you'd end up with all kinds of concurrency issues. You'd not want to use Transient because DbContext is not thread safe. Remember, Transient is for use cases where you're dealing with stateless objects/classes.

And since most repositories are called by controllers, it really makes sense to use a Scoped lifetime. It's conceivable that a DbContext could be invoked multiple times during a single action method as part of a transation.

This article doesn't speak directly about these lifetimes but gives a great explanation for why a Scoped lifetime is most appropriate for DbContext.

https://mehdi.me/ambient-dbcontext-in-ef6/?msclkid=00251b05d01411ec8d85d232374f26d5