[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


How Microsoft’s Brendan Burns is trying to make cloud-native app deployment as easy as coding https://t.co/kPa2mzqE9V

December 18, 2017 07:44

RT @brendandburns: Really great overview of @Azure container service! https://t.co/7fk42Ud7m5

December 14, 2017 17:40

#KubeCon 2017 Demo - Istio and Brigade CI/CD https://t.co/60uaK82fIJ

December 14, 2017 08:18

Azure #Functions CI/CD pipeline for #Nodejs using #VSTS https://t.co/3UElDsDsDL

December 14, 2017 08:13

AKS cluster upgrades and managed #Kubernetes in #Azure https://t.co/b0naeEUwl1

December 12, 2017 16:01

Microsoft Azure <3 France ! https://t.co/w4Ak8f4QWN

December 12, 2017 08:09

The future is here! The #Quantum Development Kit has been released :) https://t.co/8mSieAEbCr

December 12, 2017 07:16

A tour of #containerd 1.0 https://t.co/27jtxIu17d

December 12, 2017 07:10

Last week in Azure: OSBA, DevOps and Kubernetes, VM sizes, and more https://t.co/vq6jtWLYTq

December 12, 2017 07:08

RT @BradSmi: We believe #AI is a game changer in creating solutions to protect the planet. That’s why we’re expanding #AIforEarth. #OnePlan

December 11, 2017 13:52

WSL Interoperability with #Docker https://t.co/xtiUafCPyq

December 11, 2017 11:58

RT @jpetazzo: If you are using @docker (or are planning to) to help you in your DevOps initiatives, you might want to read this: https://t.…

December 09, 2017 12:20

RT @benjguin: Free eBook – The Developer’s Guide to Microsoft Azure now available https://t.co/z9VeGYRDQy https://t.co/V0ozQPJllh

December 08, 2017 08:08

Check out the new #Azure Application Architecture Guide https://t.co/M3wIQfkRhi

December 08, 2017 07:53

What’s brewing in Visual Studio Team Services: December 2017 Digest https://t.co/jL8yNATyJR

December 08, 2017 07:51