.NET Core中如何生成符合OData规范的错误响应？

OData v4.0规范定义的错误响应核心结构为外层包含error节点，内部涵盖code、message、details、innererror等字段，示例结构如下：

{
"error": {
"code": "InvalidResource",
"message": "The resource requested does not exist.",
"details": [
{
"code": "NotFound",
"message": "Resource ID '123' was not found in the database."
}
],
"innererror": {
"trace": [...],
"context": "Additional context about the error"
}
}
}

旧ASP.NET Web API中的CreateErrorResponse方法在.NET Core中已被弃用，以下是几种可行的实现方式：

1. 使用OData内置类构建响应 #

首先确保安装Microsoft.AspNetCore.OData NuGet包，利用内置的ODataError和ODataErrorDetail类构建符合规范的响应，在控制器中直接返回：

using Microsoft.AspNetCore.OData;
using Microsoft.OData;

[Route("api/[controller]")]
[ApiController]
public class ProductsController : ControllerBase
{
    [HttpGet("{id}")]
    public IActionResult Get(int id)
    {
        if (id <= 0)
        {
            var odataError = new ODataError
            {
                Code = "InvalidResourceId",
                Message = "提供的资源ID无效",
                Details = new List<ODataErrorDetail>
                {
                    new ODataErrorDetail
                    {
                        Code = "NegativeOrZeroId",
                        Message = "资源ID必须为正整数"
                    }
                },
                InnerError = new ODataInnerError
                {
                    Message = "GetProduct方法中ID验证失败"
                    // 生产环境建议移除StackTrace，避免泄露敏感信息
                    // StackTrace = ex.StackTrace
                }
            };

            // 使用ODataErrorWrapper包装，确保序列化后生成外层error节点
            return BadRequest(new ODataErrorWrapper(odataError));
        }

        return Ok(new Product { Id = id, Name = "示例产品" });
    }
}

2. 全局错误处理中间件 #

如果需要统一捕获所有异常并转换为OData格式响应，可自定义中间件：

public class ODataErrorHandlingMiddleware
{
    private readonly RequestDelegate _next;
    private readonly ILogger<ODataErrorHandlingMiddleware> _logger;

    public ODataErrorHandlingMiddleware(RequestDelegate next, ILogger<ODataErrorHandlingMiddleware> logger)
    {
        _next = next;
        _logger = logger;
    }

    public async Task InvokeAsync(HttpContext context)
    {
        try
        {
            await _next(context);
        }
        catch (Exception ex)
        {
            _logger.LogError(ex, "发生未处理异常");
            await HandleExceptionAsync(context, ex);
        }
    }

    private Task HandleExceptionAsync(HttpContext context, Exception ex)
    {
        context.Response.ContentType = "application/json";
        context.Response.StatusCode = StatusCodes.Status500InternalServerError;

        var odataError = new ODataError
        {
            Code = "InternalServerError",
            Message = "处理请求时发生意外错误",
            InnerError = new ODataInnerError
            {
                Message = ex.Message,
                // 生产环境禁用StackTrace
                // StackTrace = ex.StackTrace,
                InnerError = ex.InnerException != null ? new ODataInnerError { Message = ex.InnerException.Message } : null
            }
        };

        var errorResponse = new { error = odataError };
        return context.Response.WriteAsJsonAsync(errorResponse);
    }
}

// 在Program.cs中注册中间件
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddOData();
// 其他服务注册...

var app = builder.Build();
// 注册OData错误处理中间件（注意顺序，需放在路由之前）
app.UseMiddleware<ODataErrorHandlingMiddleware>();
// 路由配置...
app.Run();

3. 自定义ProblemDetails转换 #

若项目使用ProblemDetails进行错误处理，可自定义工厂将其转换为OData格式：

public class ODataProblemDetailsFactory : ProblemDetailsFactory
{
    public override ProblemDetails CreateProblemDetails(HttpContext httpContext, int? statusCode = null, string? title = null, string? type = null, string? detail = null, string? instance = null)
    {
        var baseProblem = base.CreateProblemDetails(httpContext, statusCode, title, type, detail, instance);
        return MapToODataProblem(baseProblem);
    }

    public override ValidationProblemDetails CreateValidationProblemDetails(HttpContext httpContext, ModelStateDictionary modelStateDictionary, int? statusCode = null, string? title = null, string? type = null, string? detail = null, string? instance = null)
    {
        var baseValidationProblem = base.CreateValidationProblemDetails(httpContext, modelStateDictionary, statusCode, title, type, detail, instance);
        return MapToODataValidationProblem(baseValidationProblem);
    }

    private ProblemDetails MapToODataProblem(ProblemDetails problem)
    {
        var odataError = new ODataError
        {
            Code = problem.Type ?? "UnknownError",
            Message = problem.Title ?? "发生错误",
            Details = new List<ODataErrorDetail> { new() { Message = problem.Detail } }
        };

        // 返回包装后的OData错误结构
        return new ProblemDetails
        {
            Status = problem.Status,
            ContentType = "application/json",
            // 直接序列化OData错误结构，确保输出符合规范
            Detail = JsonSerializer.Serialize(new { error = odataError })
        };
    }

    private ValidationProblemDetails MapToODataValidationProblem(ValidationProblemDetails validationProblem)
    {
        var errorDetails = validationProblem.Errors
            .SelectMany(kv => kv.Value.Select(msg => new ODataErrorDetail
            {
                Code = "ValidationError",
                Message = msg,
                Target = kv.Key
            }))
            .ToList();

        var odataError = new ODataError
        {
            Code = "ValidationFailed",
            Message = "存在一个或多个验证错误",
            Details = errorDetails
        };

        return new ValidationProblemDetails
        {
            Status = validationProblem.Status,
            ContentType = "application/json",
            Detail = JsonSerializer.Serialize(new { error = odataError })
        };
    }
}

// 在Program.cs中注册自定义工厂
builder.Services.AddSingleton<ProblemDetailsFactory, ODataProblemDetailsFactory>();

注意事项 #

• 务必安装最新稳定版的Microsoft.AspNetCore.OData NuGet包，避免版本兼容问题
• 生产环境中禁止返回innererror中的堆栈跟踪信息，防止泄露系统敏感数据
• 错误码和消息可根据业务场景自定义，只需保证结构符合OData v4规范即可

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