[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


#Nokia announces #HERE maps for #Android, launching exclusively for Samsung Galaxy smartphones with offline access http://t.co/kGXgYHCEwA

August 30, 2014 07:21

Modernizing Your Infrastructure with Hybrid Cloud: Cross-Premises Data Mobility with #Microsoft #Azure #StorSimple (… http://t.co/D2rnUU3SBJ

August 30, 2014 07:01

#ASPNET vNext - August 2014 Status Rollup http://t.co/umW9NKOdQB

August 29, 2014 08:37

Use #ADAL to Connect Your Universal Apps to #Azure AD or #ADFS http://t.co/AUxgOb4oaR

August 29, 2014 07:21

Use #SignalR to Build Real-Time Connectivity into Your Software http://t.co/kFsXiPVdXT

August 29, 2014 07:01

Could #Cosmos be #Microsoft's next commercial big-data service? http://t.co/OYvtLRI3Pc

August 28, 2014 13:17

#Microsoft’s Visual Studio Online Now Lets Developers Add Unlimited Stakeholders For Free #VSO http://t.co/LBUi5r7bpO

August 28, 2014 12:01

#Microsoft cuts #Azure #SQL cloud database prices http://t.co/i3eNPhIk3E

August 28, 2014 09:54

#Azure #BLOB Storage Part 1: Introduction http://t.co/s5fEb8w0Oh

August 28, 2014 08:37

Cycle d’exécution des directives #AngularJS http://t.co/nNZxST6Qi2

August 28, 2014 07:21

Json .NET Updates: Merge, Dependency Injection, F# and JSONPath Support http://t.co/podvLQzogL

August 28, 2014 07:01

Porting a #Windows Store App using HTML to #Cordova http://t.co/w1T6Dn973M

August 27, 2014 13:17

Data-Driven Load Tests using Visual Studio Online and #SQL #Azure http://t.co/gX6KRrvZIu

August 27, 2014 12:01

Sample App With #ASPNET Web API and #ReactJS http://t.co/tEU42LKmg5

August 27, 2014 09:54

Announcing RTM of #Katana 3 http://t.co/2LkMzlR05i

August 27, 2014 08:37