Skip to main content

Simple factory, Dependency Injection and Unity

Someone asked me the question whether a simple factory can be implemented using dependency injection container. The example he bought up is where a simple factory takes in a string and switches this string to return the correct instance of the object needed....I am talking about something like this.

internal IWaterMarkProvider GetProvider(string fileExtension)

{

IWaterMarkProvider provider = null;

switch (fileExtension.ToLower())

{

case "pdf":

provider = new PDFProvider();

break;

case ".docx":

provider = new WordProvider();

break;

case "pptx":

provider = new PPTProvider();

break;

case "xlsx":

provider = new ExcelProvider();

break;

}

return provider;

}

The answer was yes..So, if you are using Microsoft Unity (a dependency injection container), you would have your configuration file like this...

<configuration>

<configSections>

<section name="unity" type="Microsoft.Practices.Unity.Configuration.UnityConfigurationSection, Microsoft.Practices.Unity.Configuration"/>

configSections>

<unity xmlns="http://schemas.microsoft.com/practices/2010/unity">

<container name="providerContainer">

<register type="TestLibrary.IWaterMarkProvider,TestLibrary" name="docx" mapTo="TestLibrary.WordProvider,TestLibrary" />

<register type="TestLibrary.IWaterMarkProvider,TestLibrary" name="pdf" mapTo="TestLibrary.PDFProvider,TestLibrary" />

<register type="TestLibrary.IWaterMarkProvider,TestLibrary" name="pptx" mapTo="TestLibrary.PPTProvider,TestLibrary" />

<register type="TestLibrary.IWaterMarkProvider,TestLibrary" name="xlsx" mapTo="TestLibrary.ExcelProvider,TestLibrary" />

<container>

<unity>

<configuration>

We are basically configuring a Unity container and configuring "named" registrations for the IWaterMarkProvider interface. So for an example, the named registration "docx" is mapped to the WordProvider. Hence when we resolve an instance for the IWaterMarkProvider passing the file extension "docx", the Unity container will create an instance of the WordProvider class.
The code below shows how to do this....

IUnityContainer container = new UnityContainer().LoadConfiguration("providerContainer");

IWaterMarkProvider provider = container.Resolve<IWaterMarkProvider>(fileType);

provider.WaterMark();


Note that "providerContainer" is the name of the container specified in the configuration file.
The "fileType" is a parameter that holds the type of the file e.g. "docx"
Whats the advantage of this approach to the approach that we initial put forward, that is with the simple factory we implemened in the first code listing?
First, the code for creation of these classes are "outsourced" and responbility of the container
Secondly, the providers can be changed without recompiling the source, this is even true when we add a new file type. We can just configure it on the configuration file.
Thirdly, If these providers depend on other types, the container will take care of injecting these types into the provider.
Another advantage (unreleated to this example) of using Unity, is that it promotes loose coupling. This becomes really easy when mocking while unit testing. As you can just point Unity to your mocks rather then the real dependencies.

Also note that the lifetime of the instances created through the container can be controlled. By default, each call to the container will create a new instance, if you want to have the WordProvider be a singleton, you can do this...

<register type="TestLibrary.IWaterMarkProvider,TestLibrary" name="docx" mapTo="TestLibrary.WordProvider,TestLibrary" >

<lifetime type="singleton"/>

register>

Comments

Popular posts from this blog

Hosting WCF services on IIS or Windows Services?

There came one of those questions from the client whether to use II7 hosting or windows service hosting for WCF services. I tried recollecting a few points and thought of writing it down. WCF applications can be hosted in 2 main ways - In a Windows service - On IIS 7 and above When WCF was first released, IIS 6 did not support hosting WCF applications that support Non-HTTP communication like Net.TCP or Net.MSMQ and developers had to rely on hosting these services on Windows Services. With the release of IIS 7, it was possible to deploy these Non-Http based applications also on IIS 7. Following are the benefits of using IIS 7 to host WCF applications Less development effort Hosting on Windows service, mandates the creating of a Windows service installer project on windows service and writing code to instantiate the service, whereas the service could just be hosted on IIS by creating an application on IIS, no further development is needed, just the service implementa

The maximum nametable character count quota (16384) has been exceeded

Some of our services were growing and the other day it hit the quote, I could not update the service references, nor was I able to run the WCFTest client. An error is diplayed saying " The maximum nametable character count quota (16384) has been exceeded " The problem was with the mex endpoint, where the XML that was sent was too much for the client to handle, this can be fixed by do the following. Just paste the lines below within the configuration section of the devenve.exe.config and the svcutil.exe.config files found at the locations C:\Program Files\Microsoft Visual Studio 9.0\Common7\IDE , C:\Program Files\Microsoft SDKs\Windows\v6.0A\bin Restart IIS and you are done. The detailed error that you get is the following : Error: Cannot obtain Metadata from net.tcp://localhost:8731/ Services/SecurityManager/mex If this is a Windows (R) Communication Foundation service to which you have access, please check that you have enabled metadata publishing at the specified address. F

Finalization, Know What it Costs

This is a post about object finalization in .NET. Finalization is not as inexpensive as we think, it increases the pressure put on GC.All objects that need finalization are moved into a finalizable queue and the actual finalization happens in a separate thread. Because the objects full state may be needed, the object itself and all the object it points to are promoted to the next generation (this is needed so that GC does not clean these objects off in the current round), and these objects are cleaned up only after the following GC. Due to this reason, resources that need to be released should be wrapped in as small a finalizable object as possible, for instance if your class needs a reference to an unmanaged resource, then you should wrap the unmanaged resource in a separate finalizable class and make that a member of your class and furthermore the parent should be a non-finalizable class. This approach will assure that only the wrapped class (class that contains the unmanaged resourc