ASP.NET Core如何自动生成小写的破折号路由
2021-02-19 12:01
483 查看
默认情况下,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
相关文章推荐
- asp.net core生成路由连接,请求参数如何获取和模型绑定
- 如何在ASP.NET页面中自动生成并显示透明的GIF图片
- 在 ASP.NET Core 项目中实现小写的路由URL
- asp.net Core使用EF Core自动生成博客/帖子的创建日期
- 在 ASP.NET Core 项目中实现小写的路由URL
- 如何使用 asp.net 4.0 新特性 路由功能 有助于seo优化 给一个 asp.net web项目(网站项目) 增加路由功能 ,继承,给根据路由生成的url的结尾,增加一个有利于seo优化的斜杠 /,跳转到一个路由生成的url页面
- 用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档
- 详解ASP.NET Core 2.0 路由引擎之网址生成(译)
- ASP.NET Web API如何将注释自动生成帮助文档
- asp.net程序中如何自动生成姓名拼音
- 用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档
- 【.NetCore学习】ASP.NET Core EF Core2.0 DB First现有数据库自动生成实体Context
- ASP.NET Web API如何将注释自动生成帮助文档
- Asp.NetCore1.1版本去掉project.json后如何打包生成跨平台包
- 使用 Swagger 自动生成 ASP.NET Core Web API 的文档、在线帮助测试文档(ASP.NET Core Web API 自动生成文档)
- [译]ASP.NET Core 2.0 路由引擎之网址生成
- 如何处理ASP.NET Core中HTML5客户端路由回退的问题
- 使用 Swagger 自动生成 ASP.NET Core Web API 的文档、在线帮助测试文档(ASP.NET Core Web API 自动生成文档)
- 如何在asp.net中用C#自动生成透明的GIF图片
- ASP.NET Core 中文文档 第二章 指南(4.10)检查自动生成的Detail方法和Delete方法