[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


Créer une application mobile avec #Cordova/#PhoneGap, #AngularJS et #Bootstrap : http://t.co/H02XrfOCNF

September 18, 2014 16:28

#Linux and #Azure Files: you might need some help here… : http://t.co/jXoGWeIczi

September 18, 2014 15:16

New Dev Center Lifetime Registration And Benefits Program : http://t.co/4S30A0Dvw1

September 18, 2014 13:17

#WinJS 3.0 is Here: Cross-browser | Cross-platform : http://t.co/bQRw0Q8Q8P

September 18, 2014 12:01

Getting the most out of #Azure in your #MSDN subscription : http://t.co/TQpqEU81uf

September 18, 2014 09:54

Gestion des exceptions des méthodes asynchrones dans une #Windows (#Phone) App : http://t.co/xZ9SXWeYFW

September 18, 2014 08:37

Using #SignalR to power #ASPNET Dashboards : http://t.co/o7LRTXksvm

September 18, 2014 07:47

#Azure #VirtualMachines Part 0: A VM Primer : http://t.co/fagMZ7DVj8

September 17, 2014 08:37

#Azure #Blob Storage Part 2: Getting Started : http://t.co/UZiefA5UDY

September 17, 2014 07:21

Learning #AngularJS by Example – The Customer Manager Application http://t.co/L2ViBfVfY4

September 17, 2014 07:01

#ActiveDirectory Authentication Library (#ADAL) v2 for .NET / #WindowsStore / #WindowsPhone – General Availability : http://t.co/UEWkwoGL6H

September 16, 2014 16:28

Using #SignalR to power #ASPNET Dashboards : http://t.co/PI8DuMr2J2

September 16, 2014 15:16

Getting started with #AngularJS and #ASPNET MVC - Part One : http://t.co/CqUqf5hcha

September 16, 2014 13:17

Creating Custom HTTPClient Handlers : http://t.co/1TfGGy5fzk

September 16, 2014 12:01

New site extension available for #Azure Web Sites: Search Portal for Azure #Search http://t.co/mBpcQwJFUC

September 16, 2014 09:54