Implementing Cache Provider In One Line Of Code

The main goal is to use a Cache Provider and call Cache method by writing just one line of code. Cache Provider follows SOLID principles, so you can implement the interfaces for a different solution.

The main usage is given below.

var customer = _cacheProvider.CacheAsync(() => GetCustomer(id), id);

You can see, I called cache method in one line of code.

The cache key will be "GetCustomer" + "_" + id. For instance: "GetCustomer_100".

Cache Provider will check in cache, and if it exists in cache it will get it from cache. If it is not in cache, get it from "GetCustomer" method.

var genders = _cacheProvider.CacheAsync(() => GetGenders());

The cache key will be just "GetGenders" because it was not provided by any cache key.

Cache Provider will check at cache, and if it exists in cache, it will get it from cache. If it is not in cache, get it from "GetGenders" method.

var userName = _cacheProvider.CacheAsync(UseCacheOrNot(), () => GetUserName(_loggedUser), _loggedUser);

The cache key will be "GetUserName" + "_" + _loggedUser. For instance: "GetUserName_fabiosilvalima".

Cache Provider will check in cache only if "UseCacheOrNot" method returns true, if it returns true and exists in cache it will get it from cache. If it is not in cache, get it from "GetUserName" method.

The complete example usage in HomeController

HomeController constructor is given below.

public HomeController(IAsyncCacheProvider cacheProvider)
{
_cacheProvider = cacheProvider;
_loggedUser = "fabio silva lima"; //sample
}

HomeController Index action is given below.

public async Task<ActionResult> Index(string id = "0")
{
_dateTime = DateTime.Now;
var customer = _cacheProvider.CacheAsync(() => GetCustomer(id), id);
var genders = _cacheProvider.CacheAsync(() => GetGenders());
var userName = _cacheProvider.CacheAsync(UseCacheOrNot(), () => GetUserName(_loggedUser), _loggedUser);
await Task.WhenAll(customer, genders, userName);
var viewModel = new HomePageViewModel()
{
Customer = customer.Result,
Genders = genders.Result,
UserName = userName.Result,
Date = _dateTime
};
return View(viewModel);
}

In the code shown above, I used the async methods of Cache Provider.

Dependency Injection:

I am using Ninject to inject the dependency for "IAsyncCacheProvider" in "HomeController" constructor. I configured DI in "NinjectWebCommon.cs" file. You can also inject "ICacheProvider" for synchronous operations, if you want.

private static void RegisterServices(IKernel kernel)
{
kernel.Bind<ICache>().To<HttpRuntimeCache>();
kernel.Bind<ICacheProvider>().To<FslCacheProvider>();
kernel.Bind<IAsyncCacheProvider>().To<FslCacheProvider>();
}

Remarks:

The class "FslCacheProvider" uses "ICache" interface. It means you can write your own implementation for ICache interface. For this article, I used "HttpRuntime" of "System.Web" namespace and I implemented "ICache" in "HttpRuntimeCache" class.

The SOLID principle here is "FslCacheProvider" does not know what or where the cache is stored.

There are other methods in "IAsyncCacheProvider" and "ICacheProvider".

The last parameter of all the methods are the array of keys and it means you can provide more than one key. For instance

var customer = _cacheProvider.CacheAsync(() => GetCustomer(id, filter), id, filter);

The cache key given above will be "GetCustomer" + "_" + id + "_" + filter. For instance: "GetCustomer_100_john"

Yes, that's it. You can download the full source code and view an online demo by clicking the links given below.

Good luck.

Download full source code

github - FSL.CacheProvider

Online demo

codefinal - FSL.CacheProvider