史上最全的ASP.NET MVC路由配置
作者：Cherbim
MVC將一個(gè)Web應(yīng)用分解為：Model、View和Controller。ASP.NET MVC框架提供了一個(gè)可以代替ASP.NETWebForm的基于MVC設(shè)計(jì)模式的應(yīng)用。
XD 首先說URL的構(gòu)造。 其實(shí)這個(gè)也談不上構(gòu)造，只是語法特性吧。
一、命名參數(shù)規(guī)范+匿名對(duì)象
routes.MapRoute(name: "Default",url: "{controller}/{action}/{id}", defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional } );
構(gòu)造路由然后添加
- Route myRoute = new Route("{controller}/{action}", new MvcRouteHandler());
- routes.Add("MyRoute", myRoute);
二、直接方法重載+匿名對(duì)象
- routes.MapRoute("ShopSchema", "Shop/{action}", new { controller = "Home" });
個(gè)人覺得***種比較易懂，第二種方便調(diào)試，第三種寫起來比較效率吧。各取所需吧。本文行文偏向于第三種。
1.默認(rèn)路由(MVC自帶)
- routes.MapRoute(
- "Default", // 路由名稱
- "{controller}/{action}/{id}", // 帶有參數(shù)的 URL
- new { controller = "Home", action = "Index", id = UrlParameter.Optional } // 參數(shù)默認(rèn)值 (UrlParameter.Optional-可選的意思) );
2.靜態(tài)URL段
- routes.MapRoute("ShopSchema2", "Shop/OldAction", new { controller = "Home", action = "Index" });
- routes.MapRoute("ShopSchema", "Shop/{action}", new { controller = "Home" });
- routes.MapRoute("ShopSchema2", "Shop/OldAction.js",
- new { controller = "Home", action = "Index" });
沒有占位符路由就是現(xiàn)成的寫死的。
比如這樣寫然后去訪問http://localhost:XXX/Shop/OldAction.js，response也是完全沒問題的。 controller , action , area這三個(gè)保留字就別設(shè)靜態(tài)變量里面了。
3.自定義常規(guī)變量URL段
- routes.MapRoute("MyRoute2", "{controller}/{action}/{id}", new { controller = "Home", action = "Index", id = "DefaultId" });
這種情況如果訪問 /Home/Index 的話，因?yàn)榈谌?id)沒有值，根據(jù)路由規(guī)則這個(gè)參數(shù)會(huì)被設(shè)為DefaultId
這個(gè)用viewbag給title賦值就能很明顯看出
- ViewBag.Title = RouteData.Values["id"];
結(jié)果是標(biāo)題顯示為DefaultId， 注意要在控制器里面賦值，在視圖賦值沒法編譯的。
4.再述默認(rèn)路由
然后再回到默認(rèn)路由。 UrlParameter.Optional這個(gè)叫可選URL段.路由里沒有這個(gè)參數(shù)的話id為null。 照原文大致說法，這個(gè)可選URL段能用來實(shí)現(xiàn)一個(gè)關(guān)注點(diǎn)的分離。剛才在路由里直接設(shè)定參數(shù)默認(rèn)值其實(shí)不是很好。照我的理解，實(shí)際參數(shù)是用戶發(fā)來的，我們做的只是定義形式參數(shù)名。但是，如果硬要給參數(shù)賦默認(rèn)值的話，建議用語法糖寫到action參數(shù)里面。比如：
- public ActionResult Index(string id = "abcd"){ViewBag.Title = RouteData.Values["id"];return View();}
5.可變長度路由
- routes.MapRoute("MyRoute", "{controller}/{action}/{id}/{*catchall}", new { controller = "Home", action = "Index", id = UrlParameter.Optional });
在這里id和***一段都是可變的，所以 /Home/Index/dabdafdaf 等效于 /Home/Index//abcdefdjldfiaeahfoeiho 等效于 /Home/Index/All/Delete/Perm/.....
6.跨命名空間路由
這個(gè)提醒一下記得引用命名空間，開啟IIS網(wǎng)站不然就是404。這個(gè)非常非主流，不建議瞎搞。
- routes.MapRoute("MyRoute","{controller}/{action}/{id}/{*catchall}", new { controller = "Home", action = "Index", id = UrlParameter.Optional },new[] { "URLsAndRoutes.AdditionalControllers", "UrlsAndRoutes.Controllers" });
但是這樣寫的話數(shù)組排名不分先后的，如果有多個(gè)匹配的路由會(huì)報(bào)錯(cuò)。 然后作者提出了一種改進(jìn)寫法。
- routes.MapRoute("AddContollerRoute","Home/{action}/{id}/{*catchall}",new { controller = "Home", action = "Index", id = UrlParameter.Optional },new[] { "URLsAndRoutes.AdditionalControllers" });
- routes.MapRoute("MyRoute", "{controller}/{action}/{id}/{*catchall}", new { controller = "Home", action = "Index", id = UrlParameter.Optional },new[] { "URLsAndRoutes.Controllers" });
這樣***個(gè)URL段不是Home的都交給第二個(gè)處理 ***還可以設(shè)定這個(gè)路由找不到的話就不給后面的路由留后路啦，也就不再往下找啦。
- Route myRoute = routes.MapRoute("AddContollerRoute",
- "Home/{action}/{id}/{*catchall}",
- new { controller = "Home", action = "Index", id = UrlParameter.Optional },
- new[] { "URLsAndRoutes.AdditionalControllers" }); myRoute.DataTokens["UseNamespaceFallback"] = false;
7.正則表達(dá)式匹配路由
- routes.MapRoute("MyRoute", "{controller}/{action}/{id}/{*catchall}",
- new { controller = "Home", action = "Index", id = UrlParameter.Optional },
- new { controller = "^H.*"},
- new[] { "URLsAndRoutes.Controllers"});
約束多個(gè)URL
- routes.MapRoute("MyRoute", "{controller}/{action}/{id}/{*catchall}",
- new { controller = "Home", action = "Index", id = UrlParameter.Optional },
- new { controller = "^H.*", action = "^Index$|^About$"},
- new[] { "URLsAndRoutes.Controllers"});
8.指定請(qǐng)求方法
- routes.MapRoute("MyRoute", "{controller}/{action}/{id}/{*catchall}",
- new { controller = "Home", action = "Index", id = UrlParameter.Optional },
- new { controller = "^H.*", action = "Index|About", httpMethod = new HttpMethodConstraint("GET") },
- new[] { "URLsAndRoutes.Controllers" });
#p#9.***還是不爽的話自己寫個(gè)類實(shí)現(xiàn) IRouteConstraint的匹配方法。
- using System;
- using System.Collections.Generic;
- using System.Linq;
- using System.Web;
- using System.Web.Routing;
- /// <summary>
- /// If the standard constraints are not sufficient for your needs, you can define your own custom constraints by implementing the IRouteConstraint interface.
- /// </summary>
- public class UserAgentConstraint : IRouteConstraint
- {
- private string requiredUserAgent;
- public UserAgentConstraint(string agentParam)
- {
- requiredUserAgent = agentParam;
- }
- public bool Match(HttpContextBase httpContext, Route route, string parameterName,
- RouteValueDictionary values, RouteDirection routeDirection)
- {
- return httpContext.Request.UserAgent != null &&
- httpContext.Request.UserAgent.Contains(requiredUserAgent);
- }
- }
- routes.MapRoute("ChromeRoute", "{*catchall}",
- new { controller = "Home", action = "Index" },
- new { customConstraint = new UserAgentConstraint("Chrome") },
- new[] { "UrlsAndRoutes.AdditionalControllers" });
比如這個(gè)就用來匹配是否是用谷歌瀏覽器訪問網(wǎng)頁的。
10.訪問本地文檔
- routes.RouteExistingFiles = true;
- routes.MapRoute("DiskFile", "Content/StaticContent.html", new { controller = "Customer", action = "List", });
瀏覽網(wǎng)站，以開啟 IIS Express，然后點(diǎn)顯示所有應(yīng)用程序-點(diǎn)擊網(wǎng)站名稱-配置(applicationhost.config)-搜索UrlRoutingModule節(jié)點(diǎn)
- <add name="UrlRoutingModule-4.0" type="System.Web.Routing.UrlRoutingModule" preCondition="managedHandler,runtimeVersionv4.0" />
把這個(gè)節(jié)點(diǎn)里的preCondition刪除，變成
- <add name="UrlRoutingModule-4.0" type="System.Web.Routing.UrlRoutingModule" preCondition="" />
11.直接訪問本地資源，繞過了路由系統(tǒng)
- routes.IgnoreRoute("Content/{filename}.html");
文件名還可以用 {filename}占位符。
IgnoreRoute方法是RouteCollection里面StopRoutingHandler類的一個(gè)實(shí)例。路由系統(tǒng)通過硬-編碼識(shí)別這個(gè)Handler。如果這個(gè)規(guī)則匹配的話，后面的規(guī)則都無效了。 這也就是默認(rèn)的路由里面routes.IgnoreRoute("{resource}.axd/{*pathInfo}");寫最前面的原因。
三、路由測試(在測試項(xiàng)目的基礎(chǔ)上，要裝moq)
- PM> Install-Package Moq
- using System;
- using Microsoft.VisualStudio.TestTools.UnitTesting;
- using System.Web;
- using Moq;
- using System.Web.Routing;
- using System.Reflection;
- [TestClass]
- public class RoutesTest
- {
- private HttpContextBase CreateHttpContext(string targetUrl = null, string HttpMethod = "GET")
- {
- // create the mock request
- Mock<HttpRequestBase> mockRequest = new Mock<HttpRequestBase>();
- mockRequest.Setup(m => m.AppRelativeCurrentExecutionFilePath)
- .Returns(targetUrl);
- mockRequest.Setup(m => m.HttpMethod).Returns(HttpMethod);
- // create the mock response
- Mock<HttpResponseBase> mockResponse = new Mock<HttpResponseBase>();
- mockResponse.Setup(m => m.ApplyAppPathModifier(
- It.IsAny<string>())).Returns<string>(s => s);
- // create the mock context, using the request and response
- Mock<HttpContextBase> mockContext = new Mock<HttpContextBase>();
- mockContext.Setup(m => m.Request).Returns(mockRequest.Object);
- mockContext.Setup(m => m.Response).Returns(mockResponse.Object);
- // return the mocked context
- return mockContext.Object;
- }
- private void TestRouteMatch(string url, string controller, string action, object routeProperties = null, string httpMethod = "GET")
- {
- // Arrange
- RouteCollection routes = new RouteCollection();
- RouteConfig.RegisterRoutes(routes);
- // Act - process the route
- RouteData result = routes.GetRouteData(CreateHttpContext(url, httpMethod));
- // Assert
- Assert.IsNotNull(result);
- Assert.IsTrue(TestIncomingRouteResult(result, controller, action, routeProperties));
- }
- private bool TestIncomingRouteResult(RouteData routeResult, string controller, string action, object propertySet = null)
- {
- Func<object, object, bool> valCompare = (v1, v2) =>
- {
- return StringComparer.InvariantCultureIgnoreCase
- .Compare(v1, v2) == 0;
- };
- bool result = valCompare(routeResult.Values["controller"], controller)
- && valCompare(routeResult.Values["action"], action);
- if (propertySet != null)
- {
- PropertyInfo[] propInfo = propertySet.GetType().GetProperties();
- foreach (PropertyInfo pi in propInfo)
- {
- if (!(routeResult.Values.ContainsKey(pi.Name)
- && valCompare(routeResult.Values[pi.Name],
- pi.GetValue(propertySet, null))))
- {
- result = false;
- break;
- }
- }
- }
- return result;
- }
- private void TestRouteFail(string url)
- {
- // Arrange
- RouteCollection routes = new RouteCollection();
- RouteConfig.RegisterRoutes(routes);
- // Act - process the route
- RouteData result = routes.GetRouteData(CreateHttpContext(url));
- // Assert
- Assert.IsTrue(result == null || result.Route == null);
- }
- [TestMethod]
- public void TestIncomingRoutes()
- {
- // check for the URL that we hope to receive
- TestRouteMatch("~/Admin/Index", "Admin", "Index");
- // check that the values are being obtained from the segments
- TestRouteMatch("~/One/Two", "One", "Two");
- // ensure that too many or too few segments fails to match
- TestRouteFail("~/Admin/Index/Segment");//失敗
- TestRouteFail("~/Admin");//失敗
- TestRouteMatch("~/", "Home", "Index");
- TestRouteMatch("~/Customer", "Customer", "Index");
- TestRouteMatch("~/Customer/List", "Customer", "List");
- TestRouteFail("~/Customer/List/All");//失敗
- TestRouteMatch("~/Customer/List/All", "Customer", "List", new { id = "All" });
- TestRouteMatch("~/Customer/List/All/Delete", "Customer", "List", new { id = "All", catchall = "Delete" });
- TestRouteMatch("~/Customer/List/All/Delete/Perm", "Customer", "List", new { id = "All", catchall = "Delete/Perm" });
- }
- }
***還是再推薦一下Adam Freeman寫的apress.pro.asp.net.mvc.4這本書。稍微熟悉MVC的從第二部分開始讀好了。
責(zé)任編輯：林琳
來源：
博客園
