Daha önceki yazılarımızda IoC nedir ve Castle Windsor Kullanarak Cache Interceptor Oluşturma konularına değinmiştik. Bu yazımızda ise yine Windsor kullanarak projelerimizde sıkça kullandığımız bir özellik olan Caching işlemini basitçe yapabilen bir interceptor oluşturacağız.
Bir Api projesi oluşturalım ve projemizde cache ile ilgili işlemlerin yönetildiği ICache isminde aşağıdaki gibi bir interface'imiz olsun ve arka planda kullandığınız herhangi bir cache yapısı olabilir (Redis, memory cache, vs.) bu interface'in implementasyonunu kullandığınız cache yapısına göre yapmış varsayalım.
public interface ICache : IDisposable
{
object Get(string key);
void Set(string key, object obj, DateTime expireDate);
void Delete(string key);
bool Exists(string key);
}
Şimdi ise projemize Castle'ı nuget'ten indirip kuralım ve sonrasında aşağıdaki gibi CacAttribute adında bir attribute tanımlayalım. Bu attribute'ü kullanarak cache'e atmak istediğimiz metotları bir nevi flag'lemiş olacağız.
[AttributeUsage(AttributeTargets.Method)]
public class CacheAttribute : Attribute
{
public int CacheDurationInSecond { get; private set; }
public CacheAttribute(int cacheDurationInSecond = 300)
{
CacheDurationInSecond = cacheDurationInSecond;
}
}
Örnek olarak projemizde LocationController adında bir controller ve içerisinde GetDistrictsByCityCode adında int cityCode parametresine göre geriye o şehirde bulunan ilçelerin listesini dönen bir end-point tanımlayalım. Projemizde kullanacağımız modellerimizi aşağıdaki gibi oluşturalım.
public class BaseResponse
{
public bool IsSuccess { get; set; }
}
public class GetDistrictsByCityCodeResponse : BaseResponse
{
public List<string> CityList { get; set; }
}
Controller'ın kullanacağı ILocationService ve onun implementasyonunu aşağıdaki gibi tanımlayalım.
public interface ILocationService
{
[Cache(300)]
GetDistrictsByCityCodeResponse GetDistrictsByCityCode(int cityCode);
}
public class LocationService : ILocationService
{
public GetDistrictsByCityCodeResponse GetDistrictsByCityCode(int cityCode)
{
return new GetDistrictsByCityCodeResponse
{
CityList = new List<string> {
"Alaçam","Asarcık","Atakum",
"Ayvacık", "Bafra", "Canik",
"Çarşamba","Havza", "İlkadım",
"Kavak","Ladik", "Ondokuzmayıs",
"Salıpazarı","Tekkeköy", "Terme",
"Vezirköprü", "Yakakent" },
IsSuccess = true
};
}
}
Yukarıda görüldüğü üzre GetDistrictsByCityCode metodu üzerinde CacheAttribute'ünü tanımladık ve cache süresi olarak 300 saniye yani 5 dk set ettik. Şimdi ise LocationController'ı oluşturalım ve controller içerisinde tanımlayacağımız end-point ILocationService'i kullanarak GetDistrictsByCityCode metoduna ilgili isteği yapacak. ILocationService'i controller'da kullanabilmek içinde controller'ın constructor'ında seviyesinde ILocationService'i inject edeceğiz.
public class LocationController : ApiController
{
private readonly ILocationService _locationService;
public LocationController(ILocationService locationService)
{
_locationService = locationService;
}
[HttpGet]
public HttpResponseMessage GetDistrictsByCityCode(int cityCode)
{
var response = _locationService.GetDistrictsByCityCode(cityCode);
return Request.CreateResponse(response);
}
}
Metodumuz geriye BaseResponse'dan türemiş olan GetDistrictsByCityCodeResponse objesini dönecek ve bu objede bulunan IsSuccess parametresini kontrol ederek modeli cache'e atıp atmamaya karar vereceğiz. Bunu yapmamızın sebebi hatalı response'ları cache atmayı önlemek. LocationService içerisindeki metotta dummy olarak geriye Samsun ilinin ilçelerini return eden bir response oluşturduk ve projemizi deneme amaçlı bunu return edeceğiz.
Sırada cache işlemlerinin yapıldığı aspect'imizi tanımlama var. Aşağıda olduğu gibi CacheInterceptor adında aspect'imizi tanımlayalım.
public class CacheInterceptor : IInterceptor
{
private readonly ICache _cacheProvider;
private readonly object _lockObject = new object();
public CacheInterceptor(ICache cacheProvider)
{
_cacheProvider = cacheProvider;
}
public void Intercept(IInvocation invocation)
{
//metot için tanımlı cache flag'i var mı kontrolü yapıldığı yer
var cacheAttribute = invocation.Method.GetAttribute<CacheAttribute>();
if (cacheAttribute == null)//eğer o metot cache işlemi uygulanmayacak bir metot ise process normal sürecinde devam ediyor
{
invocation.Proceed();
return;
}
lock (_lockObject)
{
//eğer o metot cache işlemlerinin yapılması gereken bir metot ise ilk olarak dynamic olarak aşağıdaki gibi bir cacheKey oluşturuyoruz
var cacheKey = string.Concat(invocation.TargetType.FullName, ".", invocation.Method.Name, "(", JsonConvert.SerializeObject(invocation.Arguments), ")");
//bu key ile tanımlı bir cache objesi var mı kontrol ediyoruz
var cachedObj = _cacheProvider.Get(cacheKey);
if (cachedObj != null)//eğer var ise o objeyi alıp client'a return ediyoruz
{
invocation.ReturnValue = cachedObj;
}
else
{
//yok ise metottan çıktıktan sonra return edilen response'u
invocation.Proceed();
var returnValue = invocation.ReturnValue;
var response = returnValue as BaseResponse;
if (response != null)
{
//eğer o response bizim beklediğimiz gibi BaseResponse'dan türeyen bir model ise o modeli alıyoruz ve başarılı bir şekilde client'a dönülen bir response ise cache'e atıyoruz
if (response.IsSuccess)
{
var cacheExpireDate = DateTime.Now.AddSeconds(cacheAttribute.CacheDurationInSecond);
_cacheProvider.Set(cacheKey, invocation.ReturnValue, cacheExpireDate);
}
}
}
}
}
}
Yukarıdaki akışı anlatmak gerekirse;
- İlk olarak ilgili metot üzerinde bir cache flag'i var mı yok mu ona bakıyoruz. Eğer metot üzerinde tanımlı CacheAttribute'ü var ise o metot bizim için cacheinterceptor tarafından cache işlemlerine tabi tutulur demek. Yoksa hiç cache'i karıştırmadan process devam eder.
- CacheAttribute varsa sonraki adımda metot namespace + metot ismi + metot parametrelerinden oluşan bir dynamic cacheKey oluşturuluyor ve bu cacheKey ile cache provider'ınızda (redis, memory cache, vs.) daha önce tanımlanmış olup halen geçerliliği olan bir cache objesi var mı bu kontrol yapılıyor.
- Eğer varsa cache de bulunan obje return ediliyor ve GetDistrictsByCityCode metoduna girmeden client'a cevap dönülüyor.
- Eğer cache'de bulunan bir obje yoksa GetDistrictsByCityCode metoduna girip ilgili işlemleri yaptıktan sonra metottan çıkıyor. Sonrasında metodun return ettiği model BaseResponse'dan türeyen bir model ise ve IsSuccess'i true ise obje cache'e atılıyor ve daha sonra client'a dönülüyor.
Geriye son adım olarak da ilgili bağımlılıkları tanımlayıp CacheInterceptor'ını install etmek kalıyor. Aşağıdaki gibi ilk olarak interceptor'ı install ediyoruz ve sonrasında kullanmak istediğimiz LocationService için register ediyoruz.
public class ServiceInstaller : IWindsorInstaller
{
public void Install(IWindsorContainer container, IConfigurationStore store)
{
container.Register(Component.For<CacheInterceptor>().LifestyleSingleton());
container.Register(Component.For(typeof(ILocationService))
.ImplementedBy(typeof(LocationService))
.Interceptors(typeof(CacheInterceptor)));
}
}
Installer'ı container'a tanımlamak için projemizde bulunan Global.asax içerisindeki Application_Start metodu içerisinde container'ı aşağıdaki gibi ayağa kaldırıyoruz.
protected void Application_Start()
{
var container = new WindsorContainer();
container.Install(new ServiceInstaller());
container.Install(new WebApiControllerInstaller());
GlobalConfiguration.Configuration.Services.Replace(
typeof(IHttpControllerActivator),
new ApiControllerActivator(container));
GlobalConfiguration.Configure(WebApiConfig.Register);
}
Yukarıda bulunan WebApiControllerInstaller ve ApiControllerActivator daha önceki yazımızda oluşturduğumuz installer ile birebir aynıdır.
public class WebApiControllerInstaller : IWindsorInstaller
{
public void Install(IWindsorContainer container, IConfigurationStore store)
{
container.Register(Classes.FromThisAssembly()
.BasedOn<ApiController>()
.LifestylePerWebRequest());
}
}
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();
}
}
}
Projemiz hazır ve artık yazmış olduğumuz end-point'i test edebiliriz. GetDistrictsByCityCode metoduna ilk gelen request'ten sonra return edilen response cache'e atılacaktır ve CacheAttribute tanımlarken verdiğiniz cacheDuration süresi içerisindeki ikinci request'i yaptığınızda GetDistrictsByCityCode scope'ları arasındaki işlemleri yapmadan ilgili response oluşturulan cacheKey ile bulup cache'den döndüğünü göreceksinizdir.