[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


.@FredericWickert nous présente une archi full #PaaS dans @Azure ! @ArollaFr https://t.co/saXb2JsUAu

December 06, 2016 20:54

#Jenkins pipeline continuous deployment of a #Java application in @Azure #AppService w/ @jpbriend https://t.co/jpVEfd1MwE

December 06, 2016 20:07

What’s new upcoming in #Docker #Compose v1.9.0? https://t.co/ME15cFHHAh

December 06, 2016 08:30

#howto -> NoSQL #dotnetcore development using an local @Azure DocumentDB Emulator https://t.co/sJpwzIiymP

December 05, 2016 18:37

Want to know more about #VisualStudio #MobileCenter? Check this new @CloudCoverShow episode! https://t.co/3hVZ0tk7Bz

December 05, 2016 18:36

A #Kafka connector is now available for @Azure #IoT Hub https://t.co/pDWKuWizoo

December 05, 2016 18:33

Running #Azure "Functions Locally with the CLI and VS @Code https://t.co/7nou4YYAUm #serverless

December 05, 2016 18:31

Yey! #VisualStudio Tools for @Azure #Functions!! https://t.co/E5DaIs4jJb

December 01, 2016 19:45

From “A PC on every desktop” to “Deep Learning in every software” https://t.co/8mOOdjO9kM

December 01, 2016 08:44

Full CI/CD pipeline with @Docker #Swarm on #Azure #ContainerService #DevOps @VSTeam https://t.co/UHeBBxSaHz

November 30, 2016 20:50

@sandayuu thanks ;-)

November 30, 2016 06:37

@lamouetterieuse ni l'un ni l'autre :)

November 29, 2016 19:08

Just blogged: full CI/CD pipeline to deploy a multi-containers application on @Azure #ContainerService with #VSTShttps://t.co/PEAxL13eRf

November 29, 2016 18:16

Announcing #Azure #DevTest Labs support for creating environment with ARM templates https://t.co/AzCCuRZSqZ

November 29, 2016 09:52

Les conteneurs @Docker sous #Windows, accélérateurs de votre démarche #DevOps https://t.co/QecTyHY1hc

November 28, 2016 12:16