[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


#Docker integration for #Linux is very easy using #Microsoft #Azure: http://t.co/tswC7Rq2BX

April 02, 2015 07:21

Supers retours d'expériences de Wildmoka, une startup pas orientée techno #Microsoft, qui nous parle d'#Azure: http://t.co/P8dsdKiIUg

April 02, 2015 07:01

RT @benjguin: Vous cherchez un #podcast sur la #data ? http://t.co/HTus7oObys @bigdatahebdo http://t.co/dpGPWrJbKP

April 02, 2015 06:53

Adopting Microservices: Getting Started with Implementation: http://t.co/92rQK0Wx7k #nginx

April 01, 2015 23:59

#Azure support for #Java-based applications - http://t.co/kzBQBkW3Sz

April 01, 2015 23:41

RT @Azure: Free #Azure Webinar 4/9. @CloudlinkTech & #Microsoft SMEs share #AzureVM and Data Encryption best practices. http://t.co/6hHh6Bp…

April 01, 2015 23:38

RT @VisualStudio: Need a preview of WinJS 4.0? Here you go: http://t.co/T6yg6F9Z8Q http://t.co/DA8kLtmA4R

April 01, 2015 23:38

RT @Azure: Can you scale out #documentdb across machines? Yes you can! Find out how on 4/7 http://t.co/YZugqKShmI #MSmva

April 01, 2015 23:38

RT @Azure: #AzureAppService: New tools announced for web & #mobile #app developers. via @TechCrunch http://t.co/biWv71cKrU http://t.co/mWZT…

April 01, 2015 23:37

#Chef Server in Marketplace, Chef #Azure Provisioning and more - http://t.co/cXJLlyGVRz

April 01, 2015 20:04

#WebStorm 10 Compiles #TypeScript 1.4 to #JavaScript on the Fly - http://t.co/AVrpN02EVQ

April 01, 2015 20:03

New report shows #MongoDB to be leader of the #NoSQL database pack - http://t.co/l2usqouMQN

April 01, 2015 20:02

#GitHub is back after 5 days of DDoS attacks - http://t.co/g9qrAKI3gc

April 01, 2015 16:28

First look: #Microsoft's #Azure #AppServices sweeten cloud development - http://t.co/1zkI8RpLl8

April 01, 2015 15:16

Sharepoint Online: Intégration au portail de gestion #Azure (Preview) - http://t.co/3KiOTMPpMN

April 01, 2015 08:37