ASP.NET MVC路由通过方法属性

时间:2009-05-21 19:50:01

标签: asp.net-mvc routing url-routing decorator

StackOverflow Podcast #54中,Jeff提到他们通过处理路由的方法上方的属性在StackOverflow代码库中注册其URL路由。听起来像一个很好的概念(菲尔哈克提出的关于路线优先权的警告)。

有人可以提供一些样本来实现这一目标吗?

此外,使用这种路由方式的任何“最佳做法”?

6 个答案:

答案 0 :(得分:62)

更新 :这已发布在codeplex上。完整的源代码以及预编译的程序集可供下载。我还没有时间在网站上发布文档,所以这篇SO帖子现在已经足够了。

UPDATE :我添加了一些新属性来处理1)路由排序,2)路由参数约束,以及3)路由参数默认值。以下文字反映了此次更新。

我实际上已经为我的MVC项目做了类似的事情(我不知道Jeff是如何使用stackoverflow进行的)。我定义了一组自定义属性:UrlRoute,UrlRouteParameterConstraint,UrlRouteParameterDefault。它们可以附加到MVC控制器操作方法,以使路由,约束和默认值自动绑定到它们。

使用示例:

(注意这个例子有点人为,但它演示了这个特征)

public class UsersController : Controller
{
    // Simple path.
    // Note you can have multiple UrlRoute attributes affixed to same method.
    [UrlRoute(Path = "users")]
    public ActionResult Index()
    {
        return View();
    }

    // Path with parameter plus constraint on parameter.
    // You can have multiple constraints.
    [UrlRoute(Path = "users/{userId}")]
    [UrlRouteParameterConstraint(Name = "userId", Regex = @"\d+")]
    public ActionResult UserProfile(int userId)
    {
        // ...code omitted

        return View();
    }

    // Path with Order specified, to ensure it is added before the previous
    // route.  Without this, the "users/admin" URL may match the previous
    // route before this route is even evaluated.
    [UrlRoute(Path = "users/admin", Order = -10)]
    public ActionResult AdminProfile()
    {
        // ...code omitted

        return View();
    }

    // Path with multiple parameters and default value for the last
    // parameter if its not specified.
    [UrlRoute(Path = "users/{userId}/posts/{dateRange}")]
    [UrlRouteParameterConstraint(Name = "userId", Regex = @"\d+")]
    [UrlRouteParameterDefault(Name = "dateRange", Value = "all")]
    public ActionResult UserPostsByTag(int userId, string dateRange)
    {
        // ...code omitted

        return View();
    }

UrlRouteAttribute的定义:

/// <summary>
/// Assigns a URL route to an MVC Controller class method.
/// </summary>
[AttributeUsage(AttributeTargets.Method, Inherited = true, AllowMultiple = true)]
public class UrlRouteAttribute : Attribute
{
    /// <summary>
    /// Optional name of the route.  If not specified, the route name will
    /// be set to [controller name].[action name].
    /// </summary>
    public string Name { get; set; }

    /// <summary>
    /// Path of the URL route.  This is relative to the root of the web site.
    /// Do not append a "/" prefix.  Specify empty string for the root page.
    /// </summary>
    public string Path { get; set; }

    /// <summary>
    /// Optional order in which to add the route (default is 0).  Routes
    /// with lower order values will be added before those with higher.
    /// Routes that have the same order value will be added in undefined
    /// order with respect to each other.
    /// </summary>
    public int Order { get; set; }
}

UrlRouteParameterConstraintAttribute的定义:

/// <summary>
/// Assigns a constraint to a route parameter in a UrlRouteAttribute.
/// </summary>
[AttributeUsage(AttributeTargets.Method, Inherited = true, AllowMultiple = true)]
public class UrlRouteParameterConstraintAttribute : Attribute
{
    /// <summary>
    /// Name of the route parameter on which to apply the constraint.
    /// </summary>
    public string Name { get; set; }

    /// <summary>
    /// Regular expression constraint to test on the route parameter value
    /// in the URL.
    /// </summary>
    public string Regex { get; set; }
}

UrlRouteParameterDefaultAttribute的定义:

/// <summary>
/// Assigns a default value to a route parameter in a UrlRouteAttribute
/// if not specified in the URL.
/// </summary>
[AttributeUsage(AttributeTargets.Method, Inherited = true, AllowMultiple = true)]
public class UrlRouteParameterDefaultAttribute : Attribute
{
    /// <summary>
    /// Name of the route parameter for which to supply the default value.
    /// </summary>
    public string Name { get; set; }

    /// <summary>
    /// Default value to set on the route parameter if not specified in the URL.
    /// </summary>
    public object Value { get; set; }
}

对Global.asax.cs的更改:

只需调用RouteUtility.RegisterUrlRoutesFromAttributes函数,即可将对MapRoute的调用替换为:

    public static void RegisterRoutes(RouteCollection routes)
    {
        routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

        RouteUtility.RegisterUrlRoutesFromAttributes(routes);
    }

RouteUtility.RegisterUrlRoutesFromAttributes的定义:

codeplex上有完整的来源。如果您有任何反馈或错误报告,请访问该网站。

答案 1 :(得分:44)

您还可以尝试使用AttributeRoutinggithub提供的nuget

这是一个无耻的插件,因为我是项目作者。但是,如果我不是很高兴使用它。你可能也是。 github存储库wiki中有大量文档和示例代码。

使用这个库,你可以做很多事情:

  • 使用GET,POST,PUT和DELETE属性装饰您的操作。
  • 将多个路线映射到单个操作,并使用Order属性对其进行排序。
  • 使用属性指定路由默认值和约束。
  • 用简单的方法指定可选参数?参数名称前的标记。
  • 指定支持命名路由的路由名称。
  • 在控制器或基本控制器上定义MVC区域。
  • 使用应用于控制器或基本控制器的路由前缀将路由组合或嵌套在一起。
  • 支持旧网址。
  • 在控制器内以及控制器和基本控制器之间设置为操作定义的路由之间的路由优先级。
  • 自动生成小写的出站网址。
  • 定义您自己的自定义路由约定并将其应用于控制器,以便在没有样板属性的情况下为控制器内的操作生成路径(请考虑RESTful样式)。
  • 使用提供的HttpHandler调试路由。

我确信还有其他一些我忘了的东西。看看这个。通过nuget安装很容易。

注意:截至4月16日,AttributeRouting还支持新的Web API基础架构。以防您正在寻找可以处理的内容。 Thanks subkamran

答案 2 :(得分:9)

<强> 1。下载RiaLibrary.Web.dll并在ASP.NET MVC网站项目中引用它

<强> 2。使用[Url]属性解压缩控制器方法:

public SiteController : Controller
{
    [Url("")]
    public ActionResult Home()
    {
        return View();
    }

    [Url("about")]
    public ActionResult AboutUs()
    {
        return View();
    }

    [Url("store/{?category}")]
    public ActionResult Products(string category = null)
    {
        return View();
    }
}
顺便说一下,'?'登录'{?category}'参数意味着它是可选的。您不需要在路由默认值中明确指定它,这等于:

routes.MapRoute("Store", "store/{category}",
new { controller = "Store", action = "Home", category = UrlParameter.Optional });

第3。更新Global.asax.cs文件

public class MvcApplication : System.Web.HttpApplication
{
    public static void RegisterRoutes(RouteCollection routes)
    {
        routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

        routes.MapRoutes(); // This does the trick
    }

    protected void Application_Start()
    {
        RegisterRoutes(RouteTable.Routes);
    }
}

如何设置默认值和约束?例如:

public SiteController : Controller
{
    [Url("admin/articles/edit/{id}", Constraints = @"id=\d+")]
    public ActionResult ArticlesEdit(int id)
    {
        return View();
    }

    [Url("articles/{category}/{date}_{title}", Constraints =
         "date=(19|20)\d\d-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])")]
    public ActionResult Article(string category, DateTime date, string title)
    {
        return View();
    }
}

如何订购?例如:

[Url("forums/{?category}", Order = 2)]
public ActionResult Threads(string category)
{
    return View();
}

[Url("forums/new", Order = 1)]
public ActionResult NewThread()
{
    return View();
}

答案 3 :(得分:3)

这篇文章只是为了扩展DSO的答案。

在将路由转换为属性时,我需要处理ActionName属性。所以在GetRouteParamsFromAttribute中:

ActionNameAttribute anAttr = methodInfo.GetCustomAttributes(typeof(ActionNameAttribute), false)
    .Cast<ActionNameAttribute>()
    .SingleOrDefault();

// Add to list of routes.
routeParams.Add(new MapRouteParams()
{
    RouteName = routeAttrib.Name,
    Path = routeAttrib.Path,
    ControllerName = controllerName,
    ActionName = (anAttr != null ? anAttr.Name : methodInfo.Name),
    Order = routeAttrib.Order,
    Constraints = GetConstraints(methodInfo),
    Defaults = GetDefaults(methodInfo),
});

我也发现路线的命名不合适。该名称是使用controllerName.RouteName动态构建的。但我的路由名称是控制器类中的const字符串,我使用这些const也调用Url.RouteUrl。这就是为什么我真的需要属性中的路由名称作为路由的实际名称。

我要做的另一件事是将default和constraint属性转换为AttributeTargets.Parameter,以便我可以将它们粘贴到params。

答案 4 :(得分:0)

我需要使用AsyncController让ITCloud路由在asp.net mvc 2中工作 - 为此,只需在源代码中编辑RouteUtility.cs类并重新编译。你必须从第98行的行动名称中删除“已完成”

// Add to list of routes.
routeParams.Add(new MapRouteParams()
{
    RouteName = String.IsNullOrEmpty(routeAttrib.Name) ? null : routeAttrib.Name,
    Path = routeAttrib.Path,
    ControllerName = controllerName,
    ActionName = methodInfo.Name.Replace("Completed", ""),
    Order = routeAttrib.Order,
    Constraints = GetConstraints(methodInfo),
    Defaults = GetDefaults(methodInfo),
    ControllerNamespace = controllerClass.Namespace,
});

然后,在AsyncController中,使用熟悉的UrlRouteUrlRouteParameterDefault属性修饰XXXXCompleted ActionResult:

[UrlRoute(Path = "ActionName/{title}")]
[UrlRouteParameterDefault(Name = "title", Value = "latest-post")]
public ActionResult ActionNameCompleted(string title)
{
    ...
}

希望能帮助有同样问题的人。

答案 5 :(得分:0)

我已经将这两种方法合并为一个弗兰肯斯坦版本,适合任何想要它的人。 (我喜欢可选的param表示法,但也认为它们应该是默认/约束的单独属性,而不是全部混合成一个)。

http://github.com/djMax/AlienForce/tree/master/Utilities/Web/