This article will present code regarding the 'Unit of Work' pattern in Entity Framework, EF. I will also show updated code for a generic repository pattern of the same code.
Note that the code in this article is very general and can be run against your DbContext regardless of how it looks. It is solved general, using generics and some usage of reflection.
Note that this code goes against DbContext and is written in a solution that uses Entity Framework 6.4.4. However, the code here should work also in newer EF versions, that is - EF Core versions - such as
EF Core 6, as the code is very general and EF Core also got the similar structure at least concerning the code shown here..
First off, the code for the interface IUnitOfWork looks like this:
IUnitOfWork.cs
using SomeAcme.Common.Interfaces;
namespace SomeAcme.Data.EntityFramework.Managers
{
public interface IUnitOfWork
{
UnitOfWork AddRepository<T>() where T : class;
UnitOfWork AddCustomRepository<T>() where T : class;
int Complete();
void Dispose();
UnitOfWork RemoveRepository<T>() where T : class;
IRepository<T> Repository<T>() where T : class;
}
}
The method
Complete is important, as it will commit the transaction and perform changes to the database which the UnitOfWork implementation will work against.
The code for UnitWork implementation looks like this:
UnitOfWork.cs
using SomeAcme.Common.Interfaces;
using System;
using System.Collections.Generic;
using System.Linq;
namespace SomeAcme.Data.EntityFramework.Managers
{
public class UnitOfWork : IUnitOfWork, IDisposable
{
private readonly System.Data.Entity.DbContext _dbContext;
public UnitOfWork(System.Data.Entity.DbContext dbContext)
{
_dbContext = dbContext;
_repositories = new Dictionary<Type, object>();
}
public UnitOfWork AddRepository<T>() where T : class
{
if (!_repositories.ContainsKey(typeof(T)))
{
var repoObj = Activator.CreateInstance(typeof(Repository<T>), _dbContext);
Repository<T> repo = repoObj as Repository<T>;
if (repo == null)
{
throw new ArgumentNullException($"Could not instantiate repository of type {typeof(T).Name}");
}
_repositories[typeof(T)] = repo;
}
return this;
}
public UnitOfWork AddCustomRepository<T>() where T : class
{
if (!_repositories.ContainsKey(typeof(T)))
{
bool checkImpementationPassesGenericInterfaceCheck = typeof(T).GetInterfaces().Any(i => i.IsGenericType && i.GetGenericTypeDefinition() == typeof(IRepository<>));
if (!checkImpementationPassesGenericInterfaceCheck)
{
throw new ArgumentException($"The type {typeof(T).Name} must implement IRepository<T> to be added as a custom repository");
}
var repoObj = Activator.CreateInstance(typeof(T), _dbContext);
if (repoObj == null)
{
throw new ArgumentNullException($"Could not instantiate repository of type {typeof(T).Name}");
}
_repositories[typeof(T)] = repoObj;
}
return this;
}
public UnitOfWork RemoveRepository<T>() where T : class
{
if (_repositories.ContainsKey(typeof(T)))
{
_repositories.Remove(typeof(T));
}
return this;
}
public IRepository<T> Repository<T>() where T : class
{
//find suitable repo - possibly a custom repo ..
IRepository<T> repoFound = null;
foreach (var item in _repositories)
{
if (item.Key == typeof(T))
{
repoFound = _repositories[typeof(T)] as IRepository<T>;
break;
}
bool checkImpementationPassesGenericInterfaceCheck = item.Key.GetInterfaces().Any(i => i.IsGenericType && i.GetGenericTypeDefinition() == typeof(IRepository<>));
if (checkImpementationPassesGenericInterfaceCheck)
{
//the repo implements IRepository<T> - this is the one to use
repoFound = item.Value as IRepository<T>;
break;
}
}
if (repoFound == null)
{
throw new ArgumentNullException($"Could not retrieve repositiory defined inside the UnitOfWork for entity of type: {typeof(T).Name}. Is it registered into the UnitOfWork. Use method 'AddRepository'");
}
return repoFound;
}
private readonly IDictionary<Type, object> _repositories;
public int Complete()
{
if (_dbContext == null)
{
throw new ArgumentNullException($"The db context object of the UnitOfWork class is null, cannot complete the UnitOfWork as the db context is not initialized! No changes was performed in DB !");
}
int numStateEntriesWritten = _dbContext.SaveChanges();
return numStateEntriesWritten;
}
public void Dispose()
{
_dbContext?.Dispose(); //dispose the passed in _shared_ db context instead of
//disposing the db context inside each repository to dispose only once..
GC.SuppressFinalize(this);
}
}
}
Note - this implementation focuses on being able to define repositories to the UnitOfWork before running the unit work in case you want to be able to specify which tables / entities got repositories in the db context. Many other implementations will specify the repositories to expose in the UnitOfWork via property getters for example.
This will make it easier to implement such a UnitOfWork implementation without this ability to expanding which repositories the UnitOfWork is supporting.
Also note that in case you want to add a custom repository that implements IRepository<T> you need to cast into that custom repository when you call the 'Repository' method.
A closed abstraction instead, where you do not add repositories like in this code may be more desirable. But perhaps there are scenarios where you want to add repositories that can take part in the UnitOfWork dynamically as shown here. The downside is that you need to initialize the UnitOfWork in addition to performing the database 'steps' before calling the 'Complete' method.
What is the most practical UnitOfWork implementation in many cases most probably will be a closed abstraction where you specify which repositories the UnitOfWork supports and avoid having to add repositories like shown here. I did this as an academic exercise to see if such an implementation was possible. The unit tests passes and it looks okay to implement. Note though that you should probably have some default initialization here, i.e. in the constructor of UnitOfWork specify some default repositories and consider if you want to allow adding or removing repositories in the UnitOfWork class. Also, removing repositories could be considered an anti-pattern, so you could disallow this - only allowing adding custom repositories implementating the IRepository<T> in addition to listing up some implemented repositories.
Important - always just pass in ONE db context. Each repository must use the same db context instance so the change tracking works as expected. Also note -
the UnitOfWork and repositories implement IDisposable. When UnitOfWork goes out of scope, the db context is disposed. In case you want to add the UnitOfWork as a service in a DI container, remember to set up a scoped instance so it will be disposed. In case you use Singleton - this will cause the db connection to hang around.. the Dispose method is exposed as a public method anyways and can be called to dispose on-demand..
Finally, here are some tests that passes testing out the UnitOfWork together with the generic repository pattern !
[Test]
public void UnitOfWorkPerformsExpected()
{
var dbContext = GetContext();
var unitOfWork = new UnitOfWork(dbContext);
unitOfWork.AddRepository<OperationExternalEquipment>()
.AddRepository<OperationDiagnoseCode>();
var operationExternalEquipment = new OperationExternalEquipment
{
OperationId = 10296,
EquipmentText = "Stent graft type ABC-123",
OrderedDate = DateTime.Today
};
var operationDiagnoseCode = new OperationDiagnoseCode
{
OperationId = 10296,
DiagnoseCodeId = "A09.9",
IsCodePreFabricated = true
};
//act
unitOfWork.Repository<OperationExternalEquipment>().Add(operationExternalEquipment);
unitOfWork.Repository<OperationDiagnoseCode>().Add(operationDiagnoseCode);
int savedResult = unitOfWork.Complete();
savedResult.Should().Be(2);
//assert
var savedOperationEquipmentsForOperation = unitOfWork.Repository<OperationExternalEquipment>().Find(x => x.OperationId == 10296).ToList();
savedOperationEquipmentsForOperation.Any(x => x.EquipmentText == "Stent graft type ABC-123").Should().BeTrue();
var savedOperationDiagnoseCodesForOperation = unitOfWork.Repository<OperationDiagnoseCode>().Find(x => x.OperationId == 10296).ToList();
savedOperationDiagnoseCodesForOperation.Any(x => x?.DiagnoseCodeId == "A09.9").Should().BeTrue();
//cleanup
unitOfWork.Repository<OperationExternalEquipment>().Remove(operationExternalEquipment);
unitOfWork.Repository<OperationDiagnoseCode>().Remove(operationDiagnoseCode);
savedResult = unitOfWork.Complete();
savedResult.Should().Be(2);
}
[Test]
public void UnitOfWorkCustomRepoPerformsExpected()
{
var dbContext = GetContext();
var unitOfWork = new UnitOfWork(dbContext);
unitOfWork.AddCustomRepository<OperationExternalEquipmentCustomRepo>();
var operationExternalEquipment = new OperationExternalEquipment
{
OperationId = 10296,
EquipmentText = "Stent graft type DEF-456",
OrderedDate = DateTime.Today
};
//act
unitOfWork.Repository<OperationExternalEquipment>().Add(operationExternalEquipment);
int savedResult = unitOfWork.Complete();
savedResult.Should().Be(1);
//assert
var savedOperationEquipmentsForOperation = unitOfWork.Repository<OperationExternalEquipment>().Find(x => x.OperationId == 10296).ToList();
savedOperationEquipmentsForOperation.Any(x => x.EquipmentText == "Stent graft type DEF-456").Should().BeTrue();
//check if we can use a custom repo method !
var equipmentRepo = unitOfWork.Repository<OperationExternalEquipment>() as OperationExternalEquipmentCustomRepo;
var equipmentTexts = string.Join(",", equipmentRepo.GetEquipmentTexts(10296));
bool foundText = equipmentTexts.Contains("Stent graft type DEF-456");
foundText.Should().BeTrue();
//cleanup
unitOfWork.Repository<OperationExternalEquipment>().Remove(operationExternalEquipment);
savedResult = unitOfWork.Complete();
savedResult.Should().Be(1);
}
The adjusted implementation of Repository now looks like this - I have renamed many of the methods to be more standard compared to other implementations of the repository pattern demonstrated online in different videos on Youtube for example.
The updated interface for repository now looks like this:
IRepository.cs
using System;
using System.Collections.Generic;
using System.Linq.Expressions;
namespace SomeAcme.Common.Interfaces
{
/// <summary>
/// Generic implementation of repository pattern for (should maybe have been implemented a decade ago to save some development time .. :-) to save some code in DAL-layer Data.EntityFramework )
/// </summary>
/// <typeparam name="T">Entity T (POCO for table)</typeparam>
public interface IRepository<T> where T : class
{
/// <summary>
/// Performs an insert of an entity
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="entity"></param>
/// <param name="keyValues">If set, these key values are used to locate entity in db after the insertion has been performed if specifed by other param for saveImmediate</param>
/// <param name="saveImmediate">Save immediately in db after adding the entity</param>
T Add(T entity, bool saveImmediate = false);
/// <summary>
/// Performs an insert of multiple entities
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="entity"></param>
/// <param name="saveImmediate">Save immediately after adding item in db</param>
IEnumerable<T> AddRange(IEnumerable<T> entity, bool saveImmediate = false);
/// <summary>
/// Saves changes. Commits the data to the database.
/// </summary>
/// <param name="dbContext">Db context</param>
void SaveChanges(object dbContext);
/// <summary>
/// Delete an entity specified by <paramref name="keyValues"/> to look up entity
/// </summary>
/// <param name="keyValues"></param>
/// <returns></returns>
T Remove(bool saveImmediate, params object[] keyValues);
/// <summary>
/// Deletes an entity specified by <paramref name="entity"/> from the database
/// </summary>
/// <param name="entity"></param>
void Remove(T entity, bool saveImmediate = false);
/// <summary>
/// Removes entities specified by <paramref name="entities"/> from the database
/// </summary>
/// <param name="entities"></param>
void RemoveRange(IEnumerable<T> entities, bool saveImmediate = false);
/// <summary>
/// Update <paramref name="entity"/>
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="entity"></param>
/// <param name="saveImmediate">Save immediate if set to true</param>
/// <returns></returns>
T Update(T entity, bool saveImmediate, params object[] keyValues);
/// <summary>
/// Equivalent to a 'GetById' method, but tailored for generic use.
/// Retrieves <paramref name="idSelector"/> specified by <paramref name="idValue"/>
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="keyValues">Key values to use to find entity</param>
T Get(bool asNoTracking = true, params object[] keyValues);
/// <summary>
/// Retrieves entities of type <typeparamref name="T"/> via predicate <paramref name="condition"/>.
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="condition"></param>
/// <returns></returns>
/// <param name="asNoTracking">If true, does not track items (less chance of db locks due to turning off change tracking) </param>
IEnumerable<T> Find(Expression<Func<T, bool>> condition, bool asNoTracking = true);
/// <summary>
/// Retrieves an entity of type <typeparamref name="T"/> via predicate <paramref name="condition"/>.
/// If not found, null is returned.
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="condition"></param>
/// <returns></returns>
T GetByCondition(Expression<Func<T, bool>> condition);
/// <summary>
/// Retrieve all the entities specified by <typeparamref name="T"/>.
/// </summary>
/// <typeparam name="T"></typeparam>
/// <returns></returns>
/// <param name="asNoTracking">If true, does not track items (less chance of db locks due to turning off change tracking) </param>
IEnumerable<T> GetAll(bool asNoTracking = true);
}
}
And the implementation looks like this:
using SomeAcme.Common.Interfaces;
using System;
using System.Collections.Generic;
using System.Data.Entity;
using System.Linq;
using System.Linq.Expressions;
namespace SomeAcme.Data.EntityFramework.Managers
{
public class Repository<T> : IRepository<T>, IDisposable where T : class
{
private readonly System.Data.Entity.DbContext _dbContext;
public Repository(System.Data.Entity.DbContext dbContext)
{
_dbContext = dbContext;
}
public T Add(T entity, bool saveImmediate = false)
{
return ExecuteQuery((T obj, System.Data.Entity.DbContext dbContext) =>
{
var entityDb = dbContext.Set<T>().Add(entity);
if (saveImmediate)
SaveChanges(dbContext);
return entityDb;
}, entity);
}
public T Add(T entity, bool saveImmediate = false, params object[] keys)
{
return ExecuteQuery((T obj, System.Data.Entity.DbContext dbContext) =>
{
dbContext.Entry(obj).State = EntityState.Added;
if (saveImmediate)
SaveChanges(dbContext);
var entityInDb = dbContext.Set<T>().Find(keys);
return entityInDb;
}, entity);
}
public IEnumerable<T> AddRange(IEnumerable<T> entities, bool saveImmediate)
{
var entitites = _dbContext.Set<T>().AddRange(entities);
if (saveImmediate)
SaveChanges(_dbContext);
return entitites;
}
public T Remove(bool saveImmediate = false, params object[] keyValues)
{
var entity = _dbContext.Set<T>().Find(keyValues);
if (entity == null)
return null;
var entry = _dbContext.Entry(entity);
if (entry == null)
return null;
entry.State = EntityState.Deleted;
if (saveImmediate)
SaveChanges(_dbContext);
return entity;
}
public void Remove(T entity, bool saveImmediate = false)
{
_dbContext.Set<T>().Remove(entity);
if (saveImmediate)
SaveChanges(_dbContext);
}
public void RemoveRange(IEnumerable<T> entities, bool saveImmediate = false)
{
_dbContext.Set<T>().RemoveRange(entities);
if (saveImmediate)
SaveChanges(_dbContext);
}
/// <summary>
/// Note - requiring here that we have defined primary key(s) on the target tables !
/// </summary>
/// <param name="keyValues"></param>
/// <returns></returns>
public T Get(params object[] keyValues)
{
var entity = _dbContext.Set<T>().Find(keyValues);
_dbContext.Entry(entity).State = EntityState.Detached;
return entity;
}
public IEnumerable<T> GetAll(bool asNoTracking = true)
{
return asNoTracking ? _dbContext.Set<T>().AsNoTracking() : _dbContext.Set<T>();
}
public IEnumerable<T> Find(Expression<Func<T, bool>> condition, bool asNoTracking = true)
{
IQueryable<T> query = asNoTracking ? _dbContext.Set<T>().AsNoTracking() : _dbContext.Set<T>();
var entities = query.Where(condition);
return entities;
}
public T GetByCondition(Expression<Func<T, bool>> condition)
{
IQueryable<T> query = _dbContext.Set<T>().AsNoTracking();
var entities = query.Where(condition);
return entities.FirstOrDefault();
}
public bool ExistsByCondition(Expression<Func<T, bool>> condition)
{
IQueryable<T> query = _dbContext.Set<T>().AsNoTracking();
return query.Any(condition);
}
public T Get(bool asNoTracking, params object[] keyValues)
{
var entity = asNoTracking ? _dbContext.Set<T>().AsNoTracking().FirstOrDefault() : _dbContext.Set<T>().Find(keyValues);
return entity;
}
public void SaveChanges(object context)
{
var dbContext = context as System.Data.Entity.DbContext;
if (dbContext == null)
{
throw new ArgumentException($"dbContext object inside save method : Must be of type System.Data.Entity.DbContext", nameof(context));
}
dbContext.SaveChanges();
}
public T Update(T entity, bool saveImmediate = false, params object[] keyValues)
{
return ExecuteQuery((T obj, System.Data.Entity.DbContext dbContext) =>
{
var entityInDb = dbContext.Set<T>().Find(keyValues);
if (entityInDb == null)
return null;
dbContext.Entry(entityInDb).CurrentValues.SetValues(obj);
if (saveImmediate)
{
SaveChanges(dbContext);
}
return obj;
}, entity);
}
private T ExecuteQuery(Func<T, System.Data.Entity.DbContext, T> query, T entity)
{
T result = query(entity, _dbContext);
return result;
}
public void Dispose()
{
Dispose(true);
}
private void Dispose(bool isDisposing)
{
if (isDisposing)
{
_dbContext?.Dispose();
GC.SuppressFinalize(this);
}
}
}
}
Totally, the code of the unit of work and repository pattern is about 300 lines of code combined. It should match a lot of Data Access Layer (DAL) implementations of Entity Framework, possible we could reduce a lot of code here in many projects by following these patterns which are accepted data access patterns defined by the 'Gang of four' way back many decades ago.
If I would adjust this code next I would do these modifications :
- UnitOfWork should only allow adding custom repos in addition to some predefines repos. This should give an overall simplification of UnitOfWork
- Specific transaction handling should be added, like setting the transaction isolation scope. Also speifically doing rollback in case anything crashes in UnitOfWork
- Possible add some more shared utility methods inside Repository class if such should be added
