是否有任何与 AJAX 相关的属性可以为 ASP.NET MVC 控制器操作设置？

Question

我想在 ASP.NET MVC 中使用带有 AJAX 调用的部分视图，这是我第一次使用它。我只是搜索了一下是否有什么特殊的东西我应该事先知道，其中我很好奇的就是看看是否有任何特殊的属性应该设置或与 AJAX 调用相关？类似于 [ChildActionOnly] 或 [HttpGet]

Answer 1

ASP.NET MVC 提供了一个扩展方法来检查请求是否是 Ajax 请求。您可以使用它来决定是否要返回部分视图或 json 结果而不是普通视图。

if (Request.IsAjaxRequest())
{
    return PartialView("name");
}
return View();

要将操作方法​​限制为仅 Ajax 调用，您可以编写自定义属性。如果是正常请求，此过滤器将返回 404 未找到 http 异常。

[AttributeUsage(AttributeTargets.Method)]
public class AjaxOnlyAttribute : ActionFilterAttribute
{
     public override void OnActionExecuting(ActionExecutingContext filterContext)
     {
        if (!filterContext.HttpContext.Request.IsAjaxRequest())
        {
            filterContext.HttpContext.Response.StatusCode = 404;
            filterContext.Result = new HttpNotFoundResult();
        }
        else
        {
            base.OnActionExecuting(filterContext);
        }
     }
}

你可以这样使用它：

[AjaxOnly]
public ActionResult Index() {
    // do something awesome
}

Answer 2

Muhammad 答案的衍生内容，让您指定它也不能是 ajax 请求：

using System.Web.Mvc;
public class AjaxAttribute : ActionMethodSelectorAttribute
{
    public bool ajax { get; set; }
    public AjaxAttribute() { ajax = true; }
    public AjaxAttribute(bool a) { ajax = a; }
    public override bool IsValidForRequest(ControllerContext controllerContext, System.Reflection.MethodInfo methodInfo)
    {
        return ajax == controllerContext.HttpContext.Request.IsAjaxRequest();
    }
}

这可以让您执行以下操作：

[Ajax]
public PartialViewResult AjaxUpdatingPage() {
    return PartialView();
}

[Ajax(false)]
public ViewResult NotAjaxUpdatingPage() {
    return View();
}

更新 ASP.NET Core：

您将需要替换 usings和方法签名/主体具有以下内容...

using Microsoft.AspNetCore.Mvc.Abstractions;
using Microsoft.AspNetCore.Mvc.ActionConstraints;
using Microsoft.AspNetCore.Routing;
using System.Linq;

public override bool IsValidForRequest(RouteContext routeContext, ActionDescriptor action)
{
    // Using ASP.NET 6 strongly typed header:
    return ajax == routeContext.HttpContext.Request.Headers.XRequestedWith.Contains("XMLHttpRequest");
    // Older versions:
    return ajax == routeContext.HttpContext.Request.Headers.Any(h => h.Key == "X-Requested-With" && h.Value.Contains("XMLHttpRequest"));
}

Answer 3

ASP.NET MVC 3 Futures 集合中提供了一个 [AjaxOnly] 属性。它是官方 ASP.NET MVC Codeplex 网站的一部分，该网站在正式包含在未来版本中之前提供功能ASP.NET MVC 的。

您可以在此处下载它。要使用它，请添加对发布包中包含的 Microsoft.Web.Mvc 程序集的引用。

此页面，以及您可以使用的所有其他强大功能。

Answer 4

对于那些寻找 .NET Core 解决方案的人来说，这会涉及更多一些，因为 IsAjaxRequest() 不再可用。

下面是我在几个项目的生产中使用的代码，效果很好。

public class AjaxOnlyAttribute : ActionMethodSelectorAttribute
{
  public override bool IsValidForRequest(RouteContext routeContext, ActionDescriptor actionDescriptor)
  {
    if(routeContext.HttpContext.Request.Headers != null &&
      routeContext.HttpContext.Request.Headers.ContainsKey("X-Requested-With") &&
      routeContext.HttpContext.Request.Headers.TryGetValue("X-Requested-With", out StringValues requestedWithHeader))
    {
      if(requestedWithHeader.Contains("XMLHttpRequest"))
      {
        return true;
      }
    }

    return false;
  }
}

Answer 5

我的解决方案遵循 [ChildActionOnly] 实现：

public class AjaxOnlyAttribute : FilterAttribute, IAuthorizationFilter
{
    public void OnAuthorization(AuthorizationContext filterContext)
    {
        if (filterContext == null)
            throw new ArgumentNullException("filterContext");
        if (!filterContext.HttpContext.Request.IsAjaxRequest())
            throw new InvalidOperationException(string.Format(
                CultureInfo.CurrentCulture, 
                "The action '{0}' is accessible only by an ajax request.", 
                filterContext.ActionDescriptor.ActionName
            ));
    }
}

Answer 6

我认为 ajax 没有内置属性，但您可以像这样创建自己的 AjaxOnly 过滤器：

public class AjaxOnlyAttribute : ActionMethodSelectorAttribute 
{
    public override bool IsValidForRequest(ControllerContext controllerContext, System.Reflection.MethodInfo methodInfo)
    {
        return controllerContext.RequestContext.HttpContext.Request.IsAjaxRequest();
    }
}

并像这样装饰您的操作方法：

[AjaxOnly]
public ActionResult AjaxMethod()
{
   
}

另请参阅：<一个href="https://web.archive.org/web/20190111075926/http://helios.ca/2009/05/27/aspnet-mvc-action-filter-ajax-only-attribute/" rel="nofollow noreferrer">ASP.NET MVC Action Filter – Ajax Only Attribute 用于实现此目的的另一种方式