提问者:小点点

JsonConverter无效时产生400 BadRequest?


我使用一个自定义JsonConverter与System.Text.Json为了有DateTime与所需的时区

/// <summary>
/// Converts a string to/from DateTime, requiring the timezone
/// </summary>
public class JsonDateTimeWithTimezoneConverter : JsonConverter<DateTime>
{
    //
    // FOR EXPLANATIONS
    //
    // see https://stackoverflow.com/a/58103218/1545567 and https://stackoverflow.com/a/17752389/1545567
    //



    private readonly string[] FORMATS = { 
        // Basic formats
        "yyyyMMddTHHmmsszzz",
        "yyyyMMddTHHmmsszz",
        "yyyyMMddTHHmmssZ",
        // Extended formats
        "yyyy-MM-ddTHH:mm:sszzz",
        "yyyy-MM-ddTHH:mm:sszz",
        "yyyy-MM-ddTHH:mm:ssZ",
        // All of the above with reduced accuracy to minutes
        "yyyyMMddTHHmmzzz",
        "yyyyMMddTHHmmzz",
        "yyyyMMddTHHmmZ",
        "yyyy-MM-ddTHH:mmzzz",
        "yyyy-MM-ddTHH:mmzz",
        "yyyy-MM-ddTHH:mmZ",            
    };

    public override DateTime Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        //TODO: 400 BadRequest instead of error 500 InternalServerError when format not respected
        Debug.Assert(typeToConvert == typeof(DateTime));
        return DateTime.ParseExact(reader.GetString(), FORMATS, CultureInfo.InvariantCulture, DateTimeStyles.None);
    }

    public override void Write(Utf8JsonWriter writer, DateTime value, JsonSerializerOptions options)
    {
        writer.WriteStringValue(value.ToUniversalTime().ToString("yyyy-MM-ddTHH:mm:sszzz"));
    }
}

我在ConfigureServices中这样注册它

        services.AddControllers()
            .AddJsonOptions(options => {
                options.JsonSerializerOptions.Converters.Add(new JsonDateTimeWithTimezoneConverter());
            });

就像您在代码中看到的那样,当收到没有时区的日期时,它将崩溃并出现异常,这将导致错误500 InternalServerError

我如何抛出异常以返回400而不触碰使用应用程序。UseExceptionHandler(因为代码在我的库中)?

请注意,引发的异常是FormatException,所以对我来说,它应该被翻译成BadRequest...


共1个答案

匿名用户

这个问题应该在Core 3.1ASP.NET修复:FormatException(由DateTime.ParseExact()方法抛出)现在被视为SystemTextJsonInputForcat中的模型状态错误,这是自3.0以来的默认输入格式化程序。这将导致返回400而不是500状态。请参阅Github上的PR,以及3.0和3.1的相关代码部分;

如果您仍在使用3.0,则可以捕获格式异常并重新抛出JsonException,这是3.0中唯一被视为模型状态错误的异常类型:

try
{
    return DateTime.ParseExact(reader.GetString(), FORMATS, CultureInfo.InvariantCulture, DateTimeStyles.None);
}
catch(FormatException e)
{
    throw new JsonException();
}