JsonStringEnumConverter（System.Text.Json）はnull値をサポートしますか？

.NET Core 2.xから.NET Core 3.xにコードをシフトしています（つまり、ネイティブライブラリを使用していますSystem.Text.Json）。これを行う際に、以前のNewtonsoft.Jsonnull可能列挙型のサポートには現時点で明確な移行パスがないという問題が発生しました-.NET Core 3.xではサポートされていないようです。

たとえばNewtonsoft.Json、JSONコンバーターはを使用して、次のようにnull可能な列挙型をサポートしました。

public enum UserStatus
{
    NotConfirmed,
    Active,
    Deleted
}

public class User
{
    public string UserName { get; set; }

    [JsonConverter(typeof(StringEnumConverter))]  // using Newtonsoft.Json
    public UserStatus? Status { get; set; }       // Nullable Enum
}

ネイティブライブラリの現在のバージョンは、System.Text.Jsonこれをサポートしていないようです。

この問題を解決するにはどうすればよいですか？コードを移行できません！

残念ながら、現在のところ、System.Text.Jsonnull可能列挙型を変換するための「そのままの」サポートはありません。

ただし、独自のカスタムコンバーターを使用した解決策があります。（下記参照）。

ソリューション。カスタムコンバーターを使用します。

あなたはそれをカスタムコンバータで飾ることによってあなたのプロパティに添付することができます：

// using System.Text.Json
[JsonConverter(typeof(StringNullableEnumConverter<UserStatus?>))]  // Note the '?'
public UserStatus? Status { get; set; }                            // Nullable Enum

これがコンバータです：

public class StringNullableEnumConverter<T> : JsonConverter<T>
{
    private readonly JsonConverter<T> _converter;
    private readonly Type _underlyingType;

    public StringNullableEnumConverter() : this(null) { }

    public StringNullableEnumConverter(JsonSerializerOptions options)
    {
        // for performance, use the existing converter if available
        if (options != null)
        {
            _converter = (JsonConverter<T>)options.GetConverter(typeof(T));
        }

        // cache the underlying type
        _underlyingType = Nullable.GetUnderlyingType(typeof(T));
    }

    public override bool CanConvert(Type typeToConvert)
    {
        return typeof(T).IsAssignableFrom(typeToConvert);
    }

    public override T Read(ref Utf8JsonReader reader, 
        Type typeToConvert, JsonSerializerOptions options)
    {
        if (_converter != null)
        {
            return _converter.Read(ref reader, _underlyingType, options);
        }

        string value = reader.GetString();

        if (String.IsNullOrEmpty(value)) return default;

        // for performance, parse with ignoreCase:false first.
        if (!Enum.TryParse(_underlyingType, value, 
            ignoreCase: false, out object result) 
        && !Enum.TryParse(_underlyingType, value, 
            ignoreCase: true, out result))
        {
            throw new JsonException(
                $"Unable to convert \"{value}\" to Enum \"{_underlyingType}\".");
        }

        return (T)result;
    }

    public override void Write(Utf8JsonWriter writer, 
        T value, JsonSerializerOptions options)
    {
        writer.WriteStringValue(value?.ToString());
    }
}

カスタムコンバーターを必要とせずにネイティブサポートができるまでそれが役立つことを願っています！

Newtonsoft JSON nugetをインストールしてコードに配置することで、元の動作に戻すことができるはずです。ASPアプリを移行していると思います。

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers()
        .AddNewtonsoftJson();
}