[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


Deploying a #NixOS VM on #Microsoft #Azure https://t.co/aGfkthAuL4

July 23, 2016 13:59

#Containers: Multiple Orchestrators, Multiple Clouds, What a Mess https://t.co/BGBPrgVZJf #DockerSwarm #Mesos #Kubernetes

July 22, 2016 15:21

Wow! Stack overflow documentation, I like the idea! 👍 https://t.co/X88jceIyKJ

July 21, 2016 20:26

#ASPNET Core and .NET Core Overview - https://t.co/G6hqX3xUPT #dotnet #dotnetcore

July 21, 2016 07:08

Just blogged: how to use #Azure CLI to work with @Azure #ContainerService https://t.co/F8u5IrEhaE https://t.co/TVxrK0HXro

July 21, 2016 06:36

Comment déployer @Docker #Datacenter sur la plateforme Cloud #Microsoft @Azure https://t.co/77zZhsLDQ8

July 20, 2016 09:25

Announcing #AzureStorage #Nodejs GA - https://t.co/NtP26OHtrj

July 20, 2016 08:06

Microsoft is member of the Open #Container Initiative, here's why: https://t.co/VVTipHFSVU

July 20, 2016 06:41

Super meetup @DockerParis! Merci à l'orga/sponsors + @laurentgrangeau & @guillaumebizet1 pour l'invit sur la session #DockerWindows 👍

July 19, 2016 21:04

Retours sur la #DockerCon16 par @morlhon ! #DockerMeetup @DockerParis https://t.co/Esgz4sWf58

July 19, 2016 17:16

Good news >> #Docker.DotNet is Graduating! https://t.co/wDmsyY0Bqf via @AhmetAlpBalkan

July 19, 2016 07:36

Great article about #Serverless Architectures https://t.co/j3pplMjqoF

July 19, 2016 06:53

Announcing the release of the Azure Usage and Billing Portal https://t.co/8PQPyw3jhi

July 18, 2016 08:45