欢迎光临
我的个人博客网站

ASP.NET Core如何自动生成小写的破折号路由

默认情况下,ASP.NET Core使用如 http://localhost:5000/HomeIndex 类的大驼峰路由。但是如果想使用小写的路由,并且这些路由用破折号分隔:http://localhost:5000/home-index它们比较常见且一致。

举例.NET常见路由 http://localhost:5000/User/ListPages 想要的效果 http://localhost:5000/user/list-pages

1、如何生成小写的路由可以这样设置

services.ConfigureRouting(setupAction => {     setupAction.LowercaseUrls = true; });

2、生成带破折号并且小写的路由可以这样设置

[Route("dashboard-settings")] class DashboardSettings:Controller {     public IActionResult Index() {         // ...     } }

似乎上面使用特性路由可以解决这个问题。但是我不想使用,因为每个action都要手动去设置,太繁琐也很容易出错。

我想要的效果是在程序中写个扩展类做到可配置处理。

3、解决方案

以下支持Asp.Net Core Version>=2.2

要做到这一点,首先创建SlugifyParameterTransformer类应该如下所示

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

3.1 对于Asp.Net Core2.2 MVC:

在StartUp中ConfiregeServices这样配置

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

路由如下配置:

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

3.2  对于Asp.Net Core2.2 Web API:

在StartUp中ConfiregeServices这样配置

public void ConfigureServices(IServiceCollection services) {     services.AddMvc(options =>      {         options.Conventions.Add(new RouteTokenTransformerConvention(new SlugifyParameterTransformer()));     }).SetCompatibilityVersion(CompatibilityVersion.Version_2_2); }

3.3 对于Asp.Net Core>=3.0 MVC:

在StartUp中ConfiregeServices这样配置

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

路由如下配置:

app.UseEndpoints(endpoints => {     endpoints.MapAreaControllerRoute(         name: "AdminAreaRoute",         areaName: "Admin",         pattern: "admin/{controller:slugify=Dashboard}/{action:slugify=Index}/{id:slugify?}");      endpoints.MapControllerRoute(         name: "default",         pattern: "{controller:slugify}/{action:slugify}/{id:slugify?}",         defaults: new { controller = "Home", action = "Index" }); });

3.4 对于Asp.Net Core>=3.0 Web API:

在StartUp中ConfiregeServices这样配置

services.AddControllers(options =>  {     options.Conventions.Add(new RouteTokenTransformerConvention(new SlugifyParameterTransformer())); });

3.5 对于Asp.Net Core>=3.0 Razor Pages:

在StartUp中ConfiregeServices这样配置

services.AddRazorPages(options =>  {     options.Conventions.Add(new PageRouteTransformerConvention(new SlugifyParameterTransformer())); });

这样会使/Sys/UserList路由变为/sys/user-list

3.6 对于上面MVC项目,路由模板要调整很多,其实还可以通过实现IControllerModelConvention来实现。

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 template = new StringBuilder();                      if (controllerAction.Controller.ControllerName != "Home")                     {                         template.Append(PascalToKebabCase(controller.ControllerName));                     }                      if (controllerAction.ActionName != "Index")                     {                         template.Append("/" + PascalToKebabCase(controllerAction.ActionName));                     }                      selector.AttributeRouteModel = new AttributeRouteModel()                     {                         Template = template.ToString()                     };                 }             }         }          public 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();         } }

在StartUp中ConfiregeServices这样配置

public void ConfigureServices(IServiceCollection services) {     // Add framework services.     services.AddMvc(options => options.Conventions.Add(new DashedRoutingConvention())); }

译文:https://stackoverflow.com/questions/40334515/automatically-generate-lowercase-dashed-routes-in-asp-net-core

赞(0) 打赏
未经允许不得转载:张拓的天空 » ASP.NET Core如何自动生成小写的破折号路由
分享到: 更多 (0)

评论 抢沙发

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址

专业的IT技术经验分享 更专业 更方便

联系我们本站主机

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

微信扫一扫打赏