Detecting AJAX Requests In ASP.NET MVC 6

In today’s web applications, there is an overwhelming reliance on Javascript. It's used all the time, for handling all sorts of behavior,i.e. building your entire framework, loading and manipulating DOM elements, etc.

Often, it can be useful to determine how specific requests come into your application, and, where they are originating from, because you might want to limit what your user can and cannot access via plain GET and POST requests.

IsAjaxRequest() = false;

Previously, ASP.NET MVC applications could easily check if a request was being made via AJAX, through the aptly named IsAjaxRequest() method which was an available method on the Request object, as shown below:

  1. public ActionResult YourActionName()    
  2. {  
  3.      // Check if the request is an AJAX call  
  4.      var isAjax = Request.IsAjaxRequest();  
  6.      // Do something about it.  
  7. }  
An, even, more common use-case for this might be, to build an ActionFilter that you could easily apply as an attribute that allows only AJAX-based requests to come through.
  1. [AjaxOnly]  
  2. public ActionResult YourActionName()    
  3. {  
  4.      // Omitted for brevity  
  5. }  
An older build of MVC3 had this attribute already built-in; however, if you wanted to write it yourself, you could easily use some code like the following:
  1. public class AjaxOnlyAttribute : ActionFilterAttribute    
  2. {  
  3.     public override void OnActionExecuting(ActionExecutingContext filterContext)  
  4.     {  
  5.         if (!filterContext.HttpContext.Request.IsAjaxRequest())  
  6.         {  
  7.             filterContext.Result = new HttpNotFoundResult();  
  8.         }  
  9.     }  
  10. }  
However, as one of the many sweeping changes that came across within the release of MVC6, you'll find that this method does no longer exist.

[AjaxOnly] within MVC6

The IsAjaxRequest() actually works by simply performing a check for the X-Requested-With header, as seen in the actual implementation of the function from MVC5.
  1. public static bool IsAjaxRequest(this HttpRequestBase request)    
  2. {  
  3.   if (request == null)  
  4.     throw new ArgumentNullException("request");  
  5.   if (request["X-Requested-With"] == "XMLHttpRequest")  
  6.     return true;  
  7.   if (request.Headers != null)  
  8.     return request.Headers["X-Requested-With"] == "XMLHttpRequest";  
  9.   return false;  
  10. }  
Now, since several of the context-related parameters have changed in MVC 6, the implementation of an [AjaxOnly] attribute would have to change slightly as well,  by modeling it after its predecessor.
  1. public class AjaxOnlyAttribute : ActionMethodSelectorAttribute    
  2. {  
  3.        public override bool IsValidForRequest(RouteContext routeContext, ActionDescriptor action)  
  4.         {  
  5.             return routeContext.HttpContext.Request?.Headers["X-Requested-With"] == "XMLHttpRequest";  
  6.         }  
  7. }  
And, basically, that's it. You can just throw the [AjaxOnly] attribute on any of your existing requests, and it will allow / deny them, based on if this was originated via AJAX or not.

Similar Articles