.NET ProblemDetails响应无TraceId？如何添加请求追踪标识

.NET 默认的 ProblemDetails 机制在生产环境（ASPNETCORE_ENVIRONMENT=Production）下会自动屏蔽调试/追踪类信息，包括 trace-id 或 request-id。这是框架的安全设计，避免将内部调试标识暴露给外部用户，防止潜在的信息泄露风险。

要在生产环境的 ProblemDetails 响应中添加 trace-id，可以通过以下两种常用方式实现：

方法一：自定义 ProblemDetailsFactory（官方推荐） #

通过继承 DefaultProblemDetailsFactory 并重写方法，在生成 ProblemDetails 时主动注入请求的 TraceIdentifier。

1. 实现自定义工厂类 #

using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Infrastructure;
using Microsoft.AspNetCore.Mvc.ModelBinding;
using Microsoft.Extensions.Options;

public class CustomProblemDetailsFactory : DefaultProblemDetailsFactory
{
    private readonly IHttpContextAccessor _httpContextAccessor;

    public CustomProblemDetailsFactory(
        IOptions<ApiBehaviorOptions> options,
        IHttpContextAccessor httpContextAccessor)
        : base(options)
    {
        _httpContextAccessor = httpContextAccessor;
    }

    public override ProblemDetails CreateProblemDetails(
        HttpContext httpContext,
        int? statusCode = null,
        string title = null,
        string type = null,
        string detail = null,
        string instance = null)
    {
        var problemDetails = base.CreateProblemDetails(httpContext, statusCode, title, type, detail, instance);
        
        // 将当前请求的 TraceIdentifier 添加到扩展字段
        if (_httpContextAccessor.HttpContext is not null)
        {
            problemDetails.Extensions["traceId"] = _httpContextAccessor.HttpContext.TraceIdentifier;
        }

        return problemDetails;
    }

    // 处理验证错误场景的重载
    public override ValidationProblemDetails CreateValidationProblemDetails(
        HttpContext httpContext,
        ModelStateDictionary modelStateDictionary,
        int? statusCode = null,
        string title = null,
        string type = null,
        string detail = null,
        string instance = null)
    {
        var validationProblemDetails = base.CreateValidationProblemDetails(httpContext, modelStateDictionary, statusCode, title, type, detail, instance);
        
        if (_httpContextAccessor.HttpContext is not null)
        {
            validationProblemDetails.Extensions["traceId"] = _httpContextAccessor.HttpContext.TraceIdentifier;
        }

        return validationProblemDetails;
    }
}

2. 注册自定义工厂 #

在 Program.cs 中替换默认的 ProblemDetailsFactory 实现：

// 先注册 HttpContextAccessor（用于获取请求上下文）
builder.Services.AddHttpContextAccessor();
// 替换为自定义的 ProblemDetailsFactory
builder.Services.AddSingleton<ProblemDetailsFactory, CustomProblemDetailsFactory>();

方法二：使用中间件拦截并修改响应 #

通过中间件捕获 ProblemDetails 格式的响应，手动添加 trace-id 字段。

实现中间件 #

using System.Text.Json;
using Microsoft.AspNetCore.Mvc;

app.Use(async (context, next) =>
{
    var originalBody = context.Response.Body;
    using var memoryStream = new MemoryStream();
    context.Response.Body = memoryStream;

    await next();

    // 仅处理错误状态码的 ProblemDetails 响应
    if (context.Response.StatusCode >= 400 && 
        context.Response.ContentType?.Contains("application/problem+json") == true)
    {
        memoryStream.Seek(0, SeekOrigin.Begin);
        var responseContent = await new StreamReader(memoryStream).ReadToEndAsync();
        
        if (!string.IsNullOrEmpty(responseContent))
        {
            var problemDetails = JsonSerializer.Deserialize<ProblemDetails>(responseContent);
            if (problemDetails != null)
            {
                // 添加 traceId 字段
                problemDetails.Extensions["traceId"] = context.TraceIdentifier;
                
                // 重新序列化并写入响应
                memoryStream.SetLength(0);
                await JsonSerializer.SerializeAsync(memoryStream, problemDetails);
                memoryStream.Seek(0, SeekOrigin.Begin);
                
                context.Response.ContentLength = memoryStream.Length;
                await memoryStream.CopyToAsync(originalBody);
            }
        }
    }

    context.Response.Body = originalBody;
});

注意：此中间件需要注册在异常处理中间件（如 app.UseExceptionHandler()）和状态码页面中间件之后，确保能捕获到最终的 ProblemDetails 响应。

部署到生产环境后，调用 /api/suppliers 触发除零异常，此时返回的 ProblemDetails 响应会包含 traceId 字段，例如：

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.6.1",
  "title": "An unhandled error occurred.",
  "status": 500,
  "traceId": "0HMVK2123XYZ:00000001"
}

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