[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


C'est bon ça !! >> MSBuild is going cross-platform with .NET Core! - http://t.co/BZuOmBxOP9

September 03, 2015 17:28

Developing #ASPNET 5 Web Apps with #VisualStudio #Code http://t.co/LexJhHbMlS

September 03, 2015 11:54

Announcing Availability of #ASPNET 5 Beta7 http://t.co/ADF7dkYSye

September 03, 2015 09:37

Announcing the Biggest VM Sizes Available in the #Cloud: New #Azure GS-VM Series http://t.co/EEF0CRWfPX

September 03, 2015 08:21

How Different Team Topologies Influence #DevOps Culture http://t.co/9qbuJyIBf0

September 02, 2015 17:28

An introduction to immutable infrastructure http://t.co/tmF9ntEqjP #DevOps

September 02, 2015 15:16

Immutable Infrastructure and Containers http://t.co/8EImSCPtzS #DevOps

September 02, 2015 13:17

Cloud, frozen pizza model and the immutable infrastructure http://t.co/OoaDtiq0oj #DevOps

September 02, 2015 12:01

Trash Your Servers and Burn Your Code: Immutable Infrastructure and Disposable Components http://t.co/g5LLgPvxy2 #DevOps

September 02, 2015 11:54

Amazon, Netflix, Google, Microsoft, Mozilla And Others Partner To Create Next-Gen Video Format http://t.co/mtfx6irVGE

September 02, 2015 09:37

Release Management vNext Plans http://t.co/da6TLhKNdX #VisualStudio #DevOps #VSO

September 02, 2015 08:21

#Microsoft announces new #Azure #ResourceManager SDKs (in preview) for #Java, #Python, #Go and #Ruby ! http://t.co/dxbpRh6q4p

September 02, 2015 07:01

#ContinuousDelivery - the missing parts http://t.co/QHg13iToLg #NDC2015

September 01, 2015 09:37

Demo: #Mesos Running a Single Cluster of #Linux and #Windows Machines http://t.co/YNiQbH33X5

September 01, 2015 08:21

Dino Esposito on CQRS, Messages and Events http://t.co/Vx1HDZvYxW

September 01, 2015 07:01