Asp.net mvc 中的路由

在 Asp.net mvc ** 中，来自客户端的请求总是针对某个 Controller 中的 Action 方法，因此，必须采用某种机制从请求的 URl 中解析出对应的 Controller 和 Action 的名称，这个过程便称为路由(Routing**)

路由(Routing) 机制并不是专属于 Asp.net mvc，而是建立在 **Asp.net ** 上的，与其相关的核心类型都定义在 System.Web 程序集中

路由机制的优势

　　与之前的 Web From 应用的每次请求的都是针对某一物理文件相比，路由机制具有如下的优势：

灵活性。当请求的物理文件的名称或者路径发生改变时，无需修改现有的路由，因为路由将物理文件的路径与请求完全的分离
可读性。采用路由机制后，可以很容易的从请求的 Url 中看出本次请求的目的或或者要获取的信息
SEO优化。路由机制下的 Url 更符合搜索引擎的检索规则。

核心类型

RouteBase

路由机制中的所有的路由对象都为抽象类 RouteBase 的子类，其定义如下：

    public abstract class RouteBase

    {

        private bool _routeExistingFiles = true;

        protected RouteBase()

        {

        }

        public abstract RouteData GetRouteData(HttpContextBase httpContext);

        public abstract VirtualPathData GetVirtualPath(RequestContext requestContext, RouteValueDictionary values);

        public bool RouteExistingFiles

        {

            get =>

                this._routeExistingFiles;

            set

            {

                this._routeExistingFiles = value;

            }

        }

    }

　　从中可以看出，其有两个核心的方法 GetRouteData 和 GetVirtualPath，前者用于根据当前的 HttpContext 去获取与当前请求匹配的 RouteData，后者用于根据匹配的路由和传递的 Values 生成 Url，其中的参数 RequestContext 是对 HttpContext 和 RouteData 的封装。

Route

　　默认情况下，RouteBase 具有一个实现类 Route，其定义如下(部分)：

    public class Route : RouteBase

    {

        public Route(string url, IRouteHandler routeHandler)

        public Route(string url, RouteValueDictionary defaults, IRouteHandler routeHandler)

        public Route(string url, RouteValueDictionary defaults, RouteValueDictionary constraints, IRouteHandler routeHandler)

        public Route(string url, RouteValueDictionary defaults, RouteValueDictionary constraints, RouteValueDictionary dataTokens, IRouteHandler routeHandler)

        public override RouteData GetRouteData(HttpContextBase httpContext)

        public override VirtualPathData GetVirtualPath(RequestContext requestContext, RouteValueDictionary values)

        public RouteValueDictionary Constraints { get; set; }

        public RouteValueDictionary DataTokens { get; set; }

        public RouteValueDictionary Defaults { get; set; }

        public IRouteHandler RouteHandler { get; set; }

		public string Url {get;set;}

    }

　　其中的 Url 表示注册的路由的模板，例如 /{controller}/{action}/{id}, Defaults 表示路由的默认值，例如 new {controller="home",action="index",id = UrlParameter.Optional}, UrlParameter.Optional 表示该参数是可选的， constraints 表示对当前定义的路由规则的一些约束，例如，constrains:new {id = @"\d+"},限制参数id为数字例如将RouteHandler 表示对匹配该路由的请求处理使用的 IRouteHandler 类型的对象，其具有一个返回 IHttpHandler GetHttpHandler(RequestContext context)的方法，IHttpHandler 中定义了一个 void ProcessRequest(HttpContext context) 是整个 Asp.net 应用进行后续处理的入口。

RouteData

　　RouteData 中封存通过路由机制从请求的 Url 中解析出来的路由数据，其定义如下(部分)：

    public class RouteData

    {

        public RouteData()

        public RouteData(RouteBase route, IRouteHandler routeHandler)

        public string GetRequiredString(string valueName)

        public RouteValueDictionary DataTokens{get;}

        public RouteBase Route { get; set; }

        public IRouteHandler RouteHandler{get;set;}

		public RouteValueDictionary Values{get;}

}

　　上面的 Route 对象的 GetRouteData 返回的就是这样的一个 RouteData 对象，其中的 Route 就是与当前请求匹配的路由对象，RouteHandler 对应着 Route 对象的同名属性，Values 中保存从请求 Url 中解析出来的数据(键值对)，如 controller、action、id 等，DataTokens 亦对应着 Route 对象的同名属性。

　　GetRequiredString(string valueName) 方法根据指定的 Key(valueName) 从 Values 中获取对应的值。如果指定的 key 不存在，则会抛出 InvalidOperation 的异常。

RouteTable

　　RouteTable 类的定义比较简单，除了构造函数外，只有一个 RouteCollection 类型的静态属性 Routes，全局的路由注册便是通过该属性进行操作的。

　　RouteCollection 派生自 Collection,其定义如下(部分核心):

    public class RouteCollection : Collection<RouteBase>

    {

        private Dictionary<string, RouteBase> _namedMap;

        private ReaderWriterLockSlim _rwLock;

        private VirtualPathProvider _vpp;

        public RouteCollection()

        public RouteCollection(VirtualPathProvider virtualPathProvider)

        public RouteData GetRouteData(HttpContextBase httpContext)

        public VirtualPathData GetVirtualPath(RequestContext requestContext, RouteValueDictionary values)

        public VirtualPathData GetVirtualPath(RequestContext requestContext, string name, RouteValueDictionary values)

        public void Ignore(string url)

        public void Ignore(string url, object constraints)

        public Route MapPageRoute(string routeName, string routeUrl, string physicalFile) 

        public Route MapPageRoute(string routeName, string routeUrl, string physicalFile, bool checkPhysicalUrlAccess, RouteValueDictionary defaults, RouteValueDictionary constraints, RouteValueDictionary dataTokens)

        public bool AppendTrailingSlash { get; set; }

        public RouteBase this[string name]

		public bool LowerCaseUrls{get;set;}

        public bool RouteExistingFiles { get; set; }

}

　　上面的代码可以看到其中定义了 RouteData GetRouteData(HttpContextBase context) 和 VirtualPathData GetVirtualPath(RequestContext requestContext, string name, RouteValueDictionary values),在调用这两个方法时内部是通过调用集合内每个 Route 的同名方法，返回匹配的项，如果不存在则返回 null

　　Ignore(string url) 方法将无需通过路由的资源对应的 Url 添加到路由表中，其内部会调用 Add 方法，参数 constraint 的作用同 Route 对象的同名参数，即对当前的路由进行约束。

　　Route MapPageRoute() 方法，将指定的路由信息注册到当前的路由表中，其内部会调用 Add 方法，因此，除了使用 MapPageRoute 方法进行路由注册外，还可以直接调用 Add 方法，两者唯一的区别就是前者会返回一个添加的 Route 对象，后者则无返回值。添加的 Route 对象的 IRouteHandler 均为 PageRouteHandler

AppendTrailingSliash 标识是否在生成的 Url 后添加 /
LowerCaseUrls 标识是否将生成的 Url 转换为小写
RouteExistingFiles 标识是否对物理文件进行路由

　　在 Asp.net mvc 中对 RouteCollection 类进行了扩展，扩展方法定义在 System.Web.Mvc 程序集的 HttpRouteCollectionExtensions 类中,定义如下(部分核心方法)：

    public static void IgnoreRoute(this RouteCollection routes, string url);

    public static void IgnoreRoute(this RouteCollection routes, string url, object constraints);

    public static Route MapRoute(this RouteCollection routes, string name, string url);

    public static Route MapRoute(this RouteCollection routes, string name, string url, object defaults);

    public static Route MapRoute(this RouteCollection routes, string name, string url, string[] namespaces);

    public static Route MapRoute(this RouteCollection routes, string name, string url, object defaults, object constraints);

    public static Route MapRoute(this RouteCollection routes, string name, string url, object defaults, string[] namespaces);

    public static Route MapRoute(this RouteCollection routes, string name, string url, object defaults, object constraints, string[] namespaces);

　　上面的代码定义了两组方法，其中 IgnoreRoute 用于注册需要被忽略的 url 对应的路由模板，对应 RouteCollection 的 Ignore 方法，MapRoute 用于注册路由，对应 RouteCollection 的 MapPageRoute 方法。但与 MapPageRoute 不同的是原来的 constraints 和 defaults 有 RouteValueDictionary 变为了 object,这样我们可以通过匿名参数的方式来为其赋值，在方法的内部会通过反射的方式获取对象的属性列表，然后将其转换为 RouteValueDictionary,其 key 和 value 分别为属性的名称与属性值。MapPageRoute 方法中调用 Add 方法时指定的 IRouteHanndler 为 PageRouteHandler，MapRoute 方法内部调用 Add 方法时指定的 IRouteHandler 为 **MvcRouteHandler **

路由解析整体过程

路由扩展(定制)思路

通过继承 RouteBase 抽象类自定义路由实现自定义路由逻辑
通过实现 IRouteHandler 接口自主实现 RouteHandler 的提供机制(RouteCollection.Add(name,IRouteHandler))
通过实现 IHttpHandler 接口自主实现请求的处理并返回(HttpContextBase.RemapHandler(IHttpHandler))