JsonStringEnumConverter (System.Text.Json) có hỗ trợ các giá trị null không?

Tôi đang chuyển mã từ .NET Core 2.x sang .NET Core 3.x (tức là sử dụng thư viện gốc System.Text.Json). Khi thực hiện điều này, tôi gặp phải một số vấn đề về cách Newtonsoft.Jsonhỗ trợ trước đây cho các enum nullable không có đường dẫn di chuyển rõ ràng vào lúc này --- có vẻ như nó không được hỗ trợ trong .NET Core 3.x?.

Ví dụ: bằng cách sử dụng Newtonsoft.Json, trình chuyển đổi JSON đã hỗ trợ các enum nullable, như vậy:

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
}

Phiên bản hiện tại của thư viện bản địa System.Text.Json, dường như không hỗ trợ điều này.

Làm thế nào để tôi giải quyết vấn đề này? Tôi không thể di chuyển mã của mình!

Thật không may, hiện tại không có hỗ trợ "ngoài luồng" System.Text.Jsonđể chuyển đổi các enum nullable.

Tuy nhiên, có một giải pháp bằng cách sử dụng trình chuyển đổi tùy chỉnh của riêng bạn . (xem bên dưới) .

Giải pháp. Sử dụng một công cụ chuyển đổi tùy chỉnh.

Bạn sẽ đính kèm có thể gắn nó vào tài sản của bạn bằng cách trang trí nó với trình chuyển đổi tùy chỉnh:

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

Đây là công cụ chuyển đổi:

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());
    }
}

Hy vọng rằng sẽ giúp cho đến khi có hỗ trợ riêng mà không cần một công cụ chuyển đổi tùy chỉnh!

Bạn sẽ có thể lấy lại hành vi ban đầu của mình bằng cách cài đặt nuget Newtonsoft và đặt mã này vào mã của bạn, tôi cho rằng bạn đang di chuyển một ứng dụng ASP:

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