精通中间件测试：Asp.Net Core实战指南，提升应用稳定性和可靠性

引言

在上一章节我们实战了在 Asp.Net Core 中的项目实战，这一章节讲解一下如何测试 Asp.Net Core 的中间件。

TestServer

还记得我们在集成测试中提供的 TestServer 吗？ TestServer 是由 Microsoft.AspNetCore.TestHost 包提供的。包含了用于在测试环境中模拟 ASP.NET Core 应用程序的类和方法。通过使用 TestServer ，开发人员可以在测试中模拟整个应用程序的运行环境，包括中间件的执行，从而进行集成测试和端到端测试。

中间件可以使用 TestServer 单独测试。这样便可以：

优点：

实战

VS 新建测试项目 dotNetParadise.MiddlerWareTest

Nuget 安装 Microsoft.AspNetCore.TestHost

PM> NuGet\Install-Package Microsoft.AspNetCore.TestHost -Version 8.0.4


既然我们是要测试中间件 那首先得先在我们的 Sample.Api 中创建一个中间件

定义 MyMiddleware 中间件

public class MyMiddleware(RequestDelegate next)
{
publicasync Task InvokeAsync(HttpContext context)
{
// 在请求处理前执行的逻辑
context.Response.ContentType = "text/plain";
context.Response.Headers.TryAdd("X-Custom-Header", "CustomValue");
await context.Response.WriteAsync("Test My Middleware");
// 调用下一个中间件
await next(context);
// 在请求处理后执行的逻辑
await context.Response.WriteAsync("Middleware Test Completed");
}
}

定义测试类

// Arrange
usingvar host = awaitnew HostBuilder()
.ConfigureWebHost(webBuilder =>
{
webBuilder
.UseTestServer()
.ConfigureServices(services =>
{
// 在这里可以注入服务
})
.Configure(app =>
{
app.UseMiddleware<MyMiddleware>();
});
})
.StartAsync();
// Act
var response = await host.GetTestClient().GetAsync("/");
// Assert
response.EnsureSuccessStatusCode(); // 确保请求成功
var responseContent = await response.Content.ReadAsStringAsync();
Assert.Contains("Test My Middleware", responseContent);
Assert.Contains("Middleware Test Completed", responseContent);


Run Test

使用 HttpContext 发送请求

可以使用 TestServer 来设置测试环境，并创建一个模拟的 HttpContext 对象来代表一个请求

[Fact]
publicasync Task TestMiddleware_ExpectedResponse()
{
usingvar host = awaitnew HostBuilder()
.ConfigureWebHost(webBuilder =>
{
webBuilder
.UseTestServer()
.ConfigureServices(services =>
{
})
.Configure(app =>
{
app.UseMiddleware<MyMiddleware>();
});
})
.StartAsync();
var server = host.GetTestServer();
server.BaseAddress = new Uri("http://localhost");
var context = await server.SendAsync(c =>
{
c.Request.Method = HttpMethods.Get;
c.Request.Path = "/";
c.Request.Host = new HostString("localhost");
c.Request.Scheme = "http";
});
//act
Assert.True(context.RequestAborted.CanBeCanceled);
Assert.Equal(HttpProtocol.Http11, context.Request.Protocol);
// 验证响应
Assert.Equal(StatusCodes.Status200OK, context.Response.StatusCode);
var customHeader = context.Response.Headers["X-Custom-Header"].ToString();
Assert.Equal("CustomValue", customHeader);
}


使用 SendAsync 的好处包括： 通过设置 HttpContext 的任何属性，从而精确控制请求的各个方面。相比于使用 HttpClient ， SendAsync 通常更快，因为它绕过了网络层。集成测试：这是测试整个请求处理管道（包括所有中间件）的好方法。然而，它也有一些限制：

局限性 ： SendAsync 主要用于集成测试，而不是单元测试。它测试的是整个请求处理流程，而不是单个组件。模拟限制：虽然你可以设置 HttpContext 的许多属性来模拟请求，但某些方面（如用户认证状态或外部依赖项）可能难以完全模拟。

添加请求路由

这个比较好理解，就是在 TestServer 中添加路由的功能和 Asp.Net Core 中添加路由基本一致

[Fact]
publicasync Task TestWithEndpoint_ExpectedResponse()
{
usingvar host = awaitnew HostBuilder()
.ConfigureWebHost(webBuilder =>
{
webBuilder
.UseTestServer()
.ConfigureServices(services =>
{
services.AddRouting();
})
.Configure(app =>
{
app.UseRouting();
//app.UseMiddleware<MyMiddleware>();
app.UseEndpoints(endpoints =>
{
endpoints.MapGet("/hello", () =>
TypedResults.Text("Hello Tests"));
});
});
})
.StartAsync();
var client = host.GetTestClient();
var response = await client.GetAsync("/hello");
Assert.True(response.IsSuccessStatusCode);
var responseBody = await response.Content.ReadAsStringAsync();
Assert.Equal("Hello Tests", responseBody);
}




在测试场景中，添加请求路由的好处主要体现在以下几个方面：

最后

本章我们探讨了如何在 Asp.Net Core 项目中测试中间件的方法和技巧。通过使用 TestServer 和 HttpContext 发送请求，我们可以模拟整个应用程序的运行环境，从而进行集成测试和端到端测试。同时，我们也介绍了如何添加请求路由来模拟不同的场景，并对中间件的行为进行验证。

通过测试中间件，我们可以确保其在处理请求时的行为符合预期，提高应用程序的稳定性和可靠性。测试不仅可以帮助发现潜在的问题，还可以在开发过程中及早发现和解决 bug，提高代码质量和开发效率。

参考资料

[1]

测试中间件: https://learn.microsoft.com/zh-cn/aspnet/core/test/middleware?view=aspnetcore-8.0#send-requests-with-httpcontext