Way back in January, I said that I was going to post on a generic repository. Due to various other diversions during the year, I never managed to get around to completing this work but on the last day of the year, it is finally all done and to tick off one of my goals, here is the post about it.
What’s It All About?
When talking about both LINQ to SQL (L2S) and Entity framework (EF), you will frequently hear developers saying that they will be using a repository to encapsulate the ORM interactions, what this means in practice is hiding the actual ORM functions and providing an
abstract class or interface you can mock to make it easier to test your applications.
The simplest way of doing this is simply creating a class per entity that implements an interface and allows you to mock/stub/fake the interactions with the ORM allowing for easier unit testing of logic.
Hasn’t This Been Done Before?
Yes it has. There are lots of articles on the web in relation to creating repositories and in particular generic repositories.
The majority of the articles I found were around EF but there were also versions for L2S and NHibernate.
So Why Did You Create One?
At the time I started to create my own generic repository, I had been using L2S for a while but found it frustrating that although it was useful, it made testing very difficult as there was no easy way to mock/stub/fake it.
So I decided to try and create my own; yes I could have just used one that was already on the internet but doing that, I wouldn’t have really thought about what was needed or what issues I could encounter.
It would be very churlish of me to pretend that I hadn’t looked at other peoples' implementations especially since the issues I was running into may have already been solved by other people (this post in relation to the L2S implementation and this post in relation to the EF implementation).
Does This Code Offer Anything Different?
My code has been designed to work with dependency injection and because of this, each repository class does not create the context it needs, rather it expects it to be injected into it. It's not revolutionary but does allow the developer to control the lifetime of the context rather than relying on the repository to do so.
The implementations for L2S and EF have been designed to work with entities that have been disconnected from a context rather than simply expecting all the interactions to be done within the scope of a single context which is often an issue in n-tier applications.
A fair number of the generic repository implementations I found on the web expected you to not only specify the type but also the primary key, my implementations will attempt to determine the primary key of the entity itself removing the need to specify this.
Why Use Generic Repositories?
Generic repositories are perfect when building applications using TDD and you need to be able to mock/stub/fake the ORM as a dependency. It is also possible to take a lot of boiler plate code (such as updating changes in a disconnected scenario) and push it into the repository so keeping the code DRY and adhering to SOLID principles.
The other major advantage is the ability to inject the ORM dependency into other classes allowing you utilize IoC containers to construct whatever object graph is required.
The generic repository as I, and most other examples, have implemented it is a leaky abstraction as the entities in the ORM are what the rest of the code uses thereby creating a tight coupling between the application code and the specific ORM. This may or may not be an issue for you depending on whether you are happy to be bound to any specific ORM or if you truly want persistent ignorance.
Although the generic repository offers a lot of control if your entities contain child objects, you still don’t have control over it when how those are loaded, they are still loaded by the ORM and potentially if the entity has been disconnected, you could have errors to contend with as it tries to load them without a context.
By encapsulating the ORM behind a facade interface, it is possible you will lose some (all?) of the in built functionality that the ORM provides (self tracking entities is one possible loss) which could render the advantages of using an ORM null and void.
Whilst writing this code, it struck me that the generic repository is an imperfect solution to the problem of mocking/stubbing/faking an ORM to reduce the coupling between the layers and since I first starting looking at this, various solutions have come about – EF Code First, micro-ORM’s (Massive, Dapper, Simple.Data) and these provide a better solution BUT they rely on dynamic and if you are still working with .NET 3.5 this isn’t available.
So if you’re on .NET 4 (or above), then look to one of the newer versions of ORM or micro-ORM that will easily allow you to mock/stub/fake the data access without the need for this additional coding, however, if you are working with .NET 3.5, then a generic repository may just be what you need to enable you to utilise an ORM, unit test the code and use IoC to create your object graph.
The code itself is available to download from my GitHub, please go here to download it.
Note: The code has been written in .NET 4.0 whilst L2S is happy to convert to .NET 3.5 the EF implementation will need rewriting to work.