Skip to main content

MVVM anti-pattern: Injecting the IoC container into a View Model

This is another anti-pattern I've seen a lot recently, the dynamic use of the IoC container inside a view model to resolve child view models & services - service locator pattern:
The service locator pattern has been around for a while - Fowler was writing about this back in 2004!

It's not a pattern that is specific to MVVM, it's a pattern associated with using DI & IoC, if you're doing MVVM you should be using DI & IoC. A lot has also be written about this being an anti-pattern and I agree completely with Mark Seaman on the topic.

For me why this is an anti-pattern for MVVM is for the following reasons:
    Breaks SOLID principles - the view model now has multiple responsibilities and not all dependencies are being explicitly injected. The view model is now responsible for the lifetime of anything it has resolved (this includes scope as well),

    Encourages view models to become god-like objects - they become bloated - all the implementation in a single view model, it's no better than a testable code-behind file,

    Makes unit testing brittle  - when having to test such a view model you have either look through the whole class to see all the dependancies you need to mock or just try a 'hit & hope' approach and keep running and refeactoring the test until it passes. Either way you end up with a lot of test setup which is a smell in it's own right and importantly greatly discourages a developer to write tests,

    And generally destroys the structure and ethos of the MVC (MVVM) pattern - if I can resolve anything anywhere eventually you'll end up with spaghetti code which has no discernable architecture and for me this is probably the most important point when dealing with a large XAML application. 

    What's also interesting about the above example is the fact it actually mixes normal DI with service locator, injecting both other interfaces as well as the IContainer interface - neither one nor the other. The example wasn't contrived to do this it was taken from a real world example - with names changed to protect the innocent. 

    There are times when I believe using the service locator pattern is justified, but these are few and far between. An obvious one is when the creation of a class is costly in time or memory (if this was ever the scenario for me with a view model it would be a code smell and need to be refactored out).

    But if I had to use a service locator I would be either injecting a strongly typed factory or by injecting a Func<T> - all IoC containers support this feature. A couple of examples are shown below:

    Comments

    Popular posts from this blog

    WPF tips & tricks: Dispatcher thread performance

    Not blogged for an age, and I received an email last week which provoked me back to life. It was a job spec for a WPF contract where they want help sorting out the performance of their app especially around grids and tabular data. I thought I'd shared some tips & tricks I've picked up along the way, these aren't probably going to solve any issues you might be having directly, but they might point you in the right direction when trying to find and resolve performance issues with a WPF app. First off, performance is something you shouldn't try and improve without evidence, and this means having evidence proving you've improved the performance - before & after metrics for example. Without this you're basically pissing into the wind, which can be fun from a developer point of view but bad for a project :) So, what do I mean by ' Dispatcher thread performance '? The 'dispatcher thread' or the 'UI thread' is probably the most

    Showing a message box from a ViewModel in MVVM

    I was doing a code review with a client last week for a WPF app using MVVM and they asked ' How can I show a message from the ViewModel? '. What follows is how I would (and have) solved the problem in the past. When I hear the words ' show a message... ' I instantly think you mean show a transient modal message box that requires the user input before continuing ' with something else ' - once the user has interacted with the message box it will disappear. The following solution only applies to this scenario. The first solution is the easiest but is very wrong from a separation perspective. It violates the ideas behind the Model-View-Controller pattern because it places View concerns inside the ViewModel - the ViewModel now knows about the type of the View and specifically it knows how to show a message box window: The second approach addresses this concern by introducing the idea of messaging\events between the ViewModel and the View. In the example below

    Implementing a busy indicator using a visual overlay in MVVM

    This is a technique we use at work to lock the UI whilst some long running process is happening - preventing the user clicking on stuff whilst it's retrieving or rendering data. Now we could have done this by launching a child dialog window but that feels rather out of date and clumsy, we wanted a more modern pattern similar to the way <div> overlays are done on the web. Imagine we have the following simple WPF app and when 'Click' is pressed a busy waiting overlay is shown for the duration entered into the text box. What I'm interested in here is not the actual UI element of the busy indicator but how I go about getting this to show & hide from when using MVVM. The actual UI elements are the standard Busy Indicator coming from the WPF Toolkit : The XAML behind this window is very simple, the important part is the ViewHost. As you can see the ViewHost uses a ContentPresenter element which is bound to the view model, IMainViewModel, it contains 3 child v