.NET Core 6迁移HTTPModule为中间件时编译报错问题咨询

编译报错的核心原因 #

你遇到的编译错误和注册写法本身无关，是项目配置错误导致的，具体原因如下：

• 类库项目未正确引用ASP.NET Core共享框架
  编写ASP.NET Core中间件的类库，不能仅通过NuGet安装零散的Microsoft.AspNetCore.Http.Abstractions包就完成配置。如果类库目标框架配置错误、未添加框架引用，即使你写对了命名空间和using，编译器也会识别到类型不匹配，无法找到UseMyMiddleware扩展方法、也无法识别UseMiddleware<MyMiddleware>()的泛型约束。
  请修改中间件类库的csproj文件为如下配置：

  <Project Sdk="Microsoft.NET.Sdk">
    <PropertyGroup>
      <!-- 类库目标框架必须和测试站点保持一致，统一为net6.0 -->
      <TargetFramework>net6.0</TargetFramework>
      <ImplicitUsings>enable</ImplicitUsings>
      <Nullable>enable</Nullable>
    </PropertyGroup>
    <ItemGroup>
      <!-- 必须添加ASP.NET Core共享框架引用，才能正确识别所有管道相关类型 -->
      <FrameworkReference Include="Microsoft.AspNetCore.App" />
    </ItemGroup>
  </Project>
  

• 重复注册中间件
  你写的UseMyMiddleware()扩展方法内部已经封装了UseMiddleware<MyMiddleware>()的逻辑，同时写两行会导致同一个中间件被两次注入请求管道，既没必要也会引发逻辑异常，二选一即可。
• 注册顺序不符合拦截需求
  当前你把中间件注册放在UseAuthorization之后，只能拦截经过授权逻辑的请求，如果你需要全局拦截所有入站请求，需要把中间件注册放到管道更靠前的位置。

修正后的测试站点配置 #

修改完类库配置后，测试站点的Program.cs可以参考如下写法：

using Myspace.HttpModule.Example;

var builder = WebApplication.CreateBuilder(args);

// 注册服务
builder.Services.AddControllers();
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

var app = builder.Build();

// 开发环境配置
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

// 自定义中间件注册到管道靠前位置，确保拦截所有请求
app.UseMyMiddleware();

app.UseAuthorization();
app.MapControllers();
app.Run();

如果需要实现请求和响应的修改，中间件的Invoke方法要注意异步执行时机，参考如下写法：

public async Task Invoke(HttpContext httpContext)
{
    // 此处写入站请求拦截逻辑：可修改请求头、请求参数、记录请求日志
    var requestPath = httpContext.Request.Path.Value;

    // 调用管道下游组件
    await _next(httpContext);

    // 此处写出站响应拦截逻辑：可修改响应头、响应内容、记录响应日志
    var responseStatusCode = httpContext.Response.StatusCode;
}

请求拦截的可选实现方案 #

针对不同的使用场景，拦截方案有区别，不是只有中间件一种选择：

• 针对可修改源码的自研.NET 6应用：
  • 中间件是官方推荐的全管道全局拦截方案，可覆盖所有经过服务器的请求（包括静态文件、健康检查、控制器接口等所有请求类型）
  • Action过滤器：仅能拦截进入MVC/Web API控制器逻辑的请求，无法覆盖管道其他分支的请求，适用场景更窄
  • 端点路由约定：仅对匹配特定路由规则的请求生效，无法实现全局拦截
• 针对部署在IIS上、无法修改源码的第三方应用：
  无法像.NET Framework时代仅通过web.config配置就无侵入注入HTTPModule，可选方案为开发IIS原生托管模块，通过IIS原生请求管道实现无侵入的请求/响应拦截，不需要修改第三方应用的代码和启动配置。

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