ASP.NET Core 8.0 RequestTimeouts中间件响应体为空问题求助

可能原因及对应解决步骤 #

1. 默认超时策略未配置自定义响应处理 #

默认情况下，RequestTimeouts中间件触发超时后仅返回状态码，不会填充响应体。需要在全局策略中添加自定义响应逻辑：

builder.Services.AddRequestTimeouts(options =>
{
    options.DefaultPolicy = new RequestTimeoutPolicy
    {
        Timeout = TimeSpan.FromSeconds(5),
        // 自定义超时响应
        TimeoutResponse = async context =>
        {
            context.Response.StatusCode = StatusCodes.Status504GatewayTimeout;
            context.Response.ContentType = "application/json";
            var responseBody = new 
            { 
                Error = "请求超时",
                Detail = "服务器处理请求超出预期时间，请稍后重试"
            };
            await context.Response.WriteAsJsonAsync(responseBody);
        }
    };
});

2. 中间件注册顺序错误 #

确保UseRequestTimeouts()在正确位置注册：

• 放在UseRouting()之后，UseEndpoints()之前
• 若使用异常处理中间件，需保证UseRequestTimeouts()在异常处理中间件之后，避免异常处理拦截超时响应

示例正确顺序：

var app = builder.Build();

// 异常处理中间件
if (app.Environment.IsDevelopment())
{
    app.UseDeveloperExceptionPage();
}
else
{
    app.UseExceptionHandler("/Error");
    app.UseHsts();
}

app.UseHttpsRedirection();
app.UseStaticFiles();

app.UseRouting();
app.UseAuthorization();

// 注册请求超时中间件
app.UseRequestTimeouts();

app.UseEndpoints(endpoints =>
{
    endpoints.MapControllers();
});

3. 控制器未正确处理取消令牌 #

控制器异步方法需接收CancellationToken参数，并传递给耗时异步操作，确保超时触发时能正确中断操作并让中间件处理响应：

[ApiController]
[Route("api/test")]
public class TestController : ControllerBase
{
    [HttpGet("long-operation")]
    public async Task<IActionResult> LongRunningOperation(CancellationToken cancellationToken)
    {
        // 将取消令牌传入异步操作
        await Task.Delay(TimeSpan.FromSeconds(10), cancellationToken);
        return Ok(new { Result = "操作完成" });
    }
}

4. 控制器特性与全局策略冲突 #

如果控制器或方法使用了[RequestTimeout]特性，需确保特性配置的策略与全局一致，或明确指定自定义策略：

// 使用全局默认策略
[RequestTimeout]
[HttpGet("timeout-test")]
public async Task<IActionResult> TimeoutTest(CancellationToken cancellationToken)
{
    // ...
}

// 或指定自定义策略名称
[RequestTimeout("CustomPolicy")]
[HttpGet("custom-timeout")]
public async Task<IActionResult> CustomTimeoutTest(CancellationToken cancellationToken)
{
    // ...
}

验证方法 #

1. 启动项目后，调用目标API并模拟超时场景（比如用Task.Delay设置比超时时间更长的等待）
2. 查看响应的Content-Type是否为预期格式（如application/json）
3. 检查响应体是否包含自定义错误信息

内容的提问来源于stack exchange，提问作者code-jar