C#WebApi路由机制详解

随着前后端分离的大热，WebApi在项目中的作用也是越来越重要，可单独部署、与前端和App交互都很方便，既然有良好的发展趋势，我们当然应该顺势而为——搞懂WebApi！Restful相当于给Http请求增加了语义，Post（增）、Delete（删）、Put（改）、Get（查），有时会用Get进行查询，用Post进行增、删、改。

从MVC到WebApi，路由机制一直都在其中扮演着重要的角色。

它可以很简单：如果你只需要会用一些简单的路由，如/Home/Index那么你只需要配置一个默认路由就能搞定。

它可以很神秘：你的url可以千变万化，看到一些“无厘头”的url，很难理解它是如何找到匹配的Action，例如/api/Pleasure/1/detail，这样的url可以让你纠结半天。

它可以很深奥：当面试官提问“请简单分析下MVC路由机制的原理”，你可能事先就准备好了答案，然后劈里啪啦一顿（型如：UrlRoutingMoudle—>Routes—>RouteData—>RequestContext—>Controller），你可能回答的很流利，但并不一定理解这些个对象到底是啥意思。):目前为止我还没能理解透，以后会继续努力的直到弄清楚。

一、MVC和WebApi路由机制比较
1、MVC使用的路由
在MVC中，默认路由机制是通过解析url路径来匹配Action。比如：/User/GetList，这个url就表示匹配User控制器下的GetList方法，这是MVC路由的默认解析方式。为什么默认的解析方式是这样子的呢？因为MVC定义了一个默认路由，路由代码放在App_Start文件夹下的RouteConfig.cs中，今后我们如果想要自定义路由规则，那自定义路由的代码也要写在RouteConfig.cs中。

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 }
    );
}
url:"{controller}/{action}/{id}"定义了路由解析规则，{controller}是必填参数默认值是Home，{action}是必填参数默认值是Index，{id}表示匹配名称为id的形参，而且是可选参数（方法的参数列表中可以有名为id的形参，也可以没有）。

2、WebApi使用的路由
在WebApi中，默认路由机制是通过解析http请求的类型来匹配Action，也就是说WebApi的默认路由机制不需要指定Action的名称。比如：/api/Pleasure，这个url就表示匹配Pleasure控制器下的[HttpGet]方法，/api是固定必填值，这是WebApi路由的默认解析方式。WebApi的默认解析方式之所以如此，同样也是因为定义了默认路由，路由代码放在App_Start文件夹下的WebApiConfig.cs中，今后我们如果想要自定义路由规则，那自定义路由的代码也要写在WebApiConfig.cs中。

public static void Register(HttpConfiguration config)
{
    // Web API 路由
    config.MapHttpAttributeRoutes();
 
    config.Routes.MapHttpRoute(
        name: "DefaultApi",
        routeTemplate: "api/{controller}/{id}",
        defaults: new { id = RouteParameter.Optional }
    );
 
}
routeTemplate:"api/{controller}/{id}"定义了路由解析规则，api是固定必填值，{controller}是必填参数无默认值，{id}表示匹配名称为id的形参，而且是可选参数（方法的参数列表中可以有名为id的形参，也可以没有）。

3、MVC和WebApi路由区别汇总
WebApi的默认路由机制通过http请求的类型匹配Action，MVC的默认路由机制通过url匹配Action
WebApi的路由配置文件是WebApiConfig.cs，MVC的路由配置文件是RouteConfig.cs
WebApi的Controller继承自Web.Http.ApiController，MVC的Controller继承自Web.Mvc.Controller
4、示例一
public class PleasureController : ApiController
{
    [HttpGet]
    public IEnumerable<string> GetOne()
    {
        return new string[] { "value1", "value2" };
    }
}
 
为什么http://localhost:7866/api/Pleasure能匹配到GetOne()方法呢？首先根据路由规则解析出控制器是Pleasure，其次通过浏览器地址栏直接发出的请求都是get请求而Pleasure中只有一个get类型的方法，因此就匹配到了GetOne()。

为什么http://localhost:7866/api/Pleasure/1也能匹配到GetOne()方法呢？因为id是可选形参，即使指定了id的值，也可以访问不含形参id的方法。

5、示例二
public class PleasureController : ApiController
{
    [HttpGet]
    public IEnumerable<string> GetOne()
    {
        return new string[] { "value1", "value2" };
    }
 
    [HttpGet]
    public IEnumerable<string> GetOne(int id)
    {
        return new string[] { "含参-value1", "含参-value2" };
    }
}

示例二中http://localhost:7866/api/Pleasure请求的结果与示例一中的结果是一样的，在此不做过多的解释。

示例二中http://localhost:7866