[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


#Microsoft Announces #Azure Authenticator App For iOS, Android And Windows Devices - http://t.co/bEnZUs0ze1

July 02, 2015 20:28

Here’s How Microsoft Will Release Windows 10 - http://t.co/XXLH5jpk5X

July 02, 2015 19:16

Inside #Azure #Search: #Chaos Engineering - http://t.co/XT9PvxMS08

July 02, 2015 17:17

#Microsoft streamlines #hybrid #cloud operations with new tools - http://t.co/KZB3YJS8bE

July 02, 2015 15:01

ASPNET Community Standup - June 30, 2015 - http://t.co/vBZkTpostJ

July 02, 2015 13:54

#Microsoft delivers new #hybrid #cloud management innovation - http://t.co/RipqqoxJAB

July 02, 2015 11:37

http://t.co/YyNLp7bkKz: Augmenting Virality in Real Time with Batch Analytics using Data Factory - http://t.co/rcNe4Q7MMa #Azure

July 02, 2015 09:21

#Agile software development with #Azure #AppService http://t.co/JJYaLwDduA

July 02, 2015 08:01

Microsoft Virtual Academy: Exploring #Microservices in #Docker and #Microsoft #Azure - http://t.co/5BzTQkI6qS

July 01, 2015 20:28

#Azure #SQL DB Previews Elastic Database Query - http://t.co/boOpchvcYn

July 01, 2015 19:16

#DockerCon Day 1 Keynote: http://t.co/WtzFmmaxzj #Docker

July 01, 2015 17:17

AspNet 5 Beta 5 is here ! http://t.co/4ClMtt23Gu

July 01, 2015 08:01

The Evolving Role of the Managed Service Provider - http://t.co/hjyWStbHZr

June 30, 2015 19:16

Running #Docker Containers on #Microsoft #Azure http://t.co/97RzLcE68e

June 30, 2015 17:17

#Windows10 PC build 10158 pushed to the Fast ring with #Microsoft #Edge branding in tow - http://t.co/JhJBWSAyod

June 30, 2015 09:21