WebApi和MVC路由规则避坑指南

一. WebApi和MVC路由规则

由于路由规则是谁先注册谁的优先级就高,所以路由注册顺序必须是从最精确的匹配规则开始再到普通的匹配规则，最后才是模糊的匹配规则，这样就避免了在进行路由匹配时，过早的匹配了模糊规则，而相对精确的匹配起不到任何作用 (默认路由规则会依次按顺序寻找routeTemplate的各个部分设置了默认路由值的对象defaults。寻找到了就会加载路由模板。)

WebApi路由注册:

public static class WebApiConfig
    {
        public static void Register(HttpConfiguration config)
        {
            // Web API 配置和服务

            // Web API 路由
            config.MapHttpAttributeRoutes();

            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/{controller}/{id}",
                defaults: new { id = RouteParameter.Optional }
            );
        }
    }

MVC路由注册:

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

            routes.MapRoute(
                name: "Default",
                url: "{controller}/{action}/{id}",
                defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }
            );
        }
    }

Global.asax

//特殊规则优先注册(因为路由规则api/{controller}/{id}这个是以api开头,比较特殊)
GlobalConfiguration.Configure(WebApiConfig.Register);

//普通规则最后注册
RouteConfig.RegisterRoutes(RouteTable.Routes);

如果调换路由注册规则的顺序

//普通规则最后注册
RouteConfig.RegisterRoutes(RouteTable.Routes);

//特殊规则优先注册(因为路由规则api/{controller}/{id}这个是以api开头,比较特殊)
GlobalConfiguration.Configure(WebApiConfig.Register);

则访问 https://localhost:44369/api/Values 的时候会报错:(因为它满足了MVC的路由规则,在MVC中当然找不到)

二. 自己遇到的问题

WebApi路由注册:

public static class WebApiConfig
    {
        public static void Register(HttpConfiguration config)
        {
            // Web API 配置和服务

            // Web API 路由
            config.MapHttpAttributeRoutes();

            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate:"{controller}/{action}/{id}",
                defaults: new { id = RouteParameter.Optional }
            );
        }
    }

MVC路由注册:

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

            routes.MapRoute(
                name: "Default",
                url: "{controller}/{action}/{id}",
                defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }
            );
        }
    }

Global.asax

//特殊规则优先注册(因为路由规则api/{controller}/{id}这个是以api开头,比较特殊)
GlobalConfiguration.Configure(WebApiConfig.Register);

//普通规则最后注册
RouteConfig.RegisterRoutes(RouteTable.Routes);

由于WebApi路由规则与与MVC路由规则一致,且WebApi路由规则先注册,导致无法访问到MVC路由规则。

由于WebApi项目很庞大已经无法变更,所以只能变更MVC路由规则,要求与WebApi路由规则区分开。

我的解决办法:

Global.asax

//先注册MVC路由,加约束条件
RouteConfig.RegisterRoutes(RouteTable.Routes);


GlobalConfiguration.Configure(WebApiConfig.Register);

MVC路由规则两种解决办法:

1. Controller名称限制

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

            routes.MapRoute(
                name: "Default",
                url: "{controller}/{action}/{id}",
                defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional },
                //约束条件,只匹配Controller为Home的控制器
                constraints: new {controller="Home"}
            );
        }
    }

2. 路由增加前缀限制条件

   增加前缀限制条件mvcprefix,要注意webapi的所有路由不要满足前缀条件mvcprefix

 public static void RegisterRoutes(RouteCollection routes)
    {
        //routes.MapMvcAttributeRoutes();

        routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

        routes.MapRoute(
            name: "Default",
            url: "mvcprefix/{controller}/{action}/{id}",
            defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }
        );
    }

下面的MVC路由配置规则会导致webapi的接口都符合MVC路由配置规则,都会走MVC路由,导致webapi接口全部访问不到

 public static void RegisterRoutes(RouteCollection routes)
    {
        //routes.MapMvcAttributeRoutes();

        routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

        routes.MapRoute(
            name: "Default",
            url: "{prefix}/{controller}/{action}/{id}",
            defaults: new { prefix = "mvcprefix",controller = "Home", action = "Index", id = UrlParameter.Optional }
        );
    }

发现,C# Web MVC项目 如何打开默认地址跳转到默认的URL,这篇文章:https://jingyan.baidu.com/article/e75aca8580f6c5542fdac60f.html,
只需要 项目-属性-启动操作 如下图设置即可:

控制器代码:

    public class HomeController : Controller
    {
    }