[EN] [ASP.NET MVC] Custom output cache provider

September 13, 2011 -

Since ASP.NET 4 was released it’s possible to write custom output cache providers to change the way data are cached. For example, one of my customer wanted that some actions were cached on the file system to avoid loss of cache during an application pool reboot.

Be careful by using the following code because in many scenarios it can’t be used “as it is” (in a web farm, for example).

A custom output cache provider is a simple class that inherits from OutputCacheProvider and overrides these methods :

  • Add : adds an entry in the cache
  • Get : gets an entry from the cache
  • Remove : removes an entry from the cache
  • Set : updates an entry in the cache

Cached items must be serializable. In this sample, the following class will be used :

[Serializable]
public class CachedItem
{
    public object Item { get; set; }
    public DateTime UtcExpiry { get; set; }
}

In order to save an item on the file system the two following methods will be used. The first allows to get a file path from the cache key (generated by asp.net) and the second allows to save a CachedItem on the disk :

private string GetFilePathFromKey(string key)
{
    foreach (var invalidChar in Path.GetInvalidFileNameChars())
        key = key.Replace(invalidChar, '_');

    return Path.Combine(CacheDirectory, key);
}

private void SaveCachedItem(CachedItem cachedItem, string filePath)
{
    if (File.Exists(filePath))
        File.Delete(filePath);

    using (var stream = File.OpenWrite(filePath))
    {
        var binaryFormatter = new BinaryFormatter();
        binaryFormatter.Serialize(stream, cachedItem);
    }
}

The Add method :

public override object Add(string key, object entry, DateTime utcExpiry)
{
    string filePath = GetFilePathFromKey(key);
    var cachedItem = GetCachedItem(filePath);

    if (cachedItem != null && cachedItem.UtcExpiry.ToUniversalTime() <= DateTime.UtcNow)
    {
        Remove(key);
    }
    else if (cachedItem != null)
    {
        return cachedItem.Item;
    }

    SaveCachedItem(new CachedItem()
    {
        Item = entry,
        UtcExpiry = utcExpiry
    }, filePath);

    return entry;
}

The Get method :

public override object Get(string key)
{
    string filePath = GetFilePathFromKey(key);
    var cachedItem = GetCachedItem(filePath);
    if (cachedItem != null)
    {
        if (cachedItem.UtcExpiry.ToUniversalTime() <= DateTime.UtcNow)
        {
            Remove(key);
        }
        else
        {
            return cachedItem.Item;
        }
    }

    return null;
}

The Remove method :

public override void Remove(string key)
{
    string filePath = GetFilePathFromKey(key);
    if (File.Exists(filePath))
        File.Delete(filePath);
}

The Set Method :

public override void Set(string key, object entry, DateTime utcExpiry) {
    string filePath = GetFilePathFromKey(key);
    var cachedItem = new CachedItem() {Item = entry, UtcExpiry = utcExpiry};
    SaveCachedItem(cachedItem, filePath);
}

Now that the output cache provider is created, it can be registered in the web.config file of the application, in the caching section :

<system.web>
<caching>
  <outputCache>
    <providers>
      <add name="FileSystemOutputCacheProvider"
           type="Samples.FileSystemOutputCacheProvider, Samples"/>
    </providers>
  </outputCache>
</caching>

The last step consists to override the GetOutputCacheProviderName method in the Global.asax file. Actually this method is called by the ASP.NET Framework when an OutputCache attribute (or an OutputCache directive) is used. The method returns the name of the output cache provider to use in the current context. For example, if you want to use the FileSystemOutputCacheProvider for the Details action of the Products controller, you can use this code :

public override string GetOutputCacheProviderName(HttpContext context)
{
    if (context.Request.RawUrl.ToUpper().Contains("PRODUCTS/DETAILS")) {
        return "FileSystemOutputCacheProvider";
    }
    return base.GetOutputCacheProviderName(context);
}

As mentioned previously you just have to set an OutputCache attribute on the action Details of the Products controller to use the custom output cache provider :

public class ProductsController : Controller
{
    [OutputCache(Duration = 3600, VaryByParam = "id")]
    public ActionResult Details(int id)
    {
        //long operation
        Thread.Sleep(2000);

        ViewBag.ProductId = id;
        return View();
    }
}

Download the source code here.

Hope this helps Winking smile

Comments

Share

Tags


Twitter


Journey to the #Kubernetes from Legacy docker environment on #Azure with VSTS https://t.co/qUeqVMjYOb

February 25, 2017 09:57

Announcing new @Azure #Functions capabilities to accelerate development of #serverless applications https://t.co/g06gTqmpZt

February 24, 2017 10:30

Get ready for the 4 big trends in #hybrid #cloud https://t.co/QN2tDF1ISr

February 24, 2017 10:27

Announcing the first SHA1 collision https://t.co/lPuCahTbz8

February 24, 2017 08:08

The Future of #Microscaling and the Current State of #Container Deployments https://t.co/FTaUkTNlLj

February 23, 2017 07:56

#Azure #Functions Proxies public preview https://t.co/kOnHvLo9Sw #serverless #microservice

February 23, 2017 07:30

Choose between Flow, Logic Apps, Functions, and WebJobs https://t.co/SEAwKYftQ4

February 22, 2017 15:06

RT @benjiiim: #HackFest @Azure with several @euratechnologie startups this week with @cderue & @jcorioland ! https://t.co/42nlFoBJG2

February 22, 2017 10:35

RT @kubernetesio: The #Microservices Hierarchy of Needs, and the impact of Kubernetes https://t.co/F6tmKALcKe via @thenewstack by @bibryam

February 21, 2017 20:54

#Kubernetes rounds out #Azure options, paves way for #Windows Server Containers https://t.co/LOPkiP7cSI

February 21, 2017 20:51

#SQLServer 2016 Developer Edition in #Windows #Containers https://t.co/iLOlylSvvY

February 21, 2017 20:05

Containers as a Service, the foundation for next generation PaaS https://t.co/0AcN3hB1ao #Kubernetes

February 21, 2017 18:29

#Whitepaper: Deploying #Microservices and #Containers with @Azure #Container Service and DC/OS https://t.co/FkoI0R1kH9

February 21, 2017 18:25

#Kubernetes now Generally Available on #Azure #Container Service https://t.co/aaSwBnOnld

February 21, 2017 17:34

Roadmap #Linux, #Docker et stratégie open source sur @Azure https://t.co/ay4pHWigLl

February 20, 2017 10:30