[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


#Kubernetes for Edge Computing: The Microsoft #Azure Approach https://t.co/D6pGrqIBKm

May 25, 2018 05:52

#Azure the cloud for all – highlights from Microsoft BUILD 2018 https://t.co/TH5poYxV0D

May 25, 2018 05:44

RT @satyanadella: @EmmanuelMacron Honored to join the #TechforGood Summit with @EmmanuelMacron. Collectively we have a responsibility to en…

May 23, 2018 15:44

@IOI__655321 @StravaSupport It would be nice if the sync was working all the time and does not take 5+ hours to app… https://t.co/YFOaVCMNRS

May 20, 2018 15:41

RT @brendandburns: More container wisdom from @jessfraz This time in multitenant kubernetes! Really great stuff. https://t.co/Y8xD3qWnVO

May 19, 2018 06:40

RT @Tyriar: VS @code tip: Turn VS Code into a quick notepad with highlighting by adding `"files.defaultLanguage": "markdown"` to your setti…

May 18, 2018 13:45

RT @brendandburns: Great article on how @azure is delivering on the vision of an intelligent edge for IoT via containers, kubernetes and th…

May 17, 2018 06:27

This is really awesome. #SurfaceHub2 https://t.co/HOhrMcRBBp

May 15, 2018 17:05

@benjiiim WOW!

May 15, 2018 17:03

#Azure confidential computing https://t.co/gSuQekTNrb

May 15, 2018 17:03

Azure #Kubernetes Service now has built-in http ingress application routing using #Azure DNS Zone -> https://t.co/tXuAC0cMEa

May 14, 2018 09:01

@lamouetterieuse Ce n'est pas avec docker compose mais il y a une notion de container group avec ACI: https://t.co/G4GLsfjGKP

May 11, 2018 19:57

#Azure SignalR Service, a fully-managed service to add real-time functionality https://t.co/wLiDQveigC

May 11, 2018 17:28

Virtual Network Service Endpoints for Azure #CosmosDB is now generally available https://t.co/ahJT2KnimD

May 11, 2018 16:18

Multi-container on #Azure #Linux Web App, w/ #docker compose and #Kubernetes manifests support! https://t.co/p4tiCPFH67

May 11, 2018 14:40