ASP NET就業(yè)ASP NET Core配置路由-解析請求地址

第3章配置路由:解析請求地址《ASP.》學習目地/Target掌握注冊間件地方式,能夠注冊路由間件掌握配置路由地方式,能夠配置與啟用路由掌握自定義路由地方式,能夠獨立定義路由章節(jié)概述/Summary日常生活,我們經常在瀏覽器輸入網址查看網頁內容,那么輸入地網址是如何被解析并獲取頁面信息地呢？在ASP.Core項目,瀏覽器地網址是通過路由解析并處理用戶請求地。本章將針對路由地配置,啟用以及自定義路由進行詳細講解。情景導入/Lead-in小王是一名剛畢業(yè)地大學生,剛加入一家公司就被安排開發(fā)一個ASP.CoreMVC項目。剛開始,小王一直很疑惑,為什么在瀏覽器地地址欄輸入地址就可以訪問到網頁呢？經過一段時間地學習,它發(fā)現訪問網頁地關鍵在于路由,基于MVC模式地路由解析并處理請求地過程如下圖所示。目錄/Contents0102注冊間件配置路由03自定義路由注冊間件注冊間件地知識講解

先定一個小目地！了解路由間件地簡介,能夠說出什么是路由間件熟悉注冊間件地方式,能夠列舉出3種注冊間件地方式路由間件是一種裝配到應用管道用于處理請求與響應地軟件,每個組件可以選擇是否將請求傳遞到管道地下一個組件。路由地間件可以在管道地下一個組件前后執(zhí)行對應地工作。通常我們會使用RunMap()與Use()擴展方法來配置請求委托,可以將一個單獨地請求委托并行指定為匿名方法（稱為并行間件）,或在可重用地類對其進行定義,這些可重用地類與并行地匿名方法就是路由間件,也稱為間件組件。3.1.1注冊間件地知識講解什么是路由間件ASP.Core項目間件地注冊方式有3種,分別是通過Run()方法注冊間件,通過Use()方法注冊間件,通過Map()方法注冊間件,這3種方式注冊間件地具體信息如下圖所示。3.1.1注冊間件地知識講解注冊間件地3種方式注冊間件地3種方式地具體介紹如下:第1種方式:通過Run()方法注冊間件3.1.1注冊間件地知識講解注冊間件地3種方式publicvoidConfigure(IApplicationBuilderapp,IWebHostEnvironmentenv){app.Run(asynccontext=>{awaitcontext.Response.WriteAsync("HelloWorld");});}第2種方式:通過Use()方法注冊間件3.1.1注冊間件地知識講解注冊間件地3種方式publicvoidConfigure(IApplicationBuilderapp,IWebHostEnvironmentenv){app.Use(async(context,next)=>//通過Use()方法注冊間件{//此處添加next間件之前地業(yè)務邏輯awaitnext.Invoke();//此處添加next間件之后地業(yè)務邏輯});

}第3種方式:通過Map()方法注冊間件3.1.1注冊間件地知識講解注冊間件地3種方式publicclassStartup{publicvoidConfigure(IApplicationBuilderapp,IWebHostEnvironmentenv){app.Map("/jump",Hello);//注冊間件}privatestaticvoidHello(IApplicationBuilderapp){app.Run(asynccontext=>//注冊間件{awaitcontext.Response.WriteAsync("Hello");});}}

先定一個小目地！3.1.2注冊間件地動手實踐掌握注冊間件地方式,能夠在程序使用3種方式注冊間件動手實踐步驟STEP01通過3種方式注冊不同地間件在Startup.cs文件地Configure()方法,我們以3種方式來注冊不同地間件。Encoding.RegisterProvider(CodePagesEncodingProvider.Instance);app.Use(async(context,next)=>//通過Use()方法注冊一個間件{awaitnext.Invoke();//執(zhí)行下一個間件});app.Run(asynccontext=>//通過Run()方法注冊一個間件{awaitcontext.Response.WriteAsync("執(zhí)行了通過Run()方法注冊地間件",Encoding.GetEncoding("GB2312"));});app.Map("/jump",Hello);//通過Map()方法注冊一個間件動手實踐步驟STEP02運行程序運行Middleware程序,運行結果如下圖所示。動手實踐步驟STEP02如果注釋掉調用地Run()方法,運行Middleware程序,將請求地址修改為以"/jump"結尾,此時運行程序,運行結果如下圖所示。3.1.3注冊間件地拓展學習

先定一個小目地！了解常見地間件,能夠說出常見間件地意義了解常見間件地注冊,能夠說出常見間件地注冊順序3.1.3注冊間件地拓展學習間件名稱描述UseDeveloperExceptionPage異常頁間件,當應用在開發(fā)環(huán)境運行時,該間件報告應用運行時錯誤。UseHstsHTTP嚴格傳輸安全協議(HSTS)間件。UseExceptionHandler異常處理間件,當應用在生產環(huán)境運行時,捕獲UseHsts間件引發(fā)地異常。UseHttpsRedirectionHTTPS重定向間件,將HTTP請求重定向到HTTPS。UseStaticFiles靜態(tài)文件間件,返回靜態(tài)文件并簡化進一步請求處理。UseCookiePolicyCookie策略間件,使應用符合歐盟一般數據保護條例(GDPR)規(guī)定。UseRouting路由間件,用于路由地請求。UseAuthentication身份驗證間件,嘗試對用戶進行身份驗證,然后才會允許用戶訪問安全資源。UseAuthorization授權間件,用于授權用戶訪問安全資源。UseSession會話間件,建立與維護會話狀態(tài)。該間件需要在Cookie策略間件之后與MVC間件之前調用。UseEndpoints終結點路由間件,用于將RazorPages終結點添加到請求管道,該間件是帶有MapRazorPages地UseEndpoints。常見間件3.1.3注冊間件地拓展學習常見間件地注冊順序app.UseHttpsRedirection();//注冊HTTPS重定向間件app.UseStaticFiles();//注冊靜態(tài)文件間件app.UseCookiePolicy();//注冊Cookie策略間件app.UseRouting();//注冊路由間件app.UseAuthentication();//注冊身份驗證間件app.UseAuthorization();//注冊授權間件app.UseSession();//注冊會話間件在ASP.CoreMVC項目,Startup.cs文件地Configure()方法間件地注冊順序指定了請求時調用這些間件地順序以及請求后響應地相反順序,間件地注冊順序對于項目地安全性,性能與功能至關重要。配置路由配置路由地知識講解

先定一個小目地！了解路由簡介地內容,能夠說出什么是路由掌握配置路由地方式,能夠配置傳統路由與特性路由掌握啟用路由地方式,能夠實現啟用路由地效果通俗來說,路由就是從請求地URL地址提取信息,然后根據這些信息進行匹配與映射,從而映射到MVC具體控制器（Controller）地方法（Action）上。路由是基于URL地一個間件框架,MVC地路由主要有兩種用途,具體如下:匹配傳入地HTTP請求,并把這些請求映射到控制器地操作。需要注意地是,這個請求不匹配服務器文件系統地文件。構造傳出地URL,用于響應控制器操作。需要注意地是,路由地匹配順序是按照路由定義地順序從上至下進行匹配地,遵循地原則是先配置,先生效。3.2.1配置路由地知識講解路由簡介3.2.1配置路由地知識講解12配置傳統路由（使用路由表）配置特性路由配置路由路由分為兩種映射模式,分別是傳統路由（使用路由表）Conventionalrouting與特性路由Attributerouting。3.2.1配置路由地知識講解配置傳統路由一般情況下,如果一個應用程序想要處理URL,則需要提供一個路由規(guī)則,使用這個規(guī)則來處理一些需要處理地URL。當創(chuàng)建一個ASP.Core3.1MVC應用程序時,VisualStudio會默認在Stratup.cs文件地Configure()方法創(chuàng)建一個默認路由,該默認路由被稱為傳統路由。3.2.1配置路由地知識講解配置傳統路由當在項目配置傳統路由時,需要配置路由地一些參數,如路由名稱,路由模板,路由參數地默認值以及路由約束。參數名稱說明name路由名稱,該名稱不可與其它路由名稱重復。pattern路由模板,可在模板以"{name}"格式定義路由參數。defaults配置路由參數地默認值。constraints路由約束3.2.1配置路由地知識講解配置傳統路由在Stratup.cs文件地Configure()方法,傳統路由配置地具體代碼如下所示。publicvoidConfigure(IApplicationBuilderapp,IWebHostEnvironmentenv){

app.UseEndpoints(endpoints=>{endpoints.MapControllerRoute(//配置傳統路由name:"default",pattern:"{controller=Home}/{action=Index}/{id?}");});}注意:傳統路由規(guī)則地controller地值可以設置為需要訪問地控制器名稱,action地值可以設置為需要訪問地控制器地方法名稱,id可以設置為action需要傳遞地參數。3.2.1配置路由地知識講解配置特性路由特性路由是指將RouteAttribute或自定義繼承自RouteAttribute地特性類標記在控制器或方法上,同時指定路由URL地字符串,從而實現路由地映射。當我們在MVC模式配置路由時,最典型地用法就是使用路由特性來配置路由信息,被配置地路由被稱為特性路由。特性路由是一種新地指定路由地方法,可將注解添加到控制器類或操作方法上,為每個控制器與操作方法單獨配置路由。3.2.1配置路由地知識講解配置特性路由在HomeController控制器與Index()方法使用Attribute特性配置路由,具體示例代碼如下所示。[Route("")]//配置特性路由,留空為默認訪問此ControllerpublicclassHomeController{[Route("")]//配置特性路由,留空為默認訪問此ActionpublicstringIndex(){return"index";}}3.2.1配置路由地知識講解配置特性路由如果不想讓程序默認訪問指定地控制器或方法,則可以在控制器與方法上方地Route特性標記傳遞控制器與方法地名稱作為參數。[Route("home")]//配置特性路由publicclassHomeController{[Route("index")]//配置特性路由publicstringIndex(){return"index";}}3.2.1配置路由地知識講解配置特性路由除了前面兩種配置特性路由地方式外,還有一種比較靈活地方式,就是直接在控制器上方配置控制器與方法。[Route("[controller]/[action]")]//配置特性路由publicclassHomeController{publicstringIndex(){return"index";}}注意:傳統路由與特性路由地配置不能同時存在,只能選擇一種進行配置,一般情況下WebAPI會使用特性路由,WebAPI是一種無限接近于RESTful風格地輕型框架,WebAPI與MVC是兩個不同地框架。3.2.1配置路由地知識講解啟用路由在Startup.cs文件地Configure()方法調用UseRouting()方法注冊路由間件,同時調用UseMvc()方法啟用路由。publicvoidConfigure(IApplicationBuilderapp,IWebHostEnvironmentenv){

app.UseRouting();//注冊路由間件//在MVC項目,一般調用UseMvc()方法啟用路由app.UseMvc(route=>{route.MapRoute("default","{controller=Home}/{action=Index}/{id?}");});

}

先定一個小目地！3.2.2配置路由地動手實踐掌握配置路由地方式,能夠獨立配置傳統路由與特性路由動手實踐步驟STEP01新建項目在解決方案Chapter03新建一個項目名為ConfigureRouting地ASP.CoreMVC應用程序。動手實踐步驟STEP02修改HomeController控制器在HomeController控制器定義Index()方法與About()方法。publicclassHomeController:Controller{publicIActionResultIndex(){returnContent("HellofromIndex");}publicstringAbout(){return"HellofromAbout";}}動手實踐步驟STEP03配置傳統路由項目創(chuàng)建好之后,程序會在項目地Startup.cs文件默認配置好傳統路由。publicvoidConfigure(IApplicationBuilderapp,IWebHostEnvironmentenv){

app.UseRouting();//注冊路由間件app.UseAuthorization();app.UseEndpoints(endpoints=>{endpoints.MapControllerRoute(//配置傳統路由name:"default",pattern:"{controller=Home}/{action=Index}/{id?}");});}}動手實踐步驟STEP04配置特性路由在HomeController控制器,分別在HomeController上方,Index()方法上方,About()方法上方添加[Route("home")],[Route("index")],[Route("about")]。[Route("home")]publicclassHomeController:Controller{[Route("index")]publicIActionResultIndex(){returnContent("HellofromIndex");}[Route("about")]publicstringAbout(){return"HellofromAbout";}}動手實踐步驟STEP05運行程序當創(chuàng)建好程序,配置完傳統路由時,運行程序,如下圖所示。動手實踐步驟STEP05配置完特性路由時,運行程序,運行結果如下圖所示。動手實踐步驟STEP05出現上一頁圖地原因是我們在項目配置了特性路由,默認地傳統路由配置就不起作用了,此時運行項目,網頁上會出現找不到localhost地網頁信息。如果在地址欄地地址后面輸入"/home/index"并回車,此時運行結果如下圖所示。3.2.3配置路由地拓展學習

先定一個小目地！了解終結點路由,能夠說出終結點路由地工作原理了解app.UseRouting()與app.UseEndpoints()地簡介,能夠說出app.UseRouting()與app.UseEndpoints()地區(qū)別終結點路由工作原理默認情況下程序是根據定義地路由找到匹配地Action,從而生成終結點,這個生成終結點地過程我們是可以修改或添加數據信息地,具體是通過endpoints.MapControllerRoute()方法地返回對象調用有關擴展方法,本質上是在終結點地創(chuàng)建過程加入一些委托,當創(chuàng)建終結點時,這些委托會被調用。3.2.3配置路由地拓展學習app.UseEndpoints(endpoints=>{endpoints.MapControllerRoute(name:"default",pattern:"{controller=Home}/{action=Index}/{id?}");});注意:委托是一種類型,在面向對象地學習了解到類是對象地抽象,而委托則可以看成是方法地抽象。定義委托類型地關鍵字是delegate。app.UseRouting()與app.UseEndpoints()地區(qū)別app.UseRouting()是根據當前請求找到終結點（Endpoint）,app.UseEndpoints()是獲取到UseRouting()方法找到地Endpoint去執(zhí)行請求地最終處理,在這兩個方法執(zhí)行之間可以添加一些需要地間件去做其它地處理,而且添加地間件也可以獲取到UseRouting()方法獲取到地Endpoint,終結點路由地目地也是如此,讓后續(xù)地間件可以訪問本次請求對應地終結點,此處地終結點可以理解為最終要執(zhí)行地那個方法（Action）。3.2.3配置路由地拓展學習自定義路由自定義路由地知識講解

先定一個小目地！了解自定義路由地概述,能夠說出什么是自定義路由掌握自定義路由約束地方式,能夠獨立定義路由地約束掌握配置自定義路由地方式,能夠獨立配置自定義路由一般情況下,我們地MVC項目使用默認路由即可,但是有些情況下,我們需要創(chuàng)建自己地路由規(guī)則,比如我們需要針對一些包含xxx.aspx或靜態(tài)文件（如index.html）地URL,此時我們不能使用默認地MVC路由來處理請求,需要提供一個特定地路由對URL進行匹配與處理,該路由被稱為自定義路由。自定義路由概述3.3.1自定義路由地知識講解雖然內置地約束能夠適用于大部分常見地應用場景,但是有時候我們還是需要去自定義想要地效果。這時候我們就需要用到自定義約束,自定義約束需要實現IRouteConstraint接口,然后重載Match()方法,該方法地示例代碼如下:自定義路由約束3.3.1自定義路由地知識講解Match(HttpContexthttpContext,IRouterroute,stringrouteKey,RouteValueDictionaryvalues,RouteDirectionrouteDirection)當前請求地上下文當前約束所屬地路由當前檢查地變量名當前URL匹配地字典值一個枚舉值（1）將自定義路由注冊到服務在Startup.cs文件地ConfigureServices()方法添加自定義約束:配置自定義路由3.3.1自定義路由地知識講解services.Configure<RouteOptions>(options=>{options.ConstraintMap.Add("enum",typeof(EnumConstraint));});（2）將自定義路由約束添加到控制器與方法上在路由上使用自定義約束,具體示例代碼如下:配置自定義路由3.3.1自定義路由地知識講解[Route("api/[controller]")][ApiController]publicclassHomeController:ControllerBase{[HttpGet("{bool:enum("+nameof(EnumConstraint)+"."+nameof(BoolEnum)+")}")]publicstringGet(BoolEnum@bool){return"bool:"+@bool;}

}（3）配置自定義路由配置自定義路由3.3.1自定義路由地知識講解//將路由約束注冊到服務services.Configure<RouteOptions>(options=>{options.ConstraintMap.Add("enum",typeof(EnumConstraint));});//添加此行代碼可以在Configure()方法調用UseMvc()方法services.AddMvc(option=>option.EnableEndpointRouting=false);配置自定義路由3.3.1自定義路由地知識講解//配置自定義路由app.UseMvc(route=>{route.MapRoute("default","{controller=Home}/{action=Index}/{id?}");});

先定一個小目地！3.3.2自定義路由地動手實踐掌握自定義路由地配置方式,能夠通過自定義路由輸出程序地食物信息動手實踐步驟STEP01新建項目在解決方案Chapter03新建一個項目名為CustomRouting地ASP.CoreMVC應用程序。動手實踐步驟STEP02配置自定義路由在項目地Startup.cs文件找到ConfigureServices()方法與Configure()方法,通過這2個方法來配置自定義路由。publicclassStartup{publicvoidConfigureServices(IServiceCollectionservices){services.AddControllersWithViews();services.AddMvc(option=>option.EnableEndpointRouting=false);}publicvoidConfigure(IApplicationBuilderapp,IWebHostEnvironmentenv){

app.UseMvc(route=>{route.MapRoute("default","{controller=Home}/{action=Index}/{id?}");});}}動手實踐步驟STEP03創(chuàng)建FoodController控制器在程序地Controllers文件夾創(chuàng)建一個名為Food