ASP.NET C# 如何抑制控制器方法抛出的InvalidCastException无效转换异常

异常原因 #

该异常确实发生在模型绑定阶段：ASP.NET Core默认使用Newtonsoft.Json反序列化请求Body时，会根据请求内容自动匹配对应的JToken派生类型（JSON对象对应JObject、JSON数组对应JArray、基础类型值对应JValue），当目标参数类型为JObject但实际反序列化结果是其他JToken类型时，就会触发类型转换失败的InvalidCastException，此时请求还未进入控制器方法。

解决方案 #

1. 修改参数类型为JToken（最推荐，改动最小）

JToken是所有JObject、JArray、JValue的公共基类，直接修改参数类型即可避免绑定异常，进入控制器后自行判断类型处理即可：

[HttpPost]
public IActionResult YourAction([FromBody] JToken body)
{
    if (body is JObject jObj)
    {
        // 正常处理JObject业务逻辑
    }
    else if (body is JArray jArr)
    {
        // 处理传入数组的场景，可返回业务错误
        return BadRequest("请求参数需为JSON对象，不可为数组");
    }
    else if (body is JValue jVal)
    {
        // 处理传入基础类型值的场景
        return BadRequest("请求参数需为JSON对象，不可为基础类型值");
    }
    // 其余业务逻辑
}

2. 自定义JsonConverter处理非JObject输入

如果不希望修改原有参数类型，可以自定义转换器，遇到非JObject输入时返回空对象/Null，避免抛出转换异常：
首先编写转换器：

public class JObjectOnlyConverter : JsonConverter<JObject>
{
    public override JObject ReadJson(JsonReader reader, Type objectType, JObject existingValue, bool hasExistingValue, JsonSerializer serializer)
    {
        var token = JToken.Load(reader);
        // 仅当输入为JObject时返回对应值，否则返回空JObject，也可根据需求返回Null
        return token as JObject ?? new JObject();
    }

    public override void WriteJson(JsonWriter writer, JObject value, JsonSerializer serializer)
    {
        serializer.Serialize(writer, value);
    }
}

注册转换器：

• 全局生效：在Program.cs/Startup.cs中配置

  services.AddControllers()
      .AddNewtonsoftJson(options =>
      {
          options.SerializerSettings.Converters.Add(new JObjectOnlyConverter());
      });
  

• 仅特定参数生效：给参数加特性即可

  public IActionResult YourAction([FromBody][JsonConverter(typeof(JObjectOnlyConverter))] JObject body)
  

3. 全局异常捕获兜底

如果不想改动现有绑定逻辑，可以添加全局异常中间件/过滤器，捕获该特定异常，返回自定义的400响应而非500错误：

app.UseExceptionHandler(err =>
{
    err.Run(async context =>
    {
        var exception = context.Features.Get<IExceptionHandlerFeature>()?.Error;
        if (exception is InvalidCastException castEx 
            && castEx.Message.Contains("Unable to cast object of type 'Newtonsoft.Json.Linq.JArray' to type 'Newtonsoft.Json.Linq.JObject'"))
        {
            context.Response.StatusCode = StatusCodes.Status400BadRequest;
            await context.Response.WriteAsJsonAsync(new { error = "请求参数格式错误，需为JSON对象" });
            return;
        }
        // 其余异常处理逻辑
    });
});

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