ASP.NET Core 2.0自定义路由与版本控制：中间件修改请求路径问询

嘿，我来帮你梳理下这个实现里的关键点和可能踩的坑，还有一些优化思路：

首先，你的核心思路是通过中间件改写请求路径，把ToDoItemDto插入到路由中适配控制器的API版本路由规则，这个方向是可行的，但有几个细节需要重点注意：

1. 中间件执行顺序是核心前提 #

ASP.NET Core的中间件是按注册顺序执行的，请求进来会先经过先注册的中间件，再往后传递。所以你的自定义路径修改中间件必须在UseMvc之前注册，不然路由匹配逻辑已经跑完了，你再修改路径根本不会生效。

举个Startup里的正确注册示例：

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    // 先注册你的路径改写中间件
    app.UseMiddleware<YourPathRewriteMiddleware>();
    
    // 再注册MVC中间件，让路由系统处理修改后的路径
    app.UseMvc();
}

2. 路径解析逻辑要严谨，避免踩坑 #

你当前用字符串拼接的方式构造新路径，容易出现斜杠冗余（比如末尾多出来的/）或者解析错误的情况。建议用ASP.NET Core提供的PathString类来处理路径，它会自动帮你处理斜杠问题：

public async Task Invoke(HttpContext context)
{
    var originalPath = context.Request.Path;
    // 解析原路径，假设原路径格式是 /api/v{version}/{controller}/{剩余路径}
    var pathSegments = originalPath.Value.Split(new[] {'/'}, StringSplitOptions.RemoveEmptyEntries);
    
    // 先做合法性校验，避免非法路径导致报错
    if (pathSegments.Length >= 3 && pathSegments[0].Equals("api", StringComparison.OrdinalIgnoreCase) 
        && pathSegments[1].StartsWith("v", StringComparison.OrdinalIgnoreCase))
    {
        var version = pathSegments[1].Substring(1); // 从v1/v2中提取版本号
        var controller = pathSegments[2];
        var remainingPath = pathSegments.Length > 3 ? string.Join("/", pathSegments.Skip(3)) : string.Empty;
        
        // 用PathString构造新路径，自动处理斜杠
        var basePath = new PathString($"/{version}/{controller}/ToDoItemDto");
        var remainingPathStr = string.IsNullOrEmpty(remainingPath) ? PathString.Empty : new PathString($"/{remainingPath}");
        context.Request.Path = basePath.Add(remainingPathStr);
    }
    
    await _next(context);
}

3. 控制器路由与动作路由要匹配 #

你的控制器路由是[Route("api/v{version:apiVersion}/[controller]")]，修改后的路径是/{version}/{controller}/ToDoItemDto/{remainingPath}，对应的控制器动作方法需要配置匹配的路由，比如：

[ApiController]
[Route("api/v{version:apiVersion}/[controller]")]
[ApiVersion("1")]
public class ToDoController : ControllerBase
{
    // 匹配修改后的路径：/v1/ToDo/ToDoItemDto/{id}，对应原路由规则就是 api/v1/ToDo/ToDoItemDto/{id}
    [HttpGet("ToDoItemDto/{id}")]
    public IActionResult GetTodoItem(int id, ApiVersion version)
    {
        // 返回你的ToDoItemDto实例
        return Ok(new ToDoItemDto { Id = id, Version = version.ToString() });
    }
}

4. API版本服务的配置不能忘 #

既然你用了apiVersion路由约束，必须在ConfigureServices中正确注册API版本服务，否则版本号无法被正确解析：

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc();
    // 注册API版本服务，配置默认版本等规则
    services.AddApiVersioning(options =>
    {
        options.AssumeDefaultVersionWhenUnspecified = true;
        options.DefaultApiVersion = new ApiVersion(1, 0);
    });
}

更优雅的替代方案：用属性路由替代中间件 #

其实如果你的需求是给ToDoController的所有动作统一加上ToDoItemDto前缀，完全可以不用中间件，直接修改控制器的路由特性就能实现，这样更符合ASP.NET Core的路由设计，也减少了中间件的复杂度：

[ApiController]
// 直接把ToDoItemDto加到控制器路由里
[Route("api/v{version:apiVersion}/[controller]/ToDoItemDto")]
[ApiVersion("1")]
public class ToDoController : ControllerBase
{
    // 动作路由只需要写剩余部分即可
    [HttpGet("{id}")]
    public IActionResult GetTodoItem(int id, ApiVersion version)
    {
        return Ok(new ToDoItemDto { Id = id, Version = version.ToString() });
    }
}

这样一来，原请求/api/v1/ToDo/ToDoItemDto/1就能直接匹配到这个动作，不需要中间件改写路径，逻辑更清晰也更易维护。

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