.NET 5 如何条件性禁用MVC控制器且保持API控制器正常可用

当配置项Configuration["MVC"]为"false"时，不需要改动原有控制器代码，只需要在预留的判断分支中补充对应逻辑即可，核心目标是阻断所有非/api路径的MVC控制器请求流转，同时完全不干扰API控制器的正常响应。

路径拦截实现（适配现有管道结构） #

在预留的判断分支中插入路径拦截中间件即可，必须保证这个中间件注册在所有路由、端点匹配步骤之前，否则请求已经进入MVC控制器处理流程后再拦截就会失效：

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
  if (Configuration["MVC"] == "false")
  {
     app.Use(async (context, next) =>
     {
         // 所有以/api为前缀的请求直接放行，不做任何拦截
         if (context.Request.Path.StartsWithSegments("/api", StringComparison.OrdinalIgnoreCase))
         {
             await next();
             return;
         }
         // 非/api路径的MVC相关请求，直接返回指定状态码
         // 可根据需求替换为 (int)HttpStatusCode.NotFound 返回404
         context.Response.StatusCode = (int)HttpStatusCode.Gone;
         await Task.CompletedTask;
     });
  }

  // 以下为项目原有管道逻辑，完全保留不需要改动
  // 例如：异常处理、静态文件、UseRouting、UseEndpoints等原有代码
}

在拦截逻辑中用到的状态码枚举，仅需要引入命名空间using System.Net;即可正常使用，无额外依赖。

适配调整说明 #

• 如果需要保留wwwroot目录下静态资源（css、js、图片等）的正常访问，可以在路径判断逻辑中额外增加静态资源路径的白名单放行规则，避免静态资源被拦截。
• 状态码可根据业务需求灵活选择：404（资源不存在）或410（资源永久不可用）都符合要求。

端点路由适配实现（更贴合.NET Core路由机制） #

如果不想通过全局路径拦截，可以调整原有UseEndpoints的映射逻辑，根据配置决定是否注册MVC控制器的路由端点：

当配置关闭MVC时，系统完全不生成MVC控制器对应的可匹配端点，所有非API的请求会因为找不到匹配端点自动返回404，根本不会触发MVC控制器的执行流程。

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
  // 原有管道逻辑：异常处理、静态文件、UseRouting等步骤保持不变

  app.UseEndpoints(endpoints =>
  {
      // 始终注册所有API控制器的端点，不受MVC配置影响
      endpoints.MapControllers();

      // 仅当MVC配置不为"false"时，才注册MVC控制器的默认路由
      if (Configuration["MVC"] != "false")
      {
          endpoints.MapControllerRoute(
              name: "default",
              pattern: "{controller=Home}/{action=Index}/{id?}");
      }
  });
}

关键注意事项 #

• 拦截中间件的注册顺序必须靠前：如果把拦截逻辑放在app.UseRouting()或app.UseEndpoints()步骤之后，请求已经完成路由匹配、进入控制器执行流程后再拦截，就达不到禁用MVC控制器的效果，需要将拦截逻辑放在异常处理中间件之后、路由中间件之前的位置。
• 不需要修改原有控制器的代码：无论MVC控制器原来配置了什么路由规则，在配置关闭MVC时，所有非/api路径的请求都不会触发MVC控制器的执行。
• 无需额外安装NuGet包：两种实现方式均基于.NET 5内置的中间件和路由机制实现，无第三方依赖。

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