[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


Index documents (pdf, office...) using @Azure #Search and it's new index for Azure #Blob #Storage (public previe) https://t.co/yYCdA23GCo

February 09, 2016 20:33

#Container Fundamentals | Part 5 - #HyperV Containers https://t.co/y2D4ZpjxRz via @ch9

February 09, 2016 16:16

#Container Fundamentals | Part 4 - Resource Management https://t.co/tjG00lk9wt via @ch9

February 09, 2016 14:17

#Container Fundamentals | Part 3 - Shared Folders https://t.co/fAsf01Zinn via @ch9

February 09, 2016 13:02

How to secure #containers and #microservices https://t.co/4jZsW9aMEA

February 09, 2016 12:54

"A good #PaaS needs more than #VirtualMachines to run on": https://t.co/K0zoOkVrdT #Docker #Container

February 09, 2016 09:24

My new #Dockercraft container is running on #Azure #ContainerService ! :) https://t.co/33KrpDTyIX #Docker https://t.co/unR3eEclZ5

February 09, 2016 07:33

How do you measure #DevOps? What does that even mean? - https://t.co/KXmT0g8Qtx

February 08, 2016 19:36

Announcing early preview of #Azure PaaS services and #DevOps tools for Azure #Stack - https://t.co/NGwtdRsfLJ

February 08, 2016 19:30

This week in @Azure – February 8, 2016 - https://t.co/aiOb3yfk0x

February 08, 2016 10:37

Improve your #website #accessibility with @VorlonJS and #aXe https://t.co/ew09RwNXCw

February 07, 2016 11:22

Episode 198: #Azure #ContainerService with Ross Gardler - https://t.co/aioAoEso2d @docker

February 05, 2016 19:59

The second era of #cloud platforms will dwarf the first - https://t.co/pPAFHHYOhz

February 05, 2016 19:55

Announcing @Docker #Birthday #3 - https://t.co/pjh9tzn8kO

February 05, 2016 08:58

An early look at #Azure #Stack and what it means for IT - https://t.co/OSipXhlhGC

February 05, 2016 08:57