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

September 13, 2011 - 11:42:00

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


Google, Microsoft and Facebook launch $3.6 million project to stop the next Heartbleed | The Verge http://t.co/CNDfardTWi

April 24, 2014 15:16

#repos #calme #weekend @ Plage La Corniche http://t.co/XCcnJsPlIR

April 24, 2014 15:01

Windows #Azure PaaS ACLs Are Here! - http://t.co/aHXGR6gOn2

April 24, 2014 13:17

Why #Katana should be on your radar - http://t.co/eUL69dH1hR

April 24, 2014 12:01

#Azure Websites and wildcard domains - http://t.co/3OgsgZps4D

April 24, 2014 09:54

Using Office 365 APIs in your MVC and Windows 8.1 Applications – Part II - http://t.co/SPVx2QJBWR

April 24, 2014 08:37

8 #HTML Elements You're Not Using (and Should Be) http://t.co/Ra2pxsn1c4

April 24, 2014 07:21

Programmatically upload and configure a SSL certificate for an #Azure Cloud Service Deployment - http://t.co/MPxAeiKRk2

April 24, 2014 07:01

Authentication Protocols, Web UX and Web API - http://t.co/6SZ2bthBsk

April 23, 2014 07:01

Calling Office365 API from a #WindowsPhone 8.1 App - http://t.co/Z9WSbhxRhi

April 17, 2014 07:01

Microsoft experiments with making Windows Live Tiles interactive : http://t.co/RsgrOemzd4

April 12, 2014 15:16

RT @bradygaster: Microsoft Azure Websites: Full Support for Wildcard DNS and SSL http://t.co/s6qmxXBv65 via @scottcate

April 12, 2014 10:21

Microsoft's new Cloud and Enterprise chief Guthrie on his new job, top priorities : http://t.co/yscyzui5yP

April 12, 2014 07:21

Introducing Windows Phone 8.1 : http://t.co/9uvJGE9fKN

April 12, 2014 07:01

Microsoft Azure Updates : http://t.co/uojPozy6wQ

April 11, 2014 16:28