捕获自定义 JsonConverter 抛出的异常答案

【问题标题】：Catch exception thrown from Custom JsonConverter捕获自定义 JsonConverter 抛出的异常
【发布时间】：2020-06-27 10:16:31
【问题描述】：

我正在寻找一种方法来捕获客户 Newtonsoft 的 JsonConverter 引发的异常。

我创建了以下自定义转换器。 Config 类中的 JsonConverter 属性使用它。 Config 类用于发布配置对象并用于 Web API POST 方法（我使用的是 .NET Core 3.1）。

转换器工作正常，但是当抛出异常时，处理异常的中间件不会捕获它。例如，我预计当 HTTP 请求正文中的 type 为 null 时，中间件会捕获 MissingConfigTypeException，但 appBuilder.Run() 中的 Func 永远不会被调用。转换器抛出的任何异常都不会被中间件捕获。
因为中间件不处理异常，所以API方法返回http状态码500，没有HTTP响应体。我想用我的自定义错误消息返回 400。

我的目标是（我需要同时实现）：

返回 http 400 错误而不是 500 和
在 HTTP 响应正文中返回我的自定义错误（Error 对象。请参阅下面的中间件）

我想知道是否有办法以某种方式捕获异常（使用中间件或其他方式）或修改 HTTP 响应正文（我必须能够识别发生了特定错误，因此我只能修改响应正文发生错误时）

注意：我不想在我的控制器操作方法中使用ModelState（不想为每个方法添加某种错误检查代码）。

更新
中间件可以捕获控制器操作方法抛出的异常。

我的自定义转换器：

public class ConfigJsonConverter :  JsonConverter 
{
    public override object ReadJson(
        JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        ...

        var jObject = JObject.Load(reader);
        if (jObject == null) throw new InvalidConfigException();

        var type = jObject["type"] ?? jObject["Type"];
        if (type == null) throw new MissingConfigTypeException();

        var target = CreateConfig(jObject);
        serializer.Populate(jObject.CreateReader(), target);
        return target;
    }


    private static Config CreateConfig(JObject jObject)
    {
        var type = (string)jObject.GetValue("type", StringComparison.OrdinalIgnoreCase);
        if (Enum.TryParse<ConfigType>(type, true, out var configType))
        {
            switch (configType)
            {
                case ConfigType.TypeA:
                    return new ConfigA();
                case ConfigType.TypeB:
                    return new ConfigB();
            }
        }

        throw new UnsupportedConfigTypeException(type, jObject);
    }

配置类：

[JsonConverter(typeof(ConfigJsonConverter))]
public abstract class Config {...}

public class ConfigA : Config {...}

中间件：

// This is called in startup.cs
public static IApplicationBuilder UseCustomExceptionHandler(this IApplicationBuilder application)
{
    return application.UseExceptionHandler(appBuilder => appBuilder.Run(async context =>
    {
        var exceptionHandlerPathFeature = context.Features.Get<IExceptionHandlerPathFeature>();
        var exception = exceptionHandlerPathFeature.Error;

        Error error;
        switch (exception)
        {
            case InvalidConfigException typedException:
                error = new Error
                {
                    Code = StatusCodes.Status400BadRequest,
                    Message = typedException.Message
                };
                break;

            case MissingConfigTypeException typedException:
                error = new Error
                {
                    Code = StatusCodes.Status400BadRequest,
                    Message = typedException.Message
                };
                break;
            .....
        }

        var result = JsonConvert.SerializeObject(error);
        context.Response.ContentType = "application/json";
        context.Response.StatusCode = error.Code;

        await context.Response.WriteAsync(result);
    }));
}

更新：
启动.cs

public virtual void Configure(IApplicationBuilder app, IWebHostEnvironment env, ILogger<Startup> logger)
{
    if (EnableHttps)
        app.UseHsts();
    ...

    app
        .UseForwardedHeaders()
        .UsePathBase(appConfig.BasePath);

    if (EnableHttps)
        app.UseHttpsRedirection();
    app
        .UseRouting()
        .UseEndpoints(endpoints =>
        {
            endpoints.MapHealthChecks("/health");
            endpoints.MapControllers();
        })
        .UseCustomExceptionHandler(logger);

【问题讨论】：

请将Configure添加到您的启动课程中。
Guru Stron 我已经添加了 startup.cs。我在帖子中提到了这一点，但中间件可以捕获控制器操作方法抛出的异常。所以，它正在工作。

标签： c# json.net asp.net-core-3.1 jsonconverter

【解决方案1】：

尝试在设置端点和路由之前添加您的UseCustomExceptionHandler：

app
    .UseCustomExceptionHandler(logger)
    .UseRouting()
    .UseEndpoints(endpoints =>
    {
        endpoints.MapHealthChecks("/health");
        endpoints.MapControllers();
    });

同样基于docs的异常处理通常设置在管道中的第一个，甚至在app.UseHsts()之前。

【讨论】：