C# - .NET 8 JsonStringEnumConverter의 AOT를 위한 개선
System.Text.Json은,
.NET 6부터 SourceGenerator와 통합된 System.Text.Json
; https://www.sysnet.pe.kr/2/0/13214
컴파일 시점에 소스 코드 생성을 통해 Json 직렬화에 대한 AOT 친화력을 높였습니다. 하지만 enum의 경우에는 약간 부족한 면이 있었는데요, 원래 enum은 직렬화를 했을 때 숫자로 바뀌는 것이 기본 동작입니다. 간단하게 예를 들어 볼까요? ^^
using System;
using System.Text.Json;
using System.Text.Json.Serialization;
namespace ConsoleApp1;
internal class Program
{
static void Main(string[] args)
{
MyPerson t = new MyPerson { Language = Language.Cpp };
string jsonString = JsonSerializer.Serialize(t, MyContext.Default.MyPerson);
Console.WriteLine(jsonString); // 출력 결과: {"Language":1}
MyPerson clone = JsonSerializer.Deserialize(jsonString, MyContext.Default.MyPerson);
Console.WriteLine(clone.Language); // 출력 결과: Cpp
}
}
public struct MyPerson
{
public Language Language { get; set; }
}
public enum Language { CSharp, Cpp, Python, Go }
[JsonSerializable(typeof(MyPerson))]
public partial class MyContext : JsonSerializerContext { }
보는 바와 같이 enum 타입에 대한 직렬화가 숫자, 위의 경우 Cpp에 해당하는 1로 처리되었습니다. 사실 이렇게만 처리하려고 한다면 AOT 빌드에서도 잘 동작하므로 문제 될 것이 없습니다.
그런데, 만약 이것을 "문자열"로 하고 싶다면 어떻게 해야 할까요? 즉, 1이 아닌 다음과 같이 문자열로 표현하고 싶다면,
{"Language":"Cpp"}
기존에는 그런 경우, .NET Core 3.0부터 추가된
JsonStringEnumConverter를 사용하면 됐습니다.
1) 필드에 직접 설정하거나,
public struct MyPerson
{
[JsonConverter(typeof(JsonStringEnumConverter))]
public Language Language { get; set; }
}
2) enum 타입에 설정
[JsonConverter(typeof(JsonStringEnumConverter))]
public enum Language { CSharp, Cpp, Python, Go }
문제는, JsonStringEnumConverter 내부에서 저런 처리를 위해 동적으로 코드 생성을 하기 때문에 AOT 빌드 시에는 사용할 수 없다는 점입니다. 그래서 위의 상태에서 PublishAot 옵션을 주고 빌드하면 컴파일할 때도 이런 경고가 나오지만,
ILC : AOT analysis warning IL3050: ConsoleApp1.MyEnum: Using member 'System.Text.Json.Serialization.JsonStringEnumConverter.JsonStringEnumConverter()' which has 'RequiresDynamicCodeAttribute' can break functionality when AOT compiling. JsonStringEnumConverter cannot be statically analyzed and requires runtime code generation. Applications should use the generic JsonStringEnumConverter<TEnum> instead.
AOT 빌드 후 실행할 때도 이런 오류가 발생합니다.
Unhandled Exception: System.NotSupportedException: 'System.Text.Json.Serialization.Converters.EnumConverter`1[ConsoleApp1.MyEnum]' is missing native code or metadata. This can happen for code that is not compatible with trimming or AOT. Inspect and fix trimming and AOT related warnings that were generated when the app was published. For more information see https://aka.ms/nativeaot-compatibility
at System.Reflection.Runtime.General.TypeUnifier.WithVerifiedTypeHandle(RuntimeConstructedGenericTypeInfo, RuntimeTypeInfo[]) + 0x75
at System.Text.Json.Serialization.Converters.EnumConverterFactory.Create(Type, EnumConverterOptions, JsonNamingPolicy, JsonSerializerOptions) + 0x17
at ConsoleApp1.MyJsonContext.ExpandConverter(Type, JsonConverter, JsonSerializerOptions, Boolean) + 0x50
at ConsoleApp1.MyJsonContext.Create_MyEnum(JsonSerializerOptions) + 0x6d
at System.Text.Json.JsonSerializerOptions.GetTypeInfoNoCaching(Type) + 0x47
at System.Text.Json.JsonSerializerOptions.CachingContext.CreateCacheEntry(Type type, JsonSerializerOptions.CachingContext context) + 0x1d
--- End of stack trace from previous location ---
at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw() + 0x20
at System.Text.Json.JsonSerializerOptions.CachingContext.CacheEntry.GetResult() + 0x1e
at System.Text.Json.JsonSerializerOptions.GetTypeInfoInternal(Type, Boolean, Nullable`1, Boolean, Boolean) + 0x3c
at System.Text.Json.JsonSerializerOptions.GetTypeInfo(Type) + 0x4c
at ConsoleApp1.MyJsonContext.get_MyEnum() + 0x36
at ConsoleApp1.Program.Main(String[] args) + 0xa6
at ConsoleApp1!<BaseAddress>+0x15c600
바로 이 문제를 개선한 JsonStringEnumConverter의 제네릭 버전이 .NET 8에 추가된 것입니다.
JsonStringEnumConverter<TEnum> Class
; https://learn.microsoft.com/en-us/dotnet/api/system.text.json.serialization.jsonstringenumconverter-1
그래서 소스 코드를 다음과 같이 바꾸면,
1) 필드에 직접 설정하거나,
public struct MyPerson
{
[JsonConverter(typeof(JsonStringEnumConverter<Language>))]
public Language Language { get; set; }
}
2) enum 타입에 직접 설정
[JsonConverter(typeof(JsonStringEnumConverter<Language>))]
public enum Language { CSharp, Cpp, Python, Go }
이제 AOT 배포 후에도 잘 실행이 됩니다.
(
첨부 파일은 이 글의 예제 코드를 포함합니다.)
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]