如何修改ASP NET Web API路由匹配以允许带有斜杠的参数?

时间:2013-07-25 11:37:00

标签: asp.net-web-api asp.net-mvc-routing

我们在后端使用RavenDB,因此所有数据库键都是包含正斜杠的字符串,例如users/1

AFAIK没有办法使用默认的ASP NET Web API路由匹配引擎来匹配这样的参数,而不使用catch-all,这意味着密钥必须是URL上的最后一个东西。我尝试添加users/d+的正则表达式约束,但它似乎没有什么区别,路线没有匹配。

我需要替换哪些位才能进行足够的自定义路由匹配以允许此操作,最好不要使路由匹配的其余部分瘫痪。例如,使用url: "{*route}"和完全正则表达式匹配的自定义约束可以工作,但可能会与其他路由配置意外地工作。

如果您的答案附带一些示例代码,那就更好了。

1 个答案:

答案 0 :(得分:2)

似乎可以通过定义自定义路线来实现此目的。在MVC4(最后一个稳定版本4.0.30506.0)中,不可能按照规范实现IHttpRoute,而是通过定义自定义MVC级Route并将其直接添加到RouteTable来实现}。有关详细信息,请参阅12。以下RegexRoute实施基于实施here,其中包含答案here中的mod。

定义RegexRoute

public class RegexRoute : Route
{
    private readonly Regex urlRegex;

    public RegexRoute(string urlPattern, string routeTemplate, object defaults, object constraints = null)
        : base(routeTemplate, new RouteValueDictionary(defaults), new RouteValueDictionary(constraints), new RouteValueDictionary(), HttpControllerRouteHandler.Instance)
    {
        urlRegex = new Regex(urlPattern, RegexOptions.Compiled);
    }

    public override RouteData GetRouteData(HttpContextBase httpContext)
    {
        string requestUrl = httpContext.Request.AppRelativeCurrentExecutionFilePath.Substring(2) + httpContext.Request.PathInfo;

        Match match = urlRegex.Match(requestUrl);

        RouteData data = null;

        if (match.Success)
        {
            data = new RouteData(this, RouteHandler);

            // add defaults first
            if (null != Defaults)
            {
                foreach (var def in Defaults)
                {
                    data.Values[def.Key] = def.Value;
                }
            }

            // iterate matching groups
            for (int i = 1; i < match.Groups.Count; i++)
            {
                Group group = match.Groups[i];

                if (group.Success)
                {
                    string key = urlRegex.GroupNameFromNumber(i);

                    if (!String.IsNullOrEmpty(key) && !Char.IsNumber(key, 0)) // only consider named groups
                    {
                        data.Values[key] = group.Value;
                    }
                }
            }
        }

        return data;
    }
}

添加此DelegatingHandler以避免由于某些其他错误导致NullReference

public class RouteByPassingHandler : DelegatingHandler
    {
        protected override System.Threading.Tasks.Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, System.Threading.CancellationToken cancellationToken)
        {
            HttpMessageInvoker invoker = new HttpMessageInvoker(new HttpControllerDispatcher(request.GetConfiguration()));
            return invoker.SendAsync(request, cancellationToken);
        }
    }

直接添加处理程序并路由到RouteTable

RouteTable.Routes.Add(new RegexRoute(@"^api/home/index/(?<id>\d+)$", "test", new { controller = "Home", action = "Index" }));

        config.MessageHandlers.Add(new RouteByPassingHandler());

Et瞧!

编辑:当API自我托管(而不是使用WebHost)时,此解决方案存在问题,并且需要进一步的工作才能使其与两者兼容。如果这对任何人都很有意思,请发表评论,我会发布我的解决方案。