.NET 6 继承基类控制器Route路由无法自动拼接问题如何解决

问题原因 #

你对ASP.NET Core特性路由的继承规则存在理解偏差，该问题不需要修改框架底层默认配置，属于特性路由的默认预期行为：
ASP.NET Core 内置的[Route]特性（即RouteAttribute）的Inherited属性显式设置为false，当子类（包括继承链上的非抽象中间类、抽象基类）自身标注了[Route]特性时，会完全覆盖继承链上所有父类定义的控制器级路由模板，不会做追加拼接。
你的三层控制器结构每层都单独标注了[Route]：

1. 中间层CollectionControllerBase的路由已经覆盖了顶层ModuleControllerBase的路由片段
2. 最外层业务控制器WorkOrderLineController的路由又进一步覆盖了中间层的路由片段
   最终框架识别到的控制器级路由只有[controller]这一段，Swagger是直接读取框架生成的端点路由数据的，自然只会展示这部分路由。

另外你在三层控制器上重复标注[ApiController]是多余的，该特性默认支持继承，基类标注后子类无需重复添加。

解决方案 #

根据你的业务场景选其中一种即可：

方案1：直接在业务控制器写全路由模板（零额外代码，适合基类派生控制器少的场景）

移除两层抽象基类上的[Route]特性，直接在最终的业务控制器上定义完整路由模板即可：

[ApiController]
[Produces("application/json")]
public abstract class ModuleControllerBase : ControllerBase
{
    // 内部逻辑保留
}

public abstract class CollectionControllerBase : ModuleControllerBase
{
    // 内部逻辑保留
}

[ApiController]
[Route("modules/example/v{apiVersion:apiVersion}/subsidiary/{subsidiaryId:int:required}/branch/{branchId:int:required}/[controller]")]
public class WorkOrderLineController : CollectionControllerBase
{
    // 端点逻辑保留
}

该方式优点是实现简单，路由路径直观可见；缺点是如果有大量控制器派生自同一基类，会存在重复的路由前缀片段，后续修改公共前缀需要逐个调整。

方案2：自定义控制器模型约定，自动拼接继承链路由前缀（适合多控制器复用基类的场景）

如果需要保留分层定义路由片段的开发习惯，避免重复写公共前缀，可以通过实现IApplicationModelConvention扩展框架的路由加载逻辑，自动收集继承链上的路由片段完成拼接：

1. 首先定义用于标记分层路由前缀的自定义特性：

[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true)]
public class RoutePrefixAttribute : Attribute
{
    public string Prefix { get; }
    public RoutePrefixAttribute(string prefix)
    {
        Prefix = prefix?.Trim('/') ?? throw new ArgumentNullException(nameof(prefix));
    }
}

2. 实现路由拼接约定，在应用启动时遍历所有控制器，沿继承链收集路由片段完成拼接：

public class InheritRoutePrefixConvention : IApplicationModelConvention
{
    public void Apply(ApplicationModel application)
    {
        foreach (var controller in application.Controllers)
        {
            var prefixStack = new Stack<string>();
            var currentType = controller.ControllerType;

            // 向上遍历继承链直到ControllerBase基类
            while (currentType != null && currentType != typeof(ControllerBase))
            {
                // 收集当前层级定义的路由前缀
                var prefixAttr = currentType
                    .GetCustomAttributes(typeof(RoutePrefixAttribute), false)
                    .OfType<RoutePrefixAttribute>()
                    .FirstOrDefault();
                if (prefixAttr != null)
                {
                    prefixStack.Push(prefixAttr.Prefix);
                }

                // 收集非抽象叶节点控制器上的Route特性作为路由最后一段
                var routeAttr = currentType
                    .GetCustomAttributes(typeof(RouteAttribute), false)
                    .OfType<RouteAttribute>()
                    .FirstOrDefault();
                if (routeAttr != null && !currentType.IsAbstract)
                {
                    prefixStack.Push(routeAttr.Template);
                    controller.Selectors.Clear();
                }

                currentType = currentType.BaseType;
            }

            if (prefixStack.Count == 0) continue;

            // 按从基类到子类的顺序拼接完整路由模板
            var fullRouteTemplate = string.Join("/", prefixStack);
            controller.Selectors.Add(new SelectorModel
            {
                AttributeRouteModel = new AttributeRouteModel
                {
                    Template = fullRouteTemplate
                }
            });
        }
    }
}

3. 改造各层控制器的特性标注，抽象基类用[RoutePrefix]定义公共片段，业务控制器保留原[Route]特性：

[ApiController]
[Produces("application/json")]
[RoutePrefix("modules/example/v{apiVersion:apiVersion}")]
public abstract class ModuleControllerBase : ControllerBase
{
    // 内部逻辑保留
}

[RoutePrefix("subsidiary/{subsidiaryId:int:required}/branch/{branchId:int:required}")]
public abstract class CollectionControllerBase : ModuleControllerBase
{
    // 内部逻辑保留
}

[Route("[controller]")]
public class WorkOrderLineController : CollectionControllerBase
{
    // 端点逻辑保留
}

4. 在Program.cs中注册该约定即可生效：

builder.Services.AddControllers(options =>
{
    options.Conventions.Add(new InheritRoutePrefixConvention());
});
// Swagger相关配置不需要额外修改，会自动识别拼接后的路由

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