ASP.NET CORE MVC 实现减号分隔(Kebab case)样式的 URL
ASP.NET CORE MVC 中,默認的 Route 模板是:?/{controller}/{action}? 。我們可以通過開啟 URL 小寫轉換將 URL 變為小寫,但此方式在 Controller 或者 Action 為一個詞組時,生成的 URL 并不友好。假設我們有 UserController 和 AddUser 方法,則框架生成的 URL 可能是:?/User/AddUser?,在開啟小寫轉換的情況下可能是下面的結果:?/user/adduser?。包含大寫字符的 URL 并沒有問題,但是小寫的 URL 更加常規,而完全轉換小寫造成的問題就是 URL 的可讀性很差。本文將提供一些代碼,幫助框架生成減號分隔樣式的 URL ,當應用了這些代碼以后,生成的 URL 類似這樣:?/user/add-user?。
微軟為我們提供了 RouteAttribute ,可以對 Controller 或者 Action 進行標記,以達到自定義訪問路徑的目的。這種方式非常強大,但在項目較大的情況下使用起來有些繁雜。畢竟手工對每一個 Controller 和 Action 進行標記也有不小的工作量。
ASP.NET CORE MVC 框架中定義了一個?IControllerModelConvention?接口,我們可以實現該接口在運行時為 Action 附加一個 Route 模型。在項目中新建?DashedRoutingConvention 類文件,代碼如下:
???public class DashedRoutingConvention : IControllerModelConvention
????{
????????public void Apply(ControllerModel controller)
????????{
????????????var hasRouteAttributes = controller.Selectors.Any(selector =>
????????????????selector.AttributeRouteModel != null);
????????????if (hasRouteAttributes)
????????????{
????????????????// This controller manually defined some routes, so treat this
????????????????// as an override and not apply the convention here.
????????????????return;
????????????}
?
????????????foreach (var controllerAction in controller.Actions)
????????????{
????????????????foreach (var selector in controllerAction.Selectors.Where(x => x.AttributeRouteModel == null))
????????????????{
????????????????????var parts = new List<string>();
????????????????????foreach (var attr in controller.Attributes)
????????????????????{
????????????????????????if (attr is AreaAttribute area)
????????????????????????{
????????????????????????????parts.Add(area.RouteValue);
????????????????????????}
????????????????????}
?
????????????????????if (
????????????????????????parts.Count == 0
????????????????????????&& controller.ControllerName == "Home"
????????????????????????&& controllerAction.ActionName == "Index"
????????????????????)
????????????????????{
????????????????????????continue;
????????????????????}
?
????????????????????parts.Add(PascalToKebabCase(controller.ControllerName));
?
????????????????????if (controllerAction.ActionName != "Index")
????????????????????{
????????????????????????parts.Add(PascalToKebabCase(controllerAction.ActionName));
????????????????????}
?
????????????????????selector.AttributeRouteModel = new AttributeRouteModel
????????????????????{
????????????????????????Template = string.Join("/", parts)
????????????????????};
????????????????}
????????????}
????????}
?
????????private static string PascalToKebabCase(string value)
????????{
????????????if (string.IsNullOrEmpty(value))
????????????{
????????????????return value;
????????????}
?
????????????return Regex.Replace(
????????????????????value,
????????????????????"(?<!^)([A-Z][a-z]|(?<=[a-z])[A-Z])",
????????????????????"-$1",
????????????????????RegexOptions.Compiled)
????????????????.Trim()
????????????????.ToLower();
????????}
????}
之后,將?DashedRoutingConvention 在?Startup.cs 中注冊。
public void ConfigureServices(IServiceCollection services)
{
????// Add framework services.
????services.AddMvc(options => options.Conventions.Add(new DashedRoutingConvention()));
}
至此,全部代碼完畢。
Notices:
本代碼支持 Area ,并會對 Area 名稱也進行轉義。
本代碼使用自定義路由的方式實現功能,所以可能對預定義路由有影響。
更多與路由相關的信息可參見:https://docs.microsoft.com/en-us/aspnet/core/mvc/controllers/routing
本代碼參考了其他代碼,詳見:https://stackoverflow.com/questions/40334515/automatically-generate-lowercase-dashed-routes-in-asp-net-core
碼農很忙授權中心已經啟用了本代碼,演示:https://passport.coderbusy.com/
原文:https://www.coderbusy.com/archives/956.html
.NET社區新聞,深度好文,歡迎訪問公眾號文章匯總 http://www.csharpkit.com
總結
以上是生活随笔為你收集整理的ASP.NET CORE MVC 实现减号分隔(Kebab case)样式的 URL的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: BXUG第11期活动
- 下一篇: 拥抱.NET Core系列:Memory