[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 @FredericWickert: Microsoft and #AI for #developers https://t.co/AsivUypQ1v

June 23, 2017 20:37

RT @VaheMicrosoft: Les services Cloud Microsoft localisés ds des datacenters à Paris et Marseille plébiscités par l’écosystème français htt…

June 23, 2017 17:56

#Java: Manage Azure #ContainerService, #CosmosDB, Active Directory #Graph and more https://t.co/C8Qv0rASTl

June 23, 2017 06:49

RT @pierlag: Vous avez aimé #experiences? Ne manquez pas #experiences17, 3&4 octobre 2017 au Palais des Congrès! Inscriptions https://t.co

June 23, 2017 06:10

RT @gabrtv: .NET Core support added to #Draft care of the good folks @cloudbaseit 👏https://t.co/LjUSp0uXMi

June 22, 2017 20:17

Inside Microsoft's #AI Comeback https://t.co/dMJldLxrRy

June 22, 2017 20:04

#DevOps w/ #Containers: CI/CD of Containers from #VisualStudio to #ServiceFabric https://t.co/2VJh9o5Hqh

June 22, 2017 11:54

How Microsoft Is Shifting Focus to Open Source https://t.co/PMONdSbHJn

June 22, 2017 09:37

#DevOps w/ #Containers: Mesosphere DCOS, Azure, Docker, VMware and everything between – Architecture and CI/CD Flow… https://t.co/w0FCPUjs7P

June 22, 2017 08:21

#GDPR Questions? #Azure has answers. https://t.co/3xlQ8WSKyQ

June 22, 2017 07:01

Enable client side monitoring in #Azure with #ApplicationInsights https://t.co/sLcoQG51JS

June 22, 2017 06:43

ASOS: How they migrated from local monolith to #microservices in #Azure https://t.co/cxZxwgtm4g

June 22, 2017 06:36

Modernizing Traditional Applications with @Docker on #WindowsServer and @Azure https://t.co/IK9eYhWmuz

June 21, 2017 09:36

Hackons l’intelligence artificielle à Microsoft experiences’17 https://t.co/a77Ni5Ne0M

June 21, 2017 07:53