Asp.Net OData Web Api能否在反序列化前执行参数验证？

你遇到的这个问题我之前也处理过——ASP.NET OData默认会把类型转换失败直接抛出生硬的异常，而不是返回你期望的那种带字段路径的结构化验证错误。下面给你两种可行的解决方案，既能把这类异常转换成友好提示，也能提前在验证阶段拦截错误，完全贴合你的需求。

方案一：自定义异常过滤器捕获并转换OData类型转换异常 #

我们可以创建一个自定义的异常过滤器，专门捕获OData的类型转换异常，然后解析异常信息，重新构造包含字段路径的验证错误响应。

首先创建一个继承自ExceptionFilterAttribute的过滤器类：

using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters;
using Microsoft.OData;

public class ODataValidationExceptionFilter : ExceptionFilterAttribute
{
    public override void OnException(ExceptionContext context)
    {
        // 捕获OData的类型转换异常
        if (context.Exception is ODataException odataEx && odataEx.Message.Contains("无法将字面量"))
        {
            // 解析异常信息，提取字段标识、错误值和目标类型
            var messageParts = odataEx.Message.Split('：');
            if (messageParts.Length == 2)
            {
                var fieldPrefix = messageParts[0];
                var detailParts = messageParts[1].Split('\'');
                if (detailParts.Length >= 3)
                {
                    var invalidValue = detailParts[1];
                    var targetType = detailParts[3].Split('Edm.')[1];
                    var propertyName = GetTargetPropertyName(context);

                    // 构造符合需求的验证错误信息
                    var validationError = new ValidationProblemDetails
                    {
                        Detail = $"{fieldPrefix}.{propertyName}：{propertyName}的值应为Edm.{targetType}类型",
                        Status = StatusCodes.Status400BadRequest,
                        Title = "验证错误"
                    };

                    context.Result = new BadRequestObjectResult(new[] { validationError });
                    context.ExceptionHandled = true;
                }
            }
        }

        base.OnException(context);
    }

    // 辅助方法：从OData请求路径中提取目标属性名
    private string GetTargetPropertyName(ExceptionContext context)
    {
        var odataPath = context.HttpContext.Request.ODataFeature().Path;
        if (odataPath?.LastSegment is ODataPropertySegment propertySegment)
        {
            return propertySegment.Property.Name;
        }
        // 若无法直接获取， fallback 到默认值或从请求体推断
        return "UnknownProperty";
    }
}

然后在Program.cs（或Startup.cs）中注册这个过滤器：

builder.Services.AddControllers(options =>
{
    options.Filters.Add<ODataValidationExceptionFilter>();
}).AddOData(options =>
{
    // 你的OData基础配置
    options.Select().Filter().OrderBy().Expand().Count().SetMaxTop(100);
    options.AddRouteComponents("odata", GetEdmModel());
});

这个方案的好处是不需要修改模型绑定逻辑，直接在异常抛出后拦截转换，适合快速适配现有项目。

方案二：自定义OData模型绑定器，提前验证类型 #

如果你希望在类型转换之前就进行验证，而不是等异常抛出，可以自定义OData模型绑定器，在绑定阶段检查请求值的类型是否匹配目标属性类型。

1. 创建自定义模型绑定器：

using Microsoft.AspNetCore.Mvc.ModelBinding;
using Microsoft.OData.Edm;

public class ODataTypedPropertyBinder : IModelBinder
{
    public Task BindModelAsync(ModelBindingContext bindingContext)
    {
        var modelName = bindingContext.ModelName;
        var valueProviderResult = bindingContext.ValueProvider.GetValue(modelName);

        if (valueProviderResult == ValueProviderResult.None)
        {
            return Task.CompletedTask;
        }

        bindingContext.ModelState.SetModelValue(modelName, valueProviderResult);
        var inputValue = valueProviderResult.FirstValue;
        var targetType = bindingContext.ModelType;
        var edmProperty = bindingContext.ActionContext.HttpContext.Request.ODataFeature().Path?.LastSegment as ODataPropertySegment;
        var propertyName = edmProperty?.Property.Name ?? modelName;

        // 针对Int32类型做验证（可扩展到其他Edm类型）
        if ((targetType == typeof(int) || targetType == typeof(int?)) && !int.TryParse(inputValue, out _))
        {
            bindingContext.ModelState.TryAddModelError(
                modelName,
                $"input.{propertyName}：{propertyName}的值应为Edm.Int32类型");
        }

        // 若验证不通过，直接终止绑定；否则继续默认逻辑
        if (!bindingContext.ModelState.IsValid)
        {
            return Task.CompletedTask;
        }

        return new SimpleTypeModelBinder(targetType).BindModelAsync(bindingContext);
    }
}

2. 创建模型绑定提供器，指定哪些场景使用这个绑定器：

public class ODataTypedPropertyBinderProvider : IModelBinderProvider
{
    public IModelBinder GetBinder(ModelBinderProviderContext context)
    {
        // 只对OData请求下的数值类型应用自定义绑定器
        var isODataRequest = context.ActionContext.HttpContext.Request.Path.StartsWithSegments("/odata");
        var isNumericType = context.Metadata.ModelType == typeof(int) || 
                           context.Metadata.ModelType == typeof(int?) ||
                           context.Metadata.ModelType == typeof(long) ||
                           context.Metadata.ModelType == typeof(long?);

        if (isODataRequest && isNumericType)
        {
            return new ODataTypedPropertyBinder();
        }
        return null;
    }
}

3. 注册绑定器提供器：

builder.Services.AddControllers(options =>
{
    // 插入到绑定器列表最前面，确保优先使用
    options.ModelBinderProviders.Insert(0, new ODataTypedPropertyBinderProvider());
}).AddOData(/* 你的OData配置 */);

这个方案能在绑定阶段就拦截错误，避免抛出异常，更符合“验证错误”的处理逻辑，你可以根据需要扩展支持更多Edm数据类型。

补充说明 #

• 对于嵌套属性的场景，你可以通过ODataPath的Segments逐层解析完整的字段路径（比如input.User.Age），进一步优化错误信息的准确性。
• 两种方案都可以根据你的业务需求调整错误信息的格式，完全匹配你期望的提示内容。

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