Asp.Net Core区域控制器路由支持带Controller后缀路径的问题

问题场景 #

在Asp.Net Core的Areas中存在多个控制器（如CustomerController、OrderController），希望同时支持以下两种路径路由到对应控制器：

• /Area/Customer/{action}
• /Area/CustomerController/{action}

这么做的目的是能用C#的nameof()运算符在编译时验证控制器名称的有效性——毕竟nameof(CustomerController)会直接生成"CustomerController"字符串，能避免手写控制器名称时的拼写错误。

最初尝试的路由配置 #

一开始配置了四条路由规则：

app.MapControllerRoute(
    name: "areas",
    pattern: "{area:exists}/{controller=Account}/{action=Login}/{id?}"
);

app.MapControllerRoute(
  name: "areasWithSuffix",
  pattern: "{area:exists}/{controller=Account}Controller/{action=Login}/{id?}"
);

app.MapControllerRoute(
    name: "default",
    pattern: "{controller=Account}/{action=Login}/{id?}");

app.MapControllerRoute(
    name: "defaultWithSuffix",
    pattern: "{controller=Account}Controller/{action=Login}/{id?}");

遇到的问题 #

初期测试看似正常，但当多个控制器存在同名Action（比如MyAction）时，访问/Area/CustomerController/MyAction会抛出Microsoft.AspNetCore.Routing.Matching.AmbiguousMatchException异常，提示请求匹配多个端点；而访问/Area/Customer/MyAction则能正常路由。

解决方案 #

问题出在Asp.Net Core的路由匹配逻辑上：当使用带Controller后缀的路径时，系统会同时尝试匹配CustomerController（原名称）和Customer（自动去掉后缀后的名称）对应的控制器，导致歧义。我们可以通过自定义路由约束来解决这个问题。

步骤1：创建自定义路由约束 #

实现IRouteConstraint接口，用于过滤控制器名称，确保只有正确匹配的控制器才会被选中：

public class ControllerNameConstraint : IRouteConstraint
{
    public bool Match(HttpContext httpContext, IRouter route, string routeKey, RouteValueDictionary values, RouteDirection routeDirection)
    {
        if (!values.TryGetValue(routeKey, out var value) || value is not string controllerName)
        {
            return false;
        }

        // 处理带Controller后缀的情况，去掉后缀后验证
        var targetName = controllerName.EndsWith("Controller", StringComparison.OrdinalIgnoreCase)
            ? controllerName[0..^10] // 截断"Controller"后缀（长度10）
            : controllerName;

        // 检查是否存在对应名称的控制器
        var controllerTypes = httpContext.RequestServices
            .GetRequiredService<IActionDescriptorCollectionProvider>()
            .ActionDescriptors.Items
            .Select(ad => ad.RouteValues["controller"])
            .Distinct(StringComparer.OrdinalIgnoreCase);

        return controllerTypes.Contains(targetName, StringComparer.OrdinalIgnoreCase);
    }
}

步骤2：注册自定义约束 #

在Program.cs中把自定义约束注册到路由系统：

builder.Services.Configure<RouteOptions>(options =>
{
    options.ConstraintMap.Add("controllerName", typeof(ControllerNameConstraint));
});

步骤3：更新路由配置 #

修改原来的路由规则，给controller参数加上自定义约束，确保匹配逻辑正确：

app.MapControllerRoute(
    name: "areas",
    pattern: "{area:exists}/{controller:controllerName=Account}/{action=Login}/{id?}"
);

app.MapControllerRoute(
    name: "areasWithSuffix",
    pattern: "{area:exists}/{controller:controllerName=Account}Controller/{action=Login}/{id?}"
);

app.MapControllerRoute(
    name: "default",
    pattern: "{controller:controllerName=Account}/{action=Login}/{id?}");

app.MapControllerRoute(
    name: "defaultWithSuffix",
    pattern: "{controller:controllerName=Account}Controller/{action=Login}/{id?}");

原理说明 #

自定义约束会在路由匹配时对控制器名称做处理：

1. 如果路径中的控制器名称带Controller后缀，会先去掉后缀再去匹配实际的控制器
2. 只返回存在对应控制器的匹配结果，避免系统同时匹配到多个控制器引发歧义

这样既支持了两种路径的访问，又能通过nameof(CustomerController)生成带后缀的路径，满足编译时验证的需求。

内容的提问来源于stack exchange，提问作者Martin Robins