Conditional Cache using OutputCacheAttribute in Asp.net MVC 4

Question

I am trying to implement Output caching for my action results.

In my actions depending upon some business rules response is returned. In my response I send error code. I do not want to cache the response if there is any error.

Following in the Action Result

  class Response 
  {
    public int ErrorCode { get; set; }
    public string Message { get; set; }

}


    [OutputCache(CacheProfile = "Test")]
    public ActionResult Sample()
    {
        Response response = new Response();
        return new JsonResult { Data = response, JsonRequestBehavior = JsonRequestBehavior.AllowGet };
    }

I want cache the Result only if ErrorCode==0.

I tried overriding OutputCache, but it is not working

 public class CustomOutputCacheAttribute : OutputCacheAttribute
    {
        public override void OnActionExecuted(ActionExecutedContext filterContext)
        {

            if (filterContext.Result is JsonResult)
            {
                var result = (JsonResult)filterContext.Result;
                BaseReponse response = result.Data as BaseReponse;
                if (!response.IsSuccess)
                {
                    filterContext.HttpContext.Response.Cache.SetNoStore();
                }
                base.OnActionExecuted(filterContext);
            }
        }


    }

Is there any other way or approach to achieve this.

Thanks

Overriding OutputCacheAttribute is the correct way of doing it. You can also cache the response object manually inside your action method. — Davor Zlotrg
– Davor Zlotrg, Commented Feb 18, 2015 at 9:08
Why are you implementing your own error response objects? OutputCache has built-in support for normal HTTP errors... — Moeri
– Moeri, Commented Feb 18, 2015 at 9:20

Davor Zlotrg · Accepted Answer · 2015-02-18 10:08:54Z

3

You can create your own custom attribute that will ignore [OutputCache] based on the result error code, something like this:

[OutputCache(Duration=60, VaryByParam="none")]
[OutputCacheValidation]
public ActionResult Sample()
{
    var r = new Response();
    r.ErrorCode = 0;  
    return Json(r, JsonRequestBehavior.AllowGet);
}

public class OutputCacheValidationAttribute : ActionFilterAttribute
{
    public override void OnResultExecuting(ResultExecutingContext filterContext)
    {
        base.OnResultExecuting(filterContext);
        filterContext.HttpContext.Response.Cache.AddValidationCallback(ValidatioCallback, filterContext.Result);
    }

    private static void ValidatioCallback(HttpContext context, object data, ref HttpValidationStatus validationStatus)
    {
        var jsonResult = data as JsonResult;
        if (jsonResult == null) return;

        var response = jsonResult.Data as Response;
        if (response == null) return;

        if (response.ErrorCode != 0)
        {
            //ignore [OutputCache] for this request
            validationStatus = HttpValidationStatus.IgnoreThisRequest;
            context.Response.Cache.SetNoServerCaching();
            context.Response.Cache.SetNoStore();
        }
    }
}

answered Feb 18, 2015 at 10:08

Davor Zlotrg

6,0602 gold badges35 silver badges53 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Ashwani K Over a year ago

Thanks, however it is still saving the data to cache but while serving it does the validation. I wanted to not store data at all in cache if error occurs

Ashwani K Over a year ago

I got the idea from your code and juristr.com/blog/2012/10/output-caching-in-aspnet-mvc. Now it is working. Thanks

Collectives™ on Stack Overflow

Conditional Cache using OutputCacheAttribute in Asp.net MVC 4

1 Answer 1

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related