Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Injecting into constructor with 2 params is not working

I have a ASP .Net Web API controller that I want to take 2 parameters. The first one is an EF context and the second being a caching interface. If I just have the EF context the constructor gets called, but when I add the caching interface I get the error:

An error occurred when trying to create a controller of type 'MyV1Controller'. Make sure that the controller has a parameterless public constructor.

private MyEntities dbContext;
private IAppCache cache;

public MyV1Controller(MyEntities ctx, IAppCache _cache)
{
     dbContext = ctx;
     cache = _cache;
}

My UnityConfig.cs

public static void RegisterTypes(IUnityContainer container)
{
    // TODO: Register your types here
    container.RegisterType<MyEntities, MyEntities>();
    container.RegisterType<IAppCache, CachingService>();
}

I would expect that Entity now knows about both types when a request is made for MyV1Controller function it should be able to instantiate an instance since that constructor takes types it knows about but that's not the case. Any idea why?

[EDIT] Note that I created my own class (IConfig) and registered it and add it to the constructor and it worked, but whenever I try to add the IAppCache to my constructor and make a request to the API I get the error telling me it can't construct my controller class. The only difference that I see is the IAppCache isn't in my projects namespace because it's a 3rd party class but that shouldn't matter from what I understand.

Here are the constructors for CachingService

public CachingService() : this(MemoryCache.Default) { } 

public CachingService(ObjectCache cache) { 
    if (cache == null) throw new ArgumentNullException(nameof(cache)); 
    ObjectCache = cache; 
    DefaultCacheDuration = 60*20; 
}
like image 421
user441521 Avatar asked Nov 21 '16 19:11

user441521


People also ask

Is it difficult to inject dependency by constructor?

Frameworks that apply the Constrained Construction anti-pattern can make using Constructor Injection difficult. The main disadvantage to Constructor Injection is that if the class you're building is called by your current application framework, you might need to customize that framework to support it.

What does the@ inject annotation do?

The @Inject annotation lets us define an injection point that is injected during bean instantiation. Injection can occur via three different mechanisms. A bean can only have one injectable constructor. A bean can have multiple initializer methods.

Why we use dependency injection in c#?

Dependency Injection (DI) is a software design pattern that allows us to develop loosely coupled code. DI is a great way to reduce tight coupling between software components. DI also enables us to better manage future changes and other complexity in our software. The purpose of DI is to make code maintainable.

What is. net dependency injection?

Dependency injection in . NET is a built-in part of the framework, along with configuration, logging, and the options pattern. A dependency is an object that another object depends on. Examine the following MessageWriter class with a Write method that other classes depend on: C# Copy.


2 Answers

Check the IAppCacheimplementation CachingService to make sure that the class is not throwing any exception when initialized. that parameterless exception is the default message when an error occurs while trying to create controllers. It is not a very useful exception as it does not accurately indicate what the true error was that occurred.

You mention that it is a 3rd party interface/class. It could be requesting a dependency that the container does not know about.

Referencing Unity Framework IoC with default constructor

Unity is calling the constructor with the most parameters which in this case is...

public CachingService(ObjectCache cache) { ... }

As the container know nothing about ObjectCache it will pass in null which according to the code in the constructor will throw an exception.

UPDATE:

Adding this from comments as it can prove useful to others.

container.RegisterType<IAppCache, CachingService>(new InjectionConstructor(MemoryCache.Default));

Reference here Register Constructors and Parameters for more details.

like image 99
Nkosi Avatar answered Nov 15 '22 18:11

Nkosi


Most of the DI containers while trying to resolve a type always look for a constructor with maximum number of parameters. That is the reason why CachingService(ObjectCache cache) constructor was being invoked by default. As ObjectCache instance is not registered with Unity, so the resolution fails. Once you force the type registration to invoke specific constructor, everything works.

So if you register IAppCache and force it to invoke CachingService() - parameter less constructor, it will work as expected.

container.RegisterType<IAppCache, CachingService>(new InjectionConstructor());

Registering it this way, will force the parameter less constructor to be invoked and internally it will fall back on whatever the third part library wants to use as default. In your case it will be

CachingService() : this(MemoryCache.Default)

Another option that was mentioned in other answers is to register and pass the constructor parameter your self.

container.RegisterType<IAppCache, CachingService>(new InjectionConstructor(MemoryCache.Default));

This will also work, but here you are taking the responsibility of supplying the cache provider. In my opinion, I would rather let the third party library handle its own defaults instead of me as a consumer taking over that responsibility.

Please take a look at How does Unity.Resolve know which constructor to use?

And few additional information for Niject https://github.com/ninject/ninject/wiki/Injection-Patterns

If no constructors have an [Inject] attribute, Ninject will select the one with the most parameters that Ninject understands how to resolve.

like image 37
Vinod Avatar answered Nov 15 '22 16:11

Vinod