In ASP.NET, how to instantiate a singleton object that uses DI during Startup?

user_6831042 0
Viewed 644

I have a WebApi that needs to add a singleton for DI during Setup. But I need to instantiate it during Startup. All of the example code I've found online shows something like this:

services.AddSingleton(new MyService());

This is great, but what do you do if MyService() takes arguments that are setup in DI? For instance, if my service's constructor is like this:

public MyService(ILogger<MyService> logger, IConfiguration config)

There must be a way to instantiate the object when adding it to the DI services, but I'm at a loss.

I'm using .NET 6.

Thanks

asp.net-core dependency-injection singleton c#
2 Answers

You basically have two options:

  1. Create the object -with its dependencies- before or during the registration process. With ASP.NET Core the typical place to do this is inside the Startup.ConfigureServices method (or before).
  2. Register it normally and resolve it directly after the container was constructed. In ASP.NET Core this typically means inside the Configure method.

In case the object needs to be available before registration (for instance because the registrations depend on the outcome of a method call on that object), it's important to keep that object as slim and with as little dependencies as possible. Such object, for instance, might have more functionality and dependencies than needs to execute at that moment. In that case it's good to split the object into smaller pieces, such that you only have to compose the least amount of dependencies to get the logic executed.

For instance, instead of injecting an IConfiguration, think about injecting just the parts of the configuration that the object requires. Also think about whether you require logging at this point. Especially logging is tricky, because it's tightly coupled into the DI infrastructure, which makes it more difficult to construct such class manually. This could hold for other framework dependencies as well, because most framework dependencies are registered in the built-in configuration system.

For application components, on the other hand, it should typically fairly easy to compose them before hand. You would usually see that the kinds of services you need this early in the process tend to have little dependencies -or- they can be refactored as such.

If that 'startup' service requires a deeper object graph resolving it from the DI container makes the most sense, but again, that requires the DI Container to be built. Only when executing the Configure method (or later) do you have access to the container.

user_2646970

What I would suggest is the have the following call in the startup:

builder.Services.AddSingleton<IMyService, MyService>(); Then the DI will instantiate any objects that are required in the MyService constructor.

Hope this helps.

user_107137980
Related