Unit of Work Pattern Martin Fowler'ın 2002 yılında yazdığı Patterns of Enterprise Application Architecture kısaca PoEAA olarak da adlandırılan kitabında bahsetmesiyle hayatımıza girmiş bir pattern dır.
M.Fowler kitabında UoW'ü şu şekilde tanımlar,
Maintains a list of objects affected by a business transaction and coordinates the writing out of changes and the resolution of concurrency problems.
Unit of Work; database'de execute etmemiz gereken bir dizi işlemin yani birden fazla transaction'a ihtiyaç duyarak yapacağımız işlemler (Create, Update, Insert, Delete, Read) dizinini success veya fail olması durumunda tek bir unit yani tek bir birim olarak ele alıp yönetilmesini sağlayan pattern dir.
Diğer bir değişle; ardı ardına çalışması gereken 2 sql transaction var ve bunlardan biri insert diğeride update yapsın. İlk olarak insert yaptınız ve hemen sonrasında update sorgusunu çalıştırdınız fakat update işlemi bir sorun oluştu ve fail oldu. Unit of work tam da bu sırada araya girerek bu iki işlemi bir birimlik bir işlem olarak ele alır ve normal şartlarda ikisininde success olması durumunda commit edeceği sessino'ı update işlemi fail verdiğinden ilk işlem olan insert'ü rollback yapar ve db de yanlış veya eksik kayıt oluşmasını engeller. Yada ikiside success olduğunda session'ı commit ederek consistency'i sağlar.
Örnek üzerinden ilerleyecek olursak; bir data-access katmanımız olsun ve ORM olarak da NHibernate'i kullanıyor olalım. Projemizde IoC container olarak da Castle Windsor'ı entegre edelim. İlk olarak Vs'da "UoW_Sample" adında bir Empty Asp.Net Web Api projesi oluşturalım ve sonrasında nugetten Sırasıyla Fluent-NHibernate ve Castle Windsor'ı yükleyelim.
Case'imiz şu şekilde olsun; User ve Address adında tablolarımız var ve AddNewUser adında bir endpoint'ten hem kullanıcı hemde address bilgileri içeren bir model alarak sırasıyla User'ı ve Address'i insert etmeye çalışalım. User'ı insert ettikten sonra Address insert sırasında bir sorun oluşsun ve UoW araya girerek kaydedilecek olan user'ı da rollback yapsın.
Öncelikle User ve Address modellerimizi aşağıdaki gibi oluşturalım.
public class User
{
public virtual int Id { get; set; }
public virtual string Name { get; set; }
public virtual string SurName { get; set; }
}
public class Address
{
public virtual int Id { get; set; }
public virtual string CityCode { get; set; }
public virtual string DistrictCode { get; set; }
public virtual string Description { get; set; }
public virtual int UserId { get; set; }
}
Bu modellere ait Nhibernate Mapping'lerini de aşağıdaki gibi oluşturalım.
public class UserMap : ClassMap<User>
{
public UserMap()
{
Id(x => x.Id);
Map(x => x.Name);
Map(x => x.SurName);
Table("Users");
}
}
public class AddressMap : ClassMap<Address>
{
public AddressMap()
{
Id(x => x.Id);
Map(x => x.CityCode);
Map(x => x.DistrictCode);
Map(x => x.Description);
Map(x => x.UserId);
Table("Address");
}
}
Repository kullanımı için aşağıdaki gibi generic repo class'larını oluşturalım. Bu arayüz üzerinden db de bulunan tablolarımız için CRUD işlemlerini yapacağız.
public interface IRepository<T> where T : class
{
T Get(int id);
IQueryable<T> SelectAll();
T GetBy(Expression<Func<T, bool>> expression);
IQueryable<T> SelectBy(Expression<Func<T, bool>> expression);
int Insert(T entity);
void Update(T entity);
}
public abstract class BaseRepository<T> : IRepository<T> where T : class
{
public ISessionFactory SessionFactory { get; private set; }
public ISession _session
{
get { return this.SessionFactory.GetCurrentSession(); }
}
public BaseRepository(ISessionFactory sessionFactory)
{
SessionFactory = sessionFactory;
}
public T Get(int id)
{
return _session.Get<T>(id);
}
public IQueryable<T> SelectAll()
{
return _session.Query<T>();
}
public T GetBy(Expression<Func<T, bool>> expression)
{
return SelectAll().Where(expression).SingleOrDefault();
}
public IQueryable<T> SelectBy(Expression<Func<T, bool>> expression)
{
return SelectAll().Where(expression).AsQueryable();
}
public int Insert(T entity)
{
var savedId = (int)_session.Save(entity);
_session.Flush();
return savedId;
}
public void Update(T entity)
{
_session.Update(entity);
_session.Flush();
}
}
Tablolarımıza karşılık UserRepository ve AddressRepository class'larını arayüzleri ile birlikte aşağıdaki gibi tanımlayalım.
public interface IUserRepository : IRepository<User>
{ }
public class UserRepository : BaseRepository<User>, IUserRepository
{
public UserRepository(ISessionFactory sessionFactory) : base(sessionFactory)
{
}
}
public interface IAddressRepository : IRepository<Address>
{ }
public class AddressRepository : BaseRepository<Address>, IAddressRepository
{
public AddressRepository(ISessionFactory sessionFactory) : base(sessionFactory)
{
}
}
Repository'lerimiz direkt olarak api'ın controller'ları ile haberleşmesini istemediğimizden bir service katmanımızın olduğunu düşünerek UserService adında doğrudan Repository'ler ile iletişim kurabilen class'ımızı oluşturalım ve Unit Of Work interceptor'ı da bu service class'ları seviyesinde container'a inject edeceğiz.
Projede yer alan service'leri bir çeşit flag'lemek adına IApiService adında bir base interface tanımlayalım.Bu interface'i daha sonrasında container'a bütün service'leri register etmede de kullanacağız.
public interface IApiService
{ }
public interface IUserService : IApiService
{
void AddNewUser(AddNewUserRequest reqModel);
}
public class UserService : IUserService
{
private readonly IUserRepository _userRepository;
private readonly IAddressRepository _addressRepository;
public UserService(IUserRepository userRepository, IAddressRepository addressRepository)
{
_userRepository = userRepository;
_addressRepository = addressRepository;
}
public void AddNewUser(AddNewUserRequest reqModel)
{
var user = new User { Name = reqModel.User.Name, SurName = reqModel.User.SurName };
var userId = _userRepository.Insert(user);
var address = new Address { UserId = userId, CityCode = reqModel.Address.CityCode, Description = reqModel.Address.Description, DistrictCode = reqModel.Address.DistrictCode };
_addressRepository.Insert(address);
}
}
public class AddNewUserRequest
{
public UserDto User { get; set; }
public AddressDto Address { get; set; }
}
public class UserDto
{
public string Name { get; set; }
public string SurName { get; set; }
}
public class AddressDto
{
public string CityCode { get; set; }
public string DistrictCode { get; set; }
public string Description { get; set; }
}
Yukarıda end-point'imizin alacağı request model ve onun dto class'larını da oluşturduk. Şimdi ise api end-point'imizi tanılayalım. UserController adında client'ların call yapacağı controller'ımız aşağıdaki gibi olacaktır.
public class UserController : ApiController
{
private readonly IUserService _userService;
public UserController(IUserService userService)
{
_userService = userService;
}
[HttpPost]
public virtual HttpResponseMessage AddNewUser(AddNewUserRequest reqModel)
{
_userService.AddNewUser(reqModel);
return Request.CreateResponse();
}
}
Geliştirmemiz gereken 2 yer kaldı Castle Windsor implementasyonu ve UnitOfWork Interceptor oluşturulması. Projemizde her şeyi interface'ler üzerinden yaptık ve constructor injection'dan faydalandık. Şimdi ise Repository, Service ve Controller'lar için bağımlılıkları enjekte edelim ve UnitOfWork Interceptor'ı oluşturalım.
İlk olarak NHibernateInstaller.cs'i tanımlayalım. Burda web.config/app.config dosyamızda "ConnString" key'i ile kayıtlı database conenction string'imiz olduğunu varsayalım ve aşağıdaki gibi tanımlamalarımızı yapalım.
public class NHibernateInstaller : IWindsorInstaller
{
public void Install(IWindsorContainer container, IConfigurationStore store)
{
var sessionFactory = Fluently.Configure()
.Database(MsSqlConfiguration.MsSql2012.ConnectionString(c => c.FromConnectionStringWithKey("ConnString")).ShowSql())
.Mappings(m => m.FluentMappings.AddFromAssemblyOf<UserMap>())
.ExposeConfiguration(cfg => new SchemaUpdate(cfg).Execute(false, true))
.ExposeConfiguration(cfg =>
{
cfg.CurrentSessionContext<CallSessionContext>();
})
.BuildSessionFactory();
container.Register(
Component.For<ISessionFactory>().UsingFactoryMethod(sessionFactory).LifestyleSingleton());
}
}
İkinci olarak RepositoryInstaller.cs'i oluşturalım. Bu installer ile projemizde bulunan bütün repository interfacelerini ve onların implementasyonlarını container'a register etmiş olucaz. Her bir repository'i ayrı ayrı register etmek yerine bütün repository'lerimiz IRepository interface'in den türediğinden container'a IRepository'i implement eden bütün class'ları register etmesini belirteceğiz.
public class RepositoryInstaller : IWindsorInstaller
{
public void Install(IWindsorContainer container, IConfigurationStore store)
{
container.Register(
Classes.FromThisAssembly()
.Pick()
.WithServiceAllInterfaces()
.LifestylePerWebRequest()
.Configure(x => x.Named(x.Implementation.Name))
.ConfigureIf(x => typeof(IRepository<>).IsAssignableFrom(x.Implementation), null));
}
}
Üçüncü olarak ServiceInstaller.cs class'ını tanımlayalım ancak öncesinde yukarıda da belirttiğimiz gibi UnitOfWork'ü service seviyesinde container'a register edeceğiz. Sebebi ise repository'e erişimimiz service class'ları üzerinden olması. UnitOfWork'ü de interceptor olarak yaratacağız ve böylelikle service metoduna girerken session'ı bind edip metot içerisinde herhangi bir exception aldığında rollback yapacağız yada herhangi bir sorun yoksada session'ı commit edip query'leri execute etmesini sağlayacağız. Aşağıda ilk olarak unitofwork manager ve interceptor class'larını oluşturalım.
public interface IUnitOfWorkManager
{
void BeginTransaction();
void Commit();
void Rollback();
}
public class UnitOfWorkManager : IUnitOfWorkManager
{
public static UnitOfWorkManager Current
{
get { return _current; }
set { _current = value; }
}
[ThreadStatic]
private static UnitOfWorkManager _current;
public ISession Session { get; private set; }
private readonly ISessionFactory _sessionFactory;
private ITransaction _transaction;
public UnitOfWorkManager(ISessionFactory sessionFactory)
{
_sessionFactory = sessionFactory;
}
public void BeginTransaction()
{
Session = _sessionFactory.OpenSession();
CurrentSessionContext.Bind(Session);
_transaction = Session.BeginTransaction();
}
public void Commit()
{
try
{
_transaction.Commit();
}
finally
{
Session.Close();
}
}
public void Rollback()
{
try
{
_transaction.Rollback();
}
finally
{
Session.Close();
}
}
}
Yukarıda oluşturduğumuz manager'ı kullanarak UnitOfWorkInterceptor'ı da aşağıdaki gibi tanımlayalım.
public class UnitOfWorkInterceptor : Castle.DynamicProxy.IInterceptor
{
private readonly ISessionFactory _sessionFactory;
public UnitOfWorkInterceptor(ISessionFactory sessionFactory)
{
_sessionFactory = sessionFactory;
}
public void Intercept(IInvocation invocation)
{
try
{
UnitOfWorkManager.Current = new UnitOfWorkManager(_sessionFactory);
UnitOfWorkManager.Current.BeginTransaction();
try
{
invocation.Proceed();
UnitOfWorkManager.Current.Commit();
}
catch
{
UnitOfWorkManager.Current.Rollback();
throw new Exception("Db operation failed.");
}
}
finally
{
UnitOfWorkManager.Current = null;
}
}
}
Yukarıda tanımladığımız interceptor'ı aşağıdaki gibi service'leri register ederken bu service class'larına ait metotlar için UnitOfWorkInterceptor'ı configure etmesini belirteceğiz.
public class ServiceInstaller : IWindsorInstaller
{
public void Install(IWindsorContainer container, IConfigurationStore store)
{
container.AddFacility<TypedFactoryFacility>();
container.Register(
Classes.FromAssemblyContaining<UserService>()
.Pick()
.WithServiceAllInterfaces()
.LifestylePerWebRequest()
.Configure(x => x.Named(x.Implementation.Name))
.ConfigureIf(x => typeof(IApiService).IsAssignableFrom(x.Implementation),
y => y.Interceptors<UnitOfWorkInterceptor>()));
}
}
Projemiz bir Web Api projesi olduğundan controller'lar ile ilgili container registration işlemleri için gerekli olan WebApiControllerInstaller.cs class'ı ve ControllerActivator.cs class'ı tanımlamaları da aşağıdaki gibidir.
public class ApiControllerActivator : IHttpControllerActivator
{
private readonly IWindsorContainer _container;
public ApiControllerActivator(IWindsorContainer container)
{
_container = container;
}
public IHttpController Create(
HttpRequestMessage request,
HttpControllerDescriptor controllerDescriptor,
Type controllerType)
{
var controller =
(IHttpController)this._container.Resolve(controllerType);
request.RegisterForDispose(
new Release(
() => this._container.Release(controller)));
return controller;
}
private class Release : IDisposable
{
private readonly Action _release;
public Release(Action release)
{
_release = release;
}
public void Dispose()
{
_release();
}
}
}
public class WebApiControllerInstaller : IWindsorInstaller
{
public void Install(IWindsorContainer container, IConfigurationStore store)
{
container.Register(Classes.FromThisAssembly()
.BasedOn<ApiController>()
.LifestylePerWebRequest());
}
}
Geldik son adıma. Yukarıda tanımladığımız bütün installer class'larını container'a install etmeye. Bunun için projede yer alan Global.asax.cs içerinde yer alan Application_Start metodu içerisine aşağ��daki gibi installation işlemlerini yapalım.
protected void Application_Start()
{
var container = new WindsorContainer();
container.Register(Component.For<UnitOfWorkInterceptor>().LifestyleSingleton());
container.Install(new ServiceInstaller());
container.Install(new RepositoryInstaller());
container.Install(new NHibernateInstaller());
container.Install(new WebApiControllerInstaller());
GlobalConfiguration.Configuration.Services.Replace(
typeof(IHttpControllerActivator),
new ApiControllerActivator(container));
GlobalConfiguration.Configure(WebApiConfig.Register);
}
Postman üzerinden aşağıdaki gibi end-point'imize call yapalım ve hem iki insert işlemininde başarılı olduğu case'i hemde user insert başarılı olduktan sonra address insert sırasında bir hata verdirip ilk işleminde rollback olduğu case'i oluşturup gözlemleyebiliriz.
Unit of Work pattern gözlemlediğim kadarıyla genellikle projede her query execution sırasında o satırları try-catch e alarak değişik logic'ler uygulanarak yapılıyor ancak. Aspect oriented'ın bize sağladıklarından faydalanarak bir interceptor ile projede her yerde kullanabileceğimiz basit bir infrastructure geliştirebiliriz. Bu pattern ile aynı işleve hizmet eden birden fazla küçük küçük db transaction'ını tek bir unit olarak yönetip dirty data'nın da önüne geçmiş oluyoruz.