[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


Mobile Apps for Web Developers : http://t.co/hZwoshOdYd #Cordova

October 21, 2014 07:01

Microsoft #Azure #ActiveDirectory – Part 2 (MFA) - http://t.co/D6MgZabOht

October 20, 2014 07:21

How to Disable SSL 3.0 in #Azure Websites, Roles, and Virtual Machines - http://t.co/zjCof87oRD

October 20, 2014 07:01

RT @MVPAward: Develop a blog using ASPNET vNext, Azure, DocumentDB and Search services from http://t.co/k8a0opUeI0 MVP @jcorioland http://t…

October 17, 2014 21:20

Statya Nadella's talk about what's next for #Microsoft's #cloud on October 20 will be webcast live : http://t.co/leXa7TVC3k

October 17, 2014 09:54

It's also possible to use #Azure #DocumentDB in a #MobileService. Here is an how-to : http://t.co/8U4OC8srpq

October 17, 2014 08:37

Did you know you can use #Azure to send push notifications to mobile devices, including #iOS ? http://t.co/HTkDRvDBiU

October 17, 2014 07:21

#Microsoft announces #VS2013 update 4 RC with a lot of new cool stuff for #aspnet and #azure #website : http://t.co/LkJTUP6lqm, try it now !

October 17, 2014 07:01

#Azure #ActiveDirectory Part 1: An Introduction : http://t.co/5tJ6aJB5hR

October 16, 2014 07:01

Ireland closing a tax loophole that saved billions for Apple, Google, and Facebook http://t.co/RBsgqfX7SI

October 15, 2014 07:01

#Azure #MediaServices Explorer http://t.co/fgCzcadmj7

October 13, 2014 13:17

The story behind _references.js : http://t.co/Klx3x1vnok

October 11, 2014 08:15

Deploy to #Azure direct from #Github with "The Deploy to Azure Button" : http://t.co/0xBKgpJ7l4

October 10, 2014 12:01

The tool you need when working with #Azure #MediaServices ! Azure Media Services Explorer : http://t.co/ShvKr99F0n

October 10, 2014 07:01

The use of #Azure AD Behind “Deploy to Azure” : http://t.co/uIOYmaCus7

October 09, 2014 09:54