[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


How holograms can help NASA explore Mars - http://t.co/W4EqLU6N0o #Microsoft #HoloLens

January 27, 2015 08:21

Migration cookbook now available for the latest #Azure #SQLDatabase Update (V12) - http://t.co/6Eh5qBQZJM

January 27, 2015 08:01

How to use #Azure #ActiveDirectory in an #AngularJS / #ASPNet MVC application: http://t.co/c3uD1oxTUi

January 26, 2015 09:37

Super hackaton #Zone61 ce weekend ! Plein de projets au top et de problématiques techniques autour d'#Azure et de l'#IoT ! :-)

January 25, 2015 19:25

ne plus recevoir les data processées dans l'event hub : http://t.co/bYHFrqUJsf #Zone61

January 25, 2015 12:37

Unified #aspnet 5 - Using #MVC 6, #WEBAPI and #EntityFramework 7 in an Application: http://t.co/icYwV96iRn #vNext

January 24, 2015 14:17

Building #WebAPI using #MVC 6 & #MongoDB: http://t.co/aIGJUlrS3g #aspnet #vnext

January 24, 2015 13:01

Revisiting Partial View Rendering in #aspnet #mvc: http://t.co/7aux3byX4P

January 24, 2015 10:54

How to use #Azure #ActiveDirectory to secure your LOB #ASPNET #MVC applications ?http://t.co/5zBDhRQfhY

January 24, 2015 09:37

@Michael_Alves carrément, avec plaisir 😊

January 23, 2015 13:04

@Michael_Alves celle la et une autre sur azure media services :-)

January 23, 2015 11:18

#ASPNET 5: la révolution est en marche ! Venez en savoir plus lors des #mstechdays: http://t.co/oYrCEV1WT8

January 23, 2015 10:54

Project #Spartan and the #Windows10 January Preview Build: http://t.co/NbPy1y08vr

January 23, 2015 09:37

Running #ASPNET 5 on Linux http://t.co/z8Zebh5jo5 #VNext

January 23, 2015 08:21

Mapping #ASPNET #SignalR Connections to Real Application Users http://t.co/6NAGYNYXNf

January 23, 2015 08:01