Asp.net Mvc Preview 5 体验--实现ActionSelectionAttribute来判断是否为AJAX请求而选择不同的Action

ActionSelectionAttribute是ASP.NET MVC Preview 5 提供的一个抽象基类，通过ActionSelectionAttribute的命名我们就可以猜想到这个Attribute是用来选择(匹配)Action方法的。该抽象类只提供了一个抽象的方法 IsValidForRequest，该方法会在Controller的ActionInvoker被调用。如果一个Action加上了该Attribute，那么只有当IsValidForRequest方法返回true的时候，当前的请求才会匹配该Action。

AcceptVerbsAttribute是ActionSelectionAttribute的一个实现，AcceptVerbsAttribute用于对不同的HttpMethod(例如"GET","POST","DELETE"等等)而选择同一Action的不同操作。

例如下面是AcceptVerbsAttribute的一个应用：

注意：两个Edit的方法签名不能一样哦。- -

这个的工作原理大概就是，添加了AcceptVerbsAttribute特性的Action都会调用IsValidForRequest()来检查当前的HTTP请求中的HTTPMethod中是否为GET或POST，如果和配置的相符，则该Action就会匹配。如果匹配的Action超过一个(例如你上面两个都设为"GET")，则会抛出异常，如果一个都没有匹配到，则会调用Controller中的HandleUnknownAction()方法来处理。

好，下面开始实现我们标题提到的问题。很简单，就是继承ActionSelectionAttribute类，并实现它的IsValidForRequest()方法，我么要暴露一个IsAjax属性来用于设定该Action是用于Ajax请求还是一般的请求：

 

public class GetByAjaxAttribute : ActionSelectionAttribute
    {
        public GetByAjaxAttribute(bool isAjax)
        {
            this.IsAjax = isAjax;
        } 

        /**//// <summary>
        /// 首先我们需要一个属性来设置该Action是用于Ajax请求还是一般的请求
        /// </summary>
        public bool IsAjax
        {
            get;
            set;
        } 

        public override bool IsValidForRequest(ControllerContext controllerContext, System.Reflection.MethodInfo methodInfo)
        {   
            //如果为Ajax请求并且设定的IsAjax为true时则返回true
            //如果不是Ajax请求并且设定的IsAjax为false时则返回true
            //其他返回false
        }
    }

 

嘿嘿，是不是觉得很简单呢，然后我们再具体实现IsValidForRequest()方法就完事了，完整代码如下，都有注释了：

 

public class GetByAjaxAttribute : ActionSelectionAttribute
    {
        public GetByAjaxAttribute(bool isAjax)
        {
            this.IsAjax = isAjax;
        } 

        /**//// <summary>
        /// 首先我们需要一个属性来设置该Action是用于Ajax请求还是一般的请求
        /// </summary>
        public bool IsAjax
        {
            get;
            set;
        } 

        public override bool IsValidForRequest(ControllerContext controllerContext, System.Reflection.MethodInfo methodInfo)
        {   
            /**/////如果是使用jQuery之类的JS框架来进行Ajax请求操作的话，可以使用下面的语句判断
            //string xhr = controllerContext.Controller.ControllerContext.HttpContext.Request.Headers["X-Requested-With"] ?? ""; 

            //这里使用的是MicrosoftAjax来进行异步请求，它会在form中添加一个"__MVCASYNCPOST"的标识，我么可以使用该标识来进行判断
            string xhr = controllerContext.Controller.ControllerContext.HttpContext.Request.Form["__MVCASYNCPOST"] ?? "";
            return !(IsAjax ^ (xhr.ToLower() == "true"));
        }
    } 

 

(对于如何标识是否为Ajax请求，你可以看我的另外一篇文章：一种标记是否为AJAX异步请求的思路)

该Attribute的使用示例如下：

 

[ActionName("Add"), AcceptVerbs("GET")]
public ActionResult AddByGet()
{
    ViewData["Message"] = "通过GET方式访问";
    return View();
} 

[ActionName("Add"), AcceptVerbs("POST"), GetByAjax(true)]
public ActionResult AddByAjax()
{
    //Do Your Thing Here
    return Content("通过AJAX的POST方式访问");
} 

//这里要加上GetByAjax(false)哦，
//否则当POST过来的时候，这个也是符合条件的，
//则会匹配两个Action(这个和上面一个)，就抛出异常了
[ActionName("Add"), AcceptVerbs("POST"), GetByAjax(false)]
public ActionResult AddByPost()
{
    //Do Your Thing here
   ViewData["Message"] = "通过POST方式访问";
    return View();
} 

 

最后是该文章的的示例代码： ActionSelectionAttributeDemo.rar

Enjoy！

 

参考文章：How a Method Becomes An Action