路由模式VS个别路线 [英] Route patterns vs individual routes
问题描述
目前我有一个控制器,它看起来是这样的:
Currently I have a controller which looks something like this:
public class MyController : Controller
{
public ActionResult Action1 (int id1, int id2)
{
}
public ActionResult Action2 (int id3, int id4)
{
}
}
正如你可以看到我的两个控制器具有相同的参数模式,两个非空的有符号整数。
As you can see both my controllers have the same parameter "pattern", two non-nullable signed integers.
我的路线的配置是这样的:
My route config looks like this:
routes.MapRoute(
name: "Action2",
url: "My/Action2/{id3}-{id4}",
defaults: new { controller = "My", action = "Action2", id3 = 0, id4 = 0 }
);
routes.MapRoute(
name: "Action1",
url: "My/Action1/{id1}-{id2}",
defaults: new { controller = "My", action = "Action1", id1 = 0, id2 = 0 }
);
routes.MapRoute(
name: "Default",
url: "{controller}/{action}/{id}",
defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }
);
不过,我已经不仅仅是这两个有更多的控制器操作,所以基本上我已经映射为每一个独立的路线,这令我pretty凌乱。
However, I have a lot more controller actions than just these two, so basically I've been mapping a separate route for each one, which strikes me as pretty messy.
我不知道是我是否可以这样做有两个参数,而不是一个,如默认路由:
What I'm wondering is whether I can do something like the default route with two parameters instead of one, such as:
routes.MapRoute(
name: "Default2",
url: "{controller}/{action}/{id1}-{id2}",
defaults: new { controller = "Home", action = "Index", id1 = 0, id2 = 0 }
);
不过,由于我的参数并不总是命名为 ID1
和 ID2
这是不行的(错误的参数词典共包含参数空条目。有没有一种方法可以让我做到这一点?(或者完全不同的方式,这是更好?)
However, given that my parameters are not always named id1
and id2
this won't work ( Error is "The parameters dictionary contains a null entry for parameter". Is there a way I can do this? (Or a completely different way which is better?)
感谢您的帮助!
编辑:根据答案迄今看来我的问题是有点误导。我想,在特定的泛型参数的路线,所以不依赖于特定的参数名称。
Based on the answers thus far it seems my question was a little misleading. I'm wanting a route with generic parameters in particular, so not tied to a specific parameter name.
我希望能够告诉航线经理说:嘿,如果你得到与模式 {控制器} / {行动} / {参数}的请求 - {参数}
,我要你传递这两个参数,无论其类型或名称所指定的控制器和动作!
I want to be able to tell the route manager that "Hey, if you get a request with the pattern {controller}/{action}/{parameter}-{parameter}
, I want you to pass those two parameters to the controller and action specified regardless of their type or name!
推荐答案
好吧,我决定扩大对拉迪姆的想法和设计我自己的自定义路由约束(中的这个问题。
Well, I decided to expand on Radim's idea and design my own custom route constraint (mentioned in this question.
基本上,而不是有许多不同的路线,我现在只是有两个整型参数匹配任何一条路线:
Basically, instead of having many different routes, I now just have one route that matches anything with two integer parameters:
routes.MapRoute(
name: "Default2",
url: "{controller}/{action}/{param1}-{param2}",
defaults: new { controller = "Admin", action = "Index" },
constraints: new { lang = new CustomRouteConstraint(new RoutePatternCollection( new List<ParamType> { ParamType.INT, ParamType.INT })) }
);
在的Application_Start()
在的Global.asax
我设置控制器命名空间约束(这是更有效不是试图每次都看着办吧)
In Application_Start()
under Global.asax
I set the controller namespace for the constraint (which is more efficient than trying to figure it out every time):
protected void Application_Start()
{
AreaRegistration.RegisterAllAreas();
//should be called before RegisterRoutes
CustomRouteConstraint.SetControllerNamespace("********.Controllers");
WebApiConfig.Register(GlobalConfiguration.Configuration);
FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
RouteConfig.RegisterRoutes(RouteTable.Routes);
}
和最后的自定义路由约束(我知道这是一吨code,并可能过于复杂,但我认为这是相当自我解释):
And finally the custom route constraint (I know it's a ton of code and probably overly complex but I think it's fairly self explanatory):
using System;
using System.Collections.Generic;
using System.Web.Mvc;
using System.Web.Routing;
using System.Web;
using System.Linq;
using System.Reflection;
namespace ********.Code
{
public class CustomRouteConstraint : IRouteConstraint
{
private static string controllerNamespace;
RoutePatternCollection patternCollection { get; set; }
/// <summary>
/// Initializes a new instance of the <see cref="CustomRouteConstraint"/> class.
/// </summary>
/// <param name="rPC">The route pattern collection to match.</param>
public CustomRouteConstraint(RoutePatternCollection rPC)
{
this.patternCollection = rPC;
if (string.IsNullOrWhiteSpace(controllerNamespace)) {
controllerNamespace = Assembly.GetCallingAssembly().FullName.Split(new string[1] {","}, StringSplitOptions.None)
.FirstOrDefault().Trim().ToString();
}
}
/// <summary>
/// Sets the controller namespace. Should be called before RegisterRoutes.
/// </summary>
/// <param name="_namespace">The namespace.</param>
public static void SetControllerNamespace(string _namespace)
{
controllerNamespace = _namespace;
}
/// <summary>
/// Attempts to match the current request to an action with the constraint pattern.
/// </summary>
/// <param name="httpContext">The current HTTPContext of the request.</param>
/// <param name="route">The route to which the constraint belongs.</param>
/// <param name="paramName">Name of the parameter (irrelevant).</param>
/// <param name="values">The url values to attempt to match.</param>
/// <param name="routeDirection">The route direction (this method will ignore URL Generations).</param>
/// <returns>True if a match has been found, false otherwise.</returns>
public bool Match(HttpContextBase httpContext, Route route, string paramName, RouteValueDictionary values, RouteDirection routeDirection)
{
if (routeDirection.Equals(RouteDirection.UrlGeneration)) {
return false;
}
Dictionary<string, object> unMappedList = values.Where(x => x.Key.Contains("param")).OrderBy(xi => xi.Key).ToDictionary(
kvp => kvp.Key, kvp => kvp.Value);
string controller = values["controller"] as string;
string action = values["action"] as string;
Type cont = TryFindController(controller);
if (cont != null) {
MethodInfo actionMethod = cont.GetMethod(action);
if (actionMethod != null) {
ParameterInfo[] methodParameters = actionMethod.GetParameters();
if (validateParameters(methodParameters, unMappedList)) {
for (int i = 0; i < methodParameters.Length; i++) {
var key = unMappedList.ElementAt(i).Key;
var value = values[key];
values.Remove(key);
values.Add(methodParameters.ElementAt(i).Name, value);
}
return true;
}
}
}
return false;
}
/// <summary>
/// Validates the parameter lists.
/// </summary>
/// <param name="methodParameters">The method parameters for the found action.</param>
/// <param name="values">The parameters from the RouteValueDictionary.</param>
/// <returns>True if the parameters all match, false if otherwise.</returns>
private bool validateParameters(ParameterInfo[] methodParameters, Dictionary<string, object> values)
{
//@TODO add flexibility for optional parameters
if (methodParameters.Count() != patternCollection.parameters.Count()) {
return false;
}
for (int i = 0; i < methodParameters.Length; i++) {
if (!matchType(methodParameters[i], patternCollection.parameters.ElementAt(i), values.ElementAt(i).Value)) {
return false;
}
}
return true;
}
/// <summary>
/// Matches the type of the found action parameter to the expected parameter, also attempts data conversion.
/// </summary>
/// <param name="actualParam">The actual parameter of the found action.</param>
/// <param name="expectedParam">The expected parameter.</param>
/// <param name="value">The value of the RouteValueDictionary corresponding to that parameter.</param>
/// <returns>True if the parameters match, false if otherwise.</returns>
private bool matchType(ParameterInfo actualParam, ParamType expectedParam, object value)
{
try {
switch (expectedParam) {
case ParamType.BOOL:
switch (actualParam.ParameterType.ToString()) {
case "System.Boolean":
Convert.ToBoolean(value);
return true;
break;
default:
return false;
break;
}
break;
case ParamType.DOUBLE:
switch (actualParam.ParameterType.ToString()) {
case "System.Double":
Convert.ToDouble(value);
return true;
break;
case "System.Decimal":
Convert.ToDecimal(value);
return true;
break;
default:
return false;
break;
}
break;
case ParamType.INT:
switch (actualParam.ParameterType.ToString()) {
case "System.Int32":
Convert.ToInt32(value);
return true;
break;
case "System.Int16":
Convert.ToInt16(value);
return true;
break;
default:
return false;
break;
}
break;
case ParamType.LONG:
switch (actualParam.ParameterType.ToString()) {
case "System.Int64":
Convert.ToInt64(value);
return true;
break;
default:
return false;
break;
}
break;
case ParamType.STRING:
switch (actualParam.ParameterType.ToString()) {
case "System.String":
Convert.ToString(value);
return true;
break;
default:
return false;
break;
}
break;
case ParamType.UINT:
switch (actualParam.ParameterType.ToString()) {
case "System.UInt32":
Convert.ToUInt32(value);
return true;
break;
case "System.UInt16":
Convert.ToUInt16(value);
return true;
break;
default:
return false;
break;
}
break;
case ParamType.ULONG:
switch (actualParam.ParameterType.ToString()) {
case "System.UInt64":
Convert.ToUInt64(value);
return true;
break;
default:
return false;
break;
}
break;
default:
return false;
}
} catch (Exception) {
return false;
}
}
/// <summary>
/// Attempts to discover a controller matching the one specified in the route.
/// </summary>
/// <param name="_controllerName">Name of the controller.</param>
/// <returns>A System.Type containing the found controller, or null if the contoller cannot be discovered.</returns>
private Type TryFindController(string _controllerName)
{
string controllerFullName;
Assembly executingAssembly = Assembly.GetExecutingAssembly();
if (!string.IsNullOrWhiteSpace(controllerNamespace)) {
controllerFullName = string.Format(controllerNamespace + ".Controllers.{0}Controller", _controllerName);
Type controller = executingAssembly.GetType(controllerFullName);
if (controller == null) {
if (controllerNamespace.Contains("Controllers")) {
controllerFullName = string.Format(controllerNamespace + ".{0}Controller", _controllerName);
if ((controller = executingAssembly.GetType(controllerFullName)) == null) {
controllerFullName = string.Format(controllerNamespace + ".{0}", _controllerName);
controller = executingAssembly.GetType(controllerFullName);
}
} else {
controllerFullName = string.Format(controllerNamespace + "Controllers.{0}", _controllerName);
controller = executingAssembly.GetType(controllerFullName);
}
}
return controller;
} else {
controllerFullName = string.Format(Assembly.GetExecutingAssembly().FullName.Split(new string[1] {","}, StringSplitOptions.None)
.FirstOrDefault().Trim().ToString() + ".Controllers.{0}Controller", _controllerName);
return Assembly.GetExecutingAssembly().GetType(controllerFullName);
}
}
}
/// <summary>
/// A list of the exepected parameters in the route.
/// </summary>
public struct RoutePatternCollection
{
public List<ParamType> parameters { get; set; }
public RoutePatternCollection(List<ParamType> _params) : this()
{
this.parameters = _params;
}
}
/// <summary>
/// The valid parameter types for a Custom Route Constraint.
/// </summary>
public enum ParamType
{
STRING,
INT,
UINT,
LONG,
ULONG,
BOOL,
DOUBLE
}
}
随意,如果你看到他们提出改进意见!
Feel free to suggest improvements if you see them!
这篇关于路由模式VS个别路线的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!