[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


#Azure Management Libraries for .NET generally available now https://t.co/PaHv1iVQJn #dotnet

April 27, 2017 19:11

RT @matvelloso: New Microsoft Bot Framework developer documentation: https://t.co/cNruPer14N

April 27, 2017 03:45

Azure management libraries for Java generally available now https://t.co/sV1rAFoqJk

April 25, 2017 18:45

Did you know that you can use @Azure #ServiceFabric on #Linux + @Docker to host a HA #Minecraft server? :-)… https://t.co/poymU7pvQD

April 24, 2017 09:37

@lamouetterieuse oui !

April 24, 2017 09:20

@lamouetterieuse ahah, merci ! je remonte la coquille :)

April 24, 2017 09:15

Ne manquez pas le workshop sur les #Containers chez Microsoft le 15 Juin ! https://t.co/AeONjy1vhf #Docker

April 24, 2017 08:17

Vous voulez en savoir plus sur les architectures cloud #Serverless ? Ne manquez pas cet événement le 2 Mai à 14h: https://t.co/xDwQXpHH8J

April 24, 2017 08:15

RT @JeanLucBoucho: 6 #GlobalAzure bootcamps @AZUGFR in #France are now closed, giving you the relay ! cc @MUGStrasbourg @MUGLyon @CMDComm h…

April 22, 2017 18:07

C'est l'heure de la pause déjeuner au #GlobalAzure Bootcamp #Strasbourg ! https://t.co/1UYBGc3BlQ

April 22, 2017 11:05

Stockage dans @Azure à #GlobalAzure #Strasbourg ! https://t.co/NMv9X4rYLG

April 22, 2017 09:54

Mobile #DevOps au #GlobalAzure Bootcamp #Strasbourg ! https://t.co/3RxdgqzLd8

April 22, 2017 09:01

RT @kvnpoirot: Fin de la keynote de @jcorioland. Merci pour cette conférence ! https://t.co/BTkFZI9Zjz

April 22, 2017 08:54

C'est parti pour le #GlobalAzure Bootcamp 2017 à #Strasbourg ! @MUGStrasbourg @AZUGFR @SUPINFO_Stras https://t.co/kKcZZUeUWl

April 22, 2017 07:35

Announcing #Azure Time Series Insights https://t.co/ApZlmhDBuK #IoT #Cloud

April 21, 2017 09:31