構建可讀性更高的 ASP.NET Core 路由 原文:構建可讀性更高的 ASP.NET Core 路由

?一、前言

　　不知你在平時上網(wǎng)時有沒有注意到，絕大多數(shù)網(wǎng)站的 URL 地址都是小寫的英文字母，而我們使用 .NET/.NET Core MVC 開發(fā)的項目，因為在 C# 中類和方法名采用的是 Pascal 命名規(guī)范，根據(jù) .NET 框架默認的路由規(guī)則，項目的 URL 地址會呈現(xiàn)出大小寫混合的情況。對于強迫癥來說，這種情況絕對不能忍，當然，由于整個項目的 URL 地址大小寫混合顯示，也無法更清晰的向用戶、瀏覽器表達出當前頁面的功能。那么，這篇文章就來介紹下，如何調(diào)整我們的 ASP.NET Core 項目的路由規(guī)則，從而使我們項目的 URL 地址可讀性更高。

　　PS：在構建 URL 的過程中，采用大寫的地址還是采用小寫的地址，每個人都會有自己的想法和這樣做的理由，這篇文章不討論兩種方案的優(yōu)劣，只是提供一種構建小寫 URL 地址以及讓我們的 URL 可讀性更高的解決方案，請友善觀看，切勿互懟。

　　代碼倉儲：https://github.com/Lanesra712/grapefruit-common

?二、Step by Step

　　在構建項目的路由時，不管是采用大寫的 URL 路由，還是采用小寫的 URL 路由，我們首先需要確保的是，我們需要將整個項目的 URL 格式進行統(tǒng)一。不能說一個項目一部分的 URL 地址用大寫的，而另一部分采用的是小寫的 URL 地址。同時，同一個頁面的大寫的路徑以及小寫的路徑，雖然最終服務器可能都會將兩個地址指向同一個頁面，但是對于搜索引擎的收錄來說，這無疑是兩個頁面。

　　試想以下，當別人告訴了我們一個有趣的網(wǎng)站，我們從瀏覽器的地址欄中輸入網(wǎng)址進行訪問。當我們輸入 URL 地址時，不管是中文輸入法還是英文輸入法，輸出的英文字母都是小寫的，此時，如果輸入的網(wǎng)址中存在大寫字母，嗯，我們還需要使用 CapsLock 鍵進行大小寫切換。

　　另外，我們知道，對于 Windows 服務器來說，因為對于路徑的大小寫不敏感，如果我們弄錯了地址的大小寫，我們還是可以進行正常的訪問的，可是，如果將應用部署到 Linux 服務器上的話。。。。

　　至于更好的可讀性，這個概念可能會顯得有些主觀。簡單來說，就是當我們面對一個網(wǎng)址時，我們可以很清楚的通過這個網(wǎng)址知道這個網(wǎng)頁的主要內(nèi)容。例如，當我們看見www.youdomain.com/editor/post/new 這個網(wǎng)址時，雖然可能并沒有打開這個網(wǎng)頁，但我們還是可以大致猜到這個頁面可能是新增文章的。可是，如果你收到的網(wǎng)址是 www.youdomain.com/9rg7f2/i?HXI-D+iaj34 這樣的，沒人能知道這個頁面到底是干啥的。

　　因此，為了便捷輸入，首先我們需要將我們的 URL 地址轉(zhuǎn)換成小寫的形式，在 ASP.NET Core 中，微軟提供了 RoutingServiceCollectionExtensions.AddRouting 這個擴展方法可以讓我們將 URL 地址轉(zhuǎn)換成小寫。
　　打開項目的 Startup.cs 文件，找到 ConfigureServices 方法，在方法體內(nèi)添加下面的代碼。

services.AddRouting(options => {options.LowercaseUrls = true; });

　　示例項目的頂部鏈接代碼如下所示，運行項目可以看到，通過設置小寫路由后，程序根據(jù) Controller 和 Action 自動生成的 URL 地址全部變成了小寫。仔細觀察可以發(fā)現(xiàn)，這里會出現(xiàn)一個問題。在某些特殊的情況下，Area/Controller/Action 可能是由多個英文字母拼接而成的一個混合英文單詞，如果把這個混合的單詞全部進行小寫而不進行拆分的話，整個項目的 URL 可讀性更低了。

<header><nav class="navbar navbar-expand-sm navbar-toggleable-sm navbar-light bg-white border-bottom box-shadow mb-3"><div class="container"><a class="navbar-brand" asp-area="" asp-controller="Home" asp-action="Index">Sample</a><button class="navbar-toggler" type="button" data-toggle="collapse" data-target=".navbar-collapse" aria-controls="navbarSupportedContent"aria-expanded="false" aria-label="Toggle navigation"><span class="navbar-toggler-icon"></span></button><div class="navbar-collapse collapse d-sm-inline-flex flex-sm-row-reverse"><ul class="navbar-nav flex-grow-1"><li class="nav-item"><a class="nav-link text-dark" asp-area="" asp-controller="Home" asp-action="Index">Home</a></li><li class="nav-item"><a class="nav-link text-dark" asp-area="" asp-controller="Home" asp-action="Privacy">Privacy</a></li><li class="nav-item"><a class="nav-link text-dark" asp-area="" asp-controller="Post" asp-action="DraftSetting">Draft Setting</a></li></ul></div></div></nav> </header>

　　在 Startup 類中的 Configure 方法里，我們定義了針對包含 Area 和不包含 Area 的兩個路由模板，整個項目的 URL 都是根據(jù)這兩個模板進行生成的。那么這里我們是不是可以通過對單個 Controller 或是 Action 指定特殊的 URL 格式呢？

app.UseMvc(routes => {routes.MapRoute(name: "default",template: "{controller=Home}/{action=Index}/{id?}");routes.MapRoute(name: "areas",template: "{area:exists}/{controller=Home}/{action=Index}/{id?}"); });

　　答案當然是可以的。在 ASP.NET Core 中，我們可以通過在 Controller 或是 Action 方法上添加 RouteAttribute 的方式將用戶自定義路由信息添加到項目的路由表中。例如這里我在 DraftSetting 這個 Action 上使用特性路由的方式手動指定當前 Action 生成特殊的 URL 格式。?

public class PostController : Controller {[Route("post/draft-setting")]public IActionResult DraftSetting(){return View();} }

　　雖然這樣可以解決我們的問題，可以一旦項目有新增頁面時，就要手動的指定特性路由地址，這樣似乎有些麻煩。那么，如何自動的讓程序幫我們實現(xiàn)這一功能呢？

　　在 ASP.NET Core 2.2 版本中，微軟為我們提供了參數(shù)轉(zhuǎn)換器這一概念，我們可以通過實現(xiàn) IOutboundParameterTransformer 這個接口，從而將 URL 中路由的值或者是 URL 中路由參數(shù)的值按照我們的需求進行轉(zhuǎn)換。就像下面的代碼中，我通過實現(xiàn)這個接口，從而實現(xiàn)將多個英文單詞生成的混合單詞以 hyphen(-) 的形式進行分隔。

public class SlugifyParameterTransformer : IOutboundParameterTransformer {public string TransformOutbound(object value){return value == null? null: Regex.Replace(value.ToString(), "([a-z])([A-Z])", "$1-$2").ToLower();} }

　　這里我使用 hyphen(-) 作為 URL 中各個單詞間的連字符，是因為對于搜索引擎來說，它會將 - 視為單詞間分隔符，采用這種風格的 URL 更有利于搜索引擎收錄。

　　當接口功能實現(xiàn)之后，我們就需要對我們的默認全局路由進行修改。首先，我們需要在路由模板上指定需要替換的路由參數(shù)，這里我們指定 Area、Controller、Action 是需要進行路由參數(shù)轉(zhuǎn)換的變量。

app.UseMvc(routes => {routes.MapRoute(name: "default",template: "{controller:slugify=Home}/{action:slugify=Index}/{id?}");routes.MapRoute(name: "areas",template: "{area:exists:slugify}/{controller:slugify=Home}/{action:slugify=Index}/{id?}"); });

　　當定義好參數(shù)轉(zhuǎn)換器以及需要轉(zhuǎn)換的 URL 路由參數(shù)后，我們就可以在 AddRouting 方法中通過 ConstraintMap 進行配置需要轉(zhuǎn)換的參數(shù)路由值。至此就可以完成我們進行路由參數(shù)轉(zhuǎn)換的結果。

services.AddRouting(options => {options.ConstraintMap["slugify"] = typeof(SlugifyParameterTransformer);options.LowercaseUrls = true; });

?

?三、總結

?　　?在本章中，我們主要是調(diào)整了 ASP.NET Core 項目中的默認路由，從而使項目的 URL 地址具有更好的可讀性。通過使用小寫路由和 hyphen(-) 路由，只是構建可讀性更高的 URL 地址的第一步，在構建頁面時，我們更應該考慮的是如何使用少數(shù)的單詞就可以讓用戶清楚當前頁面的功能，更簡短，更易讀的 URL 不僅對于用戶，對于搜索引擎也是更友好的。

posted on 2019-05-31 14:41 NET未來之路 閱讀(...) 評論(...) 編輯 收藏

轉(zhuǎn)載于:https://www.cnblogs.com/lonelyxmas/p/10955158.html

總結

以上是生活随笔為你收集整理的构建可读性更高的 ASP.NET Core 路由的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。