.NET 8 JsonStringEnumConverter mit native AOT verwenden

JsonStringEnumConverter ist mit native AOT nicht kompatibel. Um das zu beheben, führt .NET 8 einen neuen Konvertertyp ein: JsonStringEnumConverter, der mit native AOT funktioniert.

Um den neuen Typ zu nutzen, annotieren Sie Ihre Typen einfach so:

[JsonConverter(typeof(JsonStringEnumConverter<MyEnum>))]
public enum MyEnum { Foo, Bar }

[JsonSerializable(typeof(MyEnum))]
public partial class MyJsonSerializerContext : JsonSerializerContext { }

Beachten Sie: Die Deserialisierung von Enums ist case-insensitiv, die Serialisierung lässt sich über JsonNamingPolicy anpassen.

Was passiert, wenn Sie JsonStringEnumConverter mit NativeAOT verwenden?

Das erste Warnzeichen sehen Sie bereits beim Kompilieren, in Form folgender Warnung:

Using member ‘System.Text.Json.Serialization.JsonStringEnumConverter.JsonStringEnumConverter()’ which has ‘RequiresDynamicCodeAttribute’ can break functionality when AOT compiling. JSON serialization and deserialization might require types that cannot be statically analyzed and might need runtime code generation. Use System.Text.Json source generation for native AOT applications.

Beim Ausführen des kompilierten Codes erhalten Sie dann eine Laufzeit-Exception:

System.Reflection.MissingMetadataException: ‘System.Text.Json.Serialization.Converters.EnumConverter’ is missing metadata.