[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


A year of #Azure : http://t.co/wwSRM5NSRG #2014

December 22, 2014 13:01

Announcing General Availability of Mobile Offline Sync Managed SDK - http://t.co/KakKKPIbxB #Azure

December 21, 2014 09:37

#Microsoft #Azure #Diagnostics Part 4: Custom Logging Components and Azure Diagnostics 1.3 Changes - http://t.co/Fy7XX9XyVV

December 21, 2014 08:21

Exemple d’une directive #AngularJS utilisant la phase compile - http://t.co/K9IByIkkoG

December 21, 2014 08:01

@UbiJustin Since the 1.4 patch of AC Unity (PC) I can't play anymore : the game crashes at launch on come back to the desktop... Any idea ?

December 19, 2014 08:20

@assassinscreed AC Unity crashes at launch (not responding) since patch 1.4 has been installed (PC, Steam). I can't play anymore...

December 19, 2014 08:12

#Microsoft: We have more than 1.5 million #Windows 10 'Insiders' http://t.co/RoCXqgy3JJ

December 19, 2014 08:01

@AssassinsFR depuis l'installation du patch 1.4 d'AC Unity le jeu crash au lancement sur PC... Systématiquement... Impossible de jouer !!

December 19, 2014 08:00

#Docker – a reading list http://t.co/qUGAedDybV

December 18, 2014 17:28

Active Directory from on-premises to the cloud – #Azure AD whitepapers http://t.co/utieQxOfxr

December 18, 2014 16:16

#ASPNET #MVC 5.2.3, #WebPages 5.2.3 and #WebAPI 5.2.3 Beta releases http://t.co/MSQALH5bGb

December 18, 2014 14:17

Secure #ASP.NET #WebAPI using API Key Authentication – HMAC Authentication http://t.co/aZ6x480Rfq

December 18, 2014 13:01

2015 Technology Trends: Internet of Things and #DevOps : http://t.co/WrFe1grkm3 #IoT

December 18, 2014 10:54

Final Root Cause Analysis and Improvement Areas: Nov 18 #Azure #Storage Service Interruption: http://t.co/sXX3D6c521

December 18, 2014 09:37

#Azure #Backup – Announcing Support for Windows Client Operating System

December 17, 2014 08:01