[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


Setting up #Windows10 for #IoT on your #RaspberryPi 2 - http://t.co/RLzKLXqXxD

May 05, 2015 13:54

Announcing the #Microsoft #Azure #Stack - http://t.co/zsj1wCupLo

May 05, 2015 11:37

#Microsoft will release public preview of #SQLServer 2016 this summer - http://t.co/LzNiazIuvf

May 05, 2015 09:21

#Microsoft unifies cloud and in-house IT management software - http://t.co/jva7YiTnH8 #Azure #Stack

May 05, 2015 08:01

Running .NET on Linux and Mac OS X - http://t.co/pBIYjHy19z

May 04, 2015 20:28

#Microsoft Brings #Azure to the Datacenter for the Next Generation of #Hybrid Cloud - Azure in Your Datacenter - http://t.co/YZyUAoGUHK

May 04, 2015 19:16

RT @VisualStudio: Detect issues, diagnose crashes and track usage w/ free Application Insights on Azure - http://t.co/6z6sGg28Bj http://t.c

May 04, 2015 18:41

Guess What? Microsoft's Baaaack! http://t.co/FPe1ARMY34

May 04, 2015 17:17

Provisioning d’un host #Docker dans #Azure http://t.co/zpHO3REh0K

May 04, 2015 15:01

#Microsoft Project #Oxford, SDKs and APIs for natural data understanding (faces, speech, vision and languages): http://t.co/ws3GKceeeB

May 04, 2015 13:54

Very interesting session about building scalable apps with #Docker on #Microsoft #Azure: http://t.co/vvYYGar7AZ #bldwin #build2015

May 04, 2015 08:01

RT @Technet_France: Applications #Microsoft pour #Android – the BIG list par @squastana http://t.co/YaRRdSN9Fz

May 04, 2015 07:57

RT @stephgou66: Provisioning d’un host Docker dans Azure #Docker #Azure #DevOps #Cloud http://t.co/irvS5w1v2I http://t.co/xek6S7cMO0

May 04, 2015 07:57

[Build 2015] Quoi de neuf pour #Microsoft #Azure ? http://t.co/SbdyPzIJzU #bldwin #build2015 @Azure_France

May 04, 2015 07:30

RT @SantinFlo: /BUILD : Résumé détaillé des différentes annonces de l’évènement par @infinitesquare http://t.co/VTeVMrbrnQ

May 04, 2015 07:12