There is surprisingly little information out there in cyberspace on how IoC containers should fit into application architectures.
In parallel with my MEF/Ruby series, I’m going to discuss some of the principles that I believe should be applied to “container-managed” application design.
The Enigmatic Ideal
In the world of systems built using dependency injection, you hear plenty of mysterious statements like:
“Except for when bootstrapping, don’t access the container directly!”
This kind of thing caused me to scratch my head for the best part of a year before I finally caught on to what was meant.
Basic Mental Models
When confronted with the task of designing an application around an IoC container, the place that the container sits in that architecture usually seems to be influenced by the designer’s mental model of what, exactly, an IoC container is.
Model 1: a Dictionary of Services
The dictionary or associative array is one of the first constructs we learn about in software engineering. It is easy to see the analogy between a dictionary and an IoC container that composes objects using dependency injection:
All that appears to differ is:
- Some fancy new terms ‘register’ and ‘resolve’ are used, instead of indexer access
- The logger is created via reflection, saving some typing and configuration code in the case of inter-dependencies
If you come onto a project with established usage of a dependency injection container and had to figure out how to write the code you need to interact with the rest of the system, chances are this is the first mental model you’ll apply.
Model 2: an Abstract new() Operator
Dependency injection containers are often praised for eliminating implementation type dependencies. Going back to our example, we’ve made our request for an ILogger independent of the implementation type that provides it (ConsoleLogger in this case.)
Web frameworks like Monorail and ASP.NET MVC use our dependency injection container to create Controller instances in a similar way.
Perhaps it makes more sense to think of the container as an abstract new() operator?
Here our container usage has not only abstracted away the concrete type of our MailTransport but also taken care of configuring its Host property. (Configuration must be a feature of our abstract new() operator since the configuration parameters on an instance depend on its concrete type rather than the service it provides.)
Design Outcome: the Global Container
Following either of these mental models encourages you to think about the container as something you retrieve things from. Even the name ‘container’ pushes us in this direction.
From this perspective, there isn’t much of a challenge in the application architecture design assignment!
We’ll just create a static property Container on a class, say, Global and get instances from it using Global.Container.Resolve<MyService>().
This snippet should be familiar as a pattern with another name: the static Service Locator.
Problems with the Global Container as a Service Locator
There are good reasons why this pattern can rightly be called an anti-pattern:
Fragility. The container acts like a bucket of global variables. All of the robustness that is achieved by forcing components to publicly declare dependencies is lost. Unexpected dependencies can appear between seemingly unrelated parts of an application, complicating maintenance.
Reduced Composability. When dependencies are injected, the container can be configured to provide different implementations to different consumers. This is often necessary when combining components that were built independently. When dependencies are retrieved from a global container, the container does not know the identity of the requestor, and is forced to return the same implementation every time.
Limited Reuse. Where the global container resides can limit the reusability of components that depend on it. Migrating components to a WPF application will require code changes if they depend on the global container attached to the HttpApplication class.
Implementation Issues. Concurrency, re-entrancy, circular reference detection, and component lifetime management are much harder/messier in a global container based solution.
Resumption of Control: Generally speaking, these issues arise because calling directly into a global container is a resumption of control. In a container-managed application, the container is given the responsibility of getting the right instances into the right places in order for work to be done. Calling into a global container takes over some of this responsibility in a much less manageable way.
Sometimes, because of the design decisions made in many current-generation frameworks, the Global Container is a necessity, but in order to advance the state of software engineering we need to look beyond this.
Thinking Inside the Box
The mental models listed earlier should have rung some alarm bells:
The container is a dictionary of services? Hang on! If I ask for the same service twice, why do I sometimes get different instances?
Good question. It is easy to configure a dependency injection container to return a new instance of the ConsoleLogger each time one is resolved. Not very dictionary-like, is it?
So the container is really an abstract new operator? Wait! If I sometimes get the same shared instance back, when can I Dispose() it?
These two models aren’t even compatible. Sometimes the container hands out new instances, but sometimes what comes back from a call to resolve is a singleton, or an instance that will be shared within some kind of context like the current transaction.
So things are now confusing: who owns these instances, and where do they ‘live’?
Revised Mental Model: An Interconnected System of Objects
Here’s the problem: look at the example on the Autofac homepage. It shows how Register() and Resolve() are used in Autofac. This is a pretty common kind of introductory example to dependency injection. Notice what’s missing?
The most important classes in this example are not ContainerBuilder or Container. From an application architecture perspective, we need to see the Straight6TwinTurbo and Car classes!
The resolve operation is just a way of finding an entry point into a self-contained system.
The entire application resides within the container. There is no ‘outside’ except for whatever entry point gets the ball rolling. An understanding of IoC from this perspective does not revolve around its external APIs like Register() and Resolve().
Using this model, the container to gets component instances to the right place at the right time, and application design re-focuses on the implementation of the components themselves.
Design Outcome: Injected Context
This new perspective on the world leaves us with a challenge when implementing our revised IControllerProvider. This service needs to return (potentially) new, parameterised instances of the Controller type.
The solution, commonly implemented in applications today, is to allow the container to provide context to our controller provider:
We assume here that ControllerProvider is itself hosted within the container. IContext is an interface that Autofac automatically provides to any components that require it. You can create and use an equivalent interface in any other popular IoC container (there’s a MEF example linked from below.)
IContext provides the instance resolution features of the container to the application, but in a controlled manner. The object implementing IContext provides the container’s services, but may not be the container itself.
Because this pattern gives the container or application developer an opportunity to customise or proxy the IContext implementation handed out to any particular component, most of the problems associated with a Global Container are mitigated.
Container-Managed Application Design
If you feel like this article and its explanations are somewhat incomplete, you’re right. As the title of this post suggests, it is an introduction to a series on the topic. I don’t have all the answers, and I don’t even have all the questions, so the installments may come in fits and starts. Nevertheless, if you’re out to design robust architectures that make use of an component-based composition technology there should be something of interest for you.
I hope this article has whet your appetite!
The sample code, based on MEF preview 3, is very, very rough, and is really only worth consulting if you need to step through some running code in order to clarify the concepts in this article.