如何自定义ASP.NET Core路由特性使Url.Action()返回正确的自定义URL

适配现有HttpGet/HttpPost特性的低成本方案 #

你当前遇到的Url.Action无法识别HttpMethod参数的问题，最简单的解决方法是给每个路由特性指定唯一的Name属性，直接用Url.RouteUrl生成链接，避免路由值匹配逻辑的干扰：

[HttpGet("mygeturl", Name = "IndexGet")]
[HttpPost("myposturl", Name = "IndexPost")]
public ActionResult IndexAsync()
{
    // 返回/mygeturl
    var getUrl = Url.RouteUrl("IndexGet");
    // 返回/myposturl
    var postUrl = Url.RouteUrl("IndexPost"); 

    return View();
}

自定义路由特性的完整实现方案 #

如果后续要替换为自己的自定义路由特性，且需要支持不依赖URL的匹配逻辑，同时兼容URL生成需求，按以下步骤实现：

1. 实现自定义路由特性 #

继承IRouteTemplateProvider提供路由模板，同时实现IActionConstraint接口编写不依赖URL的匹配逻辑（类似内置HttpMethod特性的实现逻辑）：

[AttributeUsage(AttributeTargets.Method, AllowMultiple = true)]
public class CustomRouteAttribute : Attribute, IRouteTemplateProvider, IActionConstraint
{
    // 路由模板
    public string Template { get; }
    // 路由优先级，保持和内置特性一致即可
    public int Order => 0;
    // 可选路由名
    public string? Name { get; set; }
    // 自定义匹配参数，可根据需求扩展为任意类型
    public string MatchKey { get; }

    public CustomRouteAttribute(string template, string matchKey)
    {
        Template = template;
        MatchKey = matchKey;
    }

    // 自定义请求匹配逻辑，此处示例为匹配请求方法，可替换为任意自定义规则（如请求头、Cookie等）
    public bool Accept(ActionConstraintContext context)
    {
        return context.RouteContext.HttpContext.Request.Method == MatchKey;
    }
}

2. 扩展UrlHelper支持自定义路由的URL生成 #

原生LinkGenerator只会将路由模板中存在的参数作为路由筛选条件，其他参数会自动转为查询字符串，因此我们扩展UrlHelper方法，加入自定义匹配逻辑：

public static class CustomUrlHelperExtensions
{
    public static string? ActionForCustomRoute(this IUrlHelper urlHelper, 
        string actionName, 
        string controllerName, 
        string matchKey, 
        object? routeValues = null)
    {
        // 获取全局Action描述符集合
        var actionProvider = urlHelper.ActionContext.HttpContext.RequestServices
            .GetRequiredService<IActionDescriptorCollectionProvider>();
        
        // 匹配目标Action
        var targetAction = actionProvider.ActionDescriptors.Items.FirstOrDefault(a =>
            a.RouteValues.TryGetValue("Action", out var act) && act == actionName &&
            a.RouteValues.TryGetValue("Controller", out var ctrl) && ctrl == controllerName);
        if (targetAction == null) return null;

        // 匹配符合自定义条件的路由模板
        var matchedRoute = targetAction.EndpointMetadata.OfType<CustomRouteAttribute>()
            .FirstOrDefault(r => r.MatchKey == matchKey);
        if (matchedRoute == null) return null;

        // 拼接路由值生成最终URL
        var baseUrl = urlHelper.Content($"~/{matchedRoute.Template.TrimStart('/')}");
        if (routeValues != null)
        {
            baseUrl += QueryString.Create(new RouteValueDictionary(routeValues)).ToString();
        }
        return baseUrl;
    }
}

3. 使用示例 #

[CustomRoute("mygeturl", "GET")]
[CustomRoute("myposturl", "POST")]
public ActionResult IndexAsync()
{
    // 生成GET对应URL：/mygeturl
    var getUrl = Url.ActionForCustomRoute("Index", "Home", "GET");
    // 生成POST对应URL：/myposturl?id=123
    var postUrl = Url.ActionForCustomRoute("Index", "Home", "POST", new { id = 123 });

    return View();
}

如果需要完全适配原生的Url.Action和LinkGenerator调用方式，不需要额外扩展方法，可以自定义实现IEndpointAddressScheme<RouteValuesAddress>接口，替换原生的路由地址匹配逻辑，在端点筛选阶段加入自定义参数的匹配规则即可。

内容的提问来源于stack exchange，提问作者Toni Haberle