Microsoft.AspNetCore.Routing · Magic_sword2

[TOC] # 简介说明 原文链接： - [路由约束](https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/routing?view=aspnetcore-5.0#route-constraint-reference) ``` 版本：Microsoft.AspNetCore.Routing 作用：dotnet core web 路由模块 ``` # Microsoft.AspNetCore.Routing.IRouteTemplateProvider # [it]-IRouteTemplateProvider() ***** 自定义路由模板，[参考](https://docs.microsoft.com/zh-cn/aspnet/core/mvc/controllers/routing?view=aspnetcore-5.0#ar) ### 示例内容 1. 举例说明 ``` public class MyApiControllerAttribute : Attribute, IRouteTemplateProvider { public string Template => "api/[controller]"; public int? Order => 2; public string Name { get; set; } } [MyApiController] [ApiController] public class MyTestApiController : ControllerBase { // GET /api/MyTestApi [HttpGet] public IActionResult Get() { return ControllerContext.MyDisplayRouteInfo(); } } ``` # Microsoft.AspNetCore.Routing.RouteHandler # [new]-RouteHandler() ***** 路由控制器 # Microsoft.AspNetCore.Routing.RouteBuilder # [new]-RouteBuilder() ***** 构建路由对象 ### 示例内容 1. 举例说明 ``` var trackPackageRouteHandler = new RouteHandler(context => { var routeValues = context.GetRouteData().Values; return context.Response.WriteAsync( $"Hello! Route values: {string.Join(", ", routeValues)}" ); }); var routeBuilder = new RouteBuilder(app, trackPackageRouteHandler); routeBuilder.MapRoute( "Track Package Route", "package/{operation:regex(^track|create|detonate$)}/{id:int}"); routeBuilder.MapGet("hello/{name}", context => { var name = context.GetRouteValue("name"); // This is the route handler when HTTP GET "hello/<anything>" matches // To match HTTP GET "hello/<anything>/<anything>, // use routeBuilder.MapGet("hello/{*name}" return context.Response.WriteAsync($"Hi, {name}!"); }); var routes = routeBuilder.Build(); app.UseRouter(routes); ``` # Microsoft.AspNetCore.Routing.RouteValueDictionary # [new]-RouteValueDictionary() ***** 路由值字典 ### 示例内容 1. 举例说明 ``` app.Run(async (context) => { var dictionary = new RouteValueDictionary { { "operation", "create" }, { "id", 123} }; var vpc = new VirtualPathContext(context, null!, dictionary, "Track Package Route"); var path = routes.GetVirtualPath(vpc).VirtualPath; context.Response.ContentType = "text/html"; await context.Response.WriteAsync("Menu<hr/>"); await context.Response.WriteAsync($"<a href='{path}'>Create Package 123</a> "); }); ``` # Microsoft.AspNetCore.Routing.IEndpointRouteBuilder # Map() ***** 映射路由 # MapGet() ***** 映射Get路由和委托 # MapControllers() ***** 映射控制器 # MapDefaultControllerRoute() ***** 映射默认控制器路由 ### 示例内容 1. 举例说明 ``` // 等同于下述方法 app.UseEndpoints(endpoints => { endpoints.MapControllerRoute( name: "default", pattern: "{controller=Home}/{action=Index}/{id?}" ); }); ``` # MapControllerRoute() ***** 映射控制器路由 ### 示例内容 1. 传统路由 ``` endpoints.MapControllerRoute( name: "default", pattern: "{controller=Home}/{action=Index}/{id?}" ); ``` # MapAreaControllerRoute() ***** 映射控制器区域路由 # MapRazorPages() ***** 映射Razor页面视图 # Microsoft.AspNetCore.Routing.IRouteConstraint # [it]-IRouteConstraint() ***** 自定义路由匹配器 ### 示例内容 1. 举例说明 ``` public enum BoolEnum { True, False } public class EnumConstraint : IRouteConstraint { private Type _enumType; public EnumConstraint(string enumTypeName) { _enumType = Type.GetType(enumTypeName); } public bool Match(HttpContext httpContext, IRouter route, string routeKey, RouteValueDictionary values, RouteDirection routeDirection) { var value = values[routeKey]; if (value == null) { return false; } if (Enum.TryParse(_enumType, value.ToString(), out object result)) { if (Enum.IsDefined(_enumType, result)) { return true; } } return false; } } services.Configure<RouteOptions>(options => { options.ConstraintMap.Add("enum", typeof(EnumConstraint)); }); ``` # Microsoft.AspNetCore.Routing.LinkGenerator # [new]-LinkGenerator() ***** 路由反向生成 ### 示例内容 1. 举例说明 ``` public void Index([FromServices] LinkGenerator linkGenerator) { linkGenerator.GetPathByAction(HttpContext, controller: "Order", action: "Reque", values: new {name = "abc"} ); } ``` # GetPathByAction() ***** GetPathByAction # GetUriByAddress() ***** GetUriByAddress