[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


RT @Technet_France: #SaveTheDate les 4 & 5 Octobre, les #mstechdays reviennent, ils s’appellent #experienceshttps://t.co/3RFVbSADyt https…

June 25, 2016 08:23

@jayanti_sharma @SopraSteria_fr thank you for the feedback :)

June 25, 2016 08:16

RT @rgardler: New Tools and Techniques for Managing and Monitoring Mesos https://t.co/HiZQg6CNmu

June 24, 2016 16:11

RT @armymapguy: .@Esri is tapping #Azure Container Service & Mesosphere DCOS to go big.Very big.Like NYC big! @FortuneMagazine big. https:/…

June 24, 2016 16:10

How to run #Docker #Datacenter on @Azure https://t.co/yn2GxVq3dp

June 24, 2016 12:05

#DevOps: Effective Patterns for #FeatureFlags https://t.co/boexFoBlxG

June 24, 2016 09:47

Preview of #ServiceFabric on #Linux https://t.co/raUwT2jy7H #microservices

June 24, 2016 09:44

Two more things to keep your costs on track in #Azure #DevTest Labs https://t.co/lHLJ5YA6jt

June 24, 2016 09:35

RT @Taylorb_msft: #DockerCon Slides - Docker/Windows Internals https://t.co/7n5j5wtCHr https://t.co/PintnDC5Lv

June 23, 2016 06:24

First steps with @Azure #ContainerService https://t.co/Xv6sgNuWAo via @fdibot

June 22, 2016 20:36

RT @chanezon: #DockerCon @markrussinovich @SQLServer Linux in a container orchestrated by Docker Datacenter on Azure Stack - Wow! https://t…

June 22, 2016 08:57

RT @jpetazzo: "docker run --isolation=hyperv" #dockercon https://t.co/wZE3vqGrWb

June 22, 2016 08:56

@laurentgrangeau done :)

June 22, 2016 05:34

@laurentgrangeau no I'm not! For Experiences, send me a DM :-) enjoy DockerCon!

June 22, 2016 05:21

RT @docker: .@SQLServer on @Linux in #container on #swarm cluster across @Azure Cloud +on-prem w/ @docker #datacenter #DockerCon https://t.…

June 21, 2016 19:45