在StackOverflow 播客 #54中，Jeff 提到他们通过处理路由的方法上方的属性在 StackOverflow 代码库中注册他们的 URL 路由。听起来是个不错的概念（Phil Haack 提出了关于路线优先级的警告）。
有人可以提供一些样本来实现这一点吗？
此外，使用这种路由风格的任何“最佳实践”？
问问题
25716 次
6 回答
62
更新：这已发布在codeplex上。完整的源代码以及预编译的程序集可供下载。我还没有时间在网站上发布文档，所以这个 SO 帖子现在就足够了。
更新：我添加了一些新属性来处理 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 的更改：
将 MapRoute 调用替换为对 RouteUtility.RegisterUrlRoutesFromAttributes 函数的一次调用：
public static void RegisterRoutes(RouteCollection routes)
{
routes.IgnoreRoute("{resource}.axd/{*pathInfo}");
RouteUtility.RegisterUrlRoutesFromAttributes(routes);
}
RouteUtility.RegisterUrlRoutesFromAttributes 的定义：
完整的源代码在codeplex上。如果您有任何反馈或错误报告，请访问该站点。
于 2009-05-21T21:10:05.380 回答
44
您还可以尝试AttributeRouting，它可以从github或通过nuget 获得。
这是一个无耻的插件，因为我是项目作者。但是，如果我不是很高兴使用它的话。你可能也是。github 存储库wiki中有大量文档和示例代码。
有了这个库，你可以做很多事情：
- 使用 GET、POST、PUT 和 DELETE 属性装饰您的操作。
- 将多个路由映射到单个操作，并使用 Order 属性对它们进行排序。
- 使用属性指定路由默认值和约束。
- 使用简单的 ? 指定可选参数 参数名称前的标记。
- 指定路由名称以支持命名路由。
- 在控制器或基本控制器上定义 MVC 区域。
- 使用应用于控制器或基本控制器的路由前缀将您的路由分组或嵌套在一起。
- 支持旧版网址。
- 在为动作定义的路由、控制器内以及控制器和基本控制器之间设置路由的优先级。
- 自动生成小写的出站 URL。
- 定义您自己的自定义路由约定并将它们应用到控制器上，以便为控制器内的操作生成路由，而无需样板属性（想想 RESTful 风格）。
- 使用提供的 HttpHandler 调试您的路由。
我敢肯定还有一些我忘记的东西。看看这个。通过nuget安装很轻松。
注意：截至 2012 年 4 月 16 日，AttributeRouting 还支持新的 Web API 基础架构。以防万一您正在寻找可以处理的东西。谢谢subkamran！
于 2011-01-17T19:12:28.360 回答
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();
}
于 2010-02-03T21:06:00.710 回答
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。这就是为什么我真的需要属性中的路由名称作为路由的实际名称。
我要做的另一件事是将默认和约束属性转换为 AttributeTargets.Parameter 以便我可以将它们粘贴到 params。
于 2009-05-25T15:50:59.613 回答
0
我已经将这两种方法组合成一个科学怪人版本，供任何想要它的人使用。（我喜欢可选的参数符号，但也认为它们应该是与默认/约束分开的属性，而不是全部混合在一起）。
http://github.com/djMax/AlienForce/tree/master/Utilities/Web/
于 2010-04-29T15:41:42.427 回答
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 中，用熟悉的UrlRoute和UrlRouteParameterDefault属性装饰 XXXXCompleted ActionResult：
[UrlRoute(Path = "ActionName/{title}")]
[UrlRouteParameterDefault(Name = "title", Value = "latest-post")]
public ActionResult ActionNameCompleted(string title)
{
...
}
希望对遇到同样问题的人有所帮助。
于 2010-07-22T14:28:16.670 回答