使用XML檔案來動態配置ASP.NET MVC的Route規則

一般情況下，我們都是直接在Global.asax.cs檔案中直接寫上Route規則的，例如：

public static void RegisterRoutes(RouteCollection routes){    routes.IgnoreRoute("{resource}.axd/{*pathInfo}");    routes.MapRoute(        "Default",                                              // Route name        "{controller}/{action}/{id}",                           // URL with parameters        new { controller = "Home", action = "Index", id = "" }  // Parameter defaults    );}

這樣在我們的程式編譯、部署後，我們想修改這個Route規則就得重新修改程式中Global.asax.cs檔案中的Route規則=>編譯=>部署，不可以做到動態配置。

其實我們可以做到動態配置，我們可以將這個Route規則寫到一個XML檔案中，例如這樣：

<RouteConfiguration>  <ignore>    <!--忽略對.axd檔案的Route，直接處理-->    <add url="{resource}.axd/{*pathInfo}" >      <constraints>        <!--添加約束,value是亂寫的,只為示範-->        <add name="resource" value="\w" />      </constraints>    </add>  </ignore>  <map>    <route name="Post" url="Post/{id}" controller="Home" action="Post" >      <parameters>        <!--添加參數預設值-->        <!--添加約束,id必須為GUID-->        <add name="id" value="" constraint="[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}" />      </parameters>    </route>    <route name="Default" url="{controller}/{action}/{id}" controller="Home" action="Index" >      <parameters>        <add name="id" value="" />      </parameters>    </route>  </map></RouteConfiguration>

我們例如Web.config中的configSection來寫我們的自訂配置節，來配置上面的XML檔案。首先，我需要寫一個定義的configSection，他繼承自ConfigurationSection，如下：

public class MvcRouteConfigurationSection : ConfigurationSection{    [ConfigurationProperty("ignore", IsRequired=false)]    public IgnoreCollection Ignore    {        get        {            return (IgnoreCollection)(this["ignore"]);        }    }    [ConfigurationProperty("map", IsRequired=false)]    public RoutingCollection Map    {        get        {            return (RoutingCollection)(this["map"]);        }    }}

然後我們寫一個擴充方法來自訂將我們配置好的Route規則寫入到程式路由表中：

public static void MapRoute(    this System.Web.Routing.RouteCollection routes,     MvcRouteConfigurationSection section ){    // Manipulate the Ignore List    foreach(IgnoreItem ignoreItem in section.Ignore)    {        RouteValueDictionary ignoreConstraints = new RouteValueDictionary();        foreach (Constraint constraint in ignoreItem.Constraints)            ignoreConstraints.Add(constraint.Name, constraint.Value);        IgnoreRoute(routes, ignoreItem.Url, ignoreConstraints);    }    // Manipluate the Routing Table    foreach (RoutingItem routingItem in section.Map)    {        RouteValueDictionary defaults = new RouteValueDictionary();        RouteValueDictionary constraints = new RouteValueDictionary();        if (routingItem.Controller != string.Empty)            defaults.Add("controller", routingItem.Controller);        if (routingItem.Action != string.Empty)            defaults.Add("action", routingItem.Action);        foreach (Parameter param in routingItem.Paramaters)        {            defaults.Add(param.Name, param.Value);            if (!string.IsNullOrEmpty(param.Constraint))            {                constraints.Add(param.Name, param.Constraint);            }        }        MapRoute(routes, routingItem.Name, routingItem.Url, defaults, constraints);    }}

然後在web.config中的configSections配置節下加入我們寫好的MvcRouteConfigurationSection ：

<section name="RouteConfiguration" type="MvcXmlRouting.MvcRouteConfigurationSection"/>

最後，在Global.asax.cs中用我們剛才寫的MapRoute擴充方法來註冊我們的Route規則：

public class MvcApplication : System.Web.HttpApplication{    public static void RegisterRoutes(RouteCollection routes)    {        MvcRouteConfigurationSection section =             (MvcRouteConfigurationSection)ConfigurationManager.GetSection("RouteConfiguration");        routes.MapRoute(section);    }    protected void Application_Start()    {        RegisterRoutes(RouteTable.Routes);    }}

OK，大功告成。Enjoy! by Q.Lee.lulu.

原文見：ASP.NET MVC Routing Using XML Custom Configuration Settings

本文的範例程式碼在原文的代碼基礎上添加了對約束(constraints)的支援！

本文範例程式碼下載：XmlRout.Web.rar