Microsoft MVP성태의 닷넷 이야기
닷넷: 2181. C# - .NET 8 JsonStringEnumConverter의 AOT를 위한 개선 [링크 복사], [링크+제목 복사],
조회: 14758
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일
(연관된 글이 1개 있습니다.)
(시리즈 글이 5개 있습니다.)
닷넷: 2161. .NET Conf 2023 - Day 1 Blazor 개요 정리
; https://www.sysnet.pe.kr/2/0/13446

닷넷: 2163. .NET 8 - Dynamic PGO를 결합한 성능 향상
; https://www.sysnet.pe.kr/2/0/13448

닷넷: 2178. C# - .NET 8부터 COM Interop에 대한 자동 소스 코드 생성 도입
; https://www.sysnet.pe.kr/2/0/13470

닷넷: 2180. .NET 8 - 함수 포인터에 대한 Reflection 정보 조회
; https://www.sysnet.pe.kr/2/0/13475

닷넷: 2181. C# - .NET 8 JsonStringEnumConverter의 AOT를 위한 개선
; https://www.sysnet.pe.kr/2/0/13476




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 배포 후에도 잘 실행이 됩니다.

(첨부 파일은 이 글의 예제 코드를 포함합니다.)




[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]

[연관 글]






[최초 등록일: ]
[최종 수정일: 12/8/2023]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer at outlook.com

비밀번호

댓글 작성자
 




... 61  62  [63]  64  65  66  67  68  69  70  71  72  73  74  75  ...
NoWriterDateCnt.TitleFile(s)
12455정성태12/15/202021863오류 유형: 693. DLL 로딩 시 0x800704ec - This Program is Blocked by Group Policy [1]
12454정성태12/15/202022041Windows: 184. Windows - AppLocker의 "DLL Rules"를 이용해 임의 경로에 설치한 DLL의 로딩을 막는 방법 [1]
12453정성태12/14/202023208.NET Framework: 984. C# - bool / BOOL / VARIANT_BOOL에 대한 Interop [1]파일 다운로드1
12452정성태12/14/202023695Windows: 183. 설정은 가능하지만 구할 수는 없는 TcpTimedWaitDelay 값
12451정성태12/14/202020603Windows: 182. WMI Namespace를 열거하고, 그 안에 정의된 클래스를 열거하는 방법 [5]
12450정성태12/13/202022402.NET Framework: 983. C# - TIME_WAIT과 ephemeral port 재사용파일 다운로드1
12449정성태12/11/202023254.NET Framework: 982. C# - HttpClient에서의 ephemeral port 재사용 [2]파일 다운로드1
12448정성태12/11/202024920.NET Framework: 981. C# - HttpWebRequest, WebClient와 ephemeral port 재사용파일 다운로드1
12447정성태12/10/202023308.NET Framework: 980. C# - CopyFileEx API 사용 예제 코드파일 다운로드1
12446정성태12/10/202024681.NET Framework: 979. C# - CoCreateInstanceEx 사용 예제 코드파일 다운로드1
12445정성태12/8/202018255오류 유형: 692. C# Marshal.PtrToStructure - The structure must not be a value class.파일 다운로드1
12444정성태12/8/202020590.NET Framework: 978. C# - GUID 타입 전용의 UnmanagedType.LPStruct [1]파일 다운로드1
12443정성태12/8/202019792.NET Framework: 977. C# PInvoke - C++의 매개변수에 대한 마샬링을 tlbexp.exe를 이용해 확인하는 방법
12442정성태12/4/202019592오류 유형: 691. Visual Studio - Build Events에 robocopy를 사용할때 "Invalid Parameter #1" 오류가 발행하는 경우
12441정성태12/4/202017585오류 유형: 690. robocopy - ERROR : No Destination Directory Specified.
12440정성태12/4/202020432오류 유형: 689. SignTool Error: Invalid option: /as
12439정성태12/4/202023669디버깅 기술: 176. windbg - 특정 Win32 API에서 BP가 안 걸리는 경우 (2) [1]
12438정성태12/2/202020348오류 유형: 688. .Visual C++ - Error C2011 'sockaddr': 'struct' type redefinition
12437정성태12/1/202021689VS.NET IDE: 155. pfx의 암호 키 파일을 Visual Studio 없이 등록하는 방법
12436정성태12/1/202022017오류 유형: 687. .NET Core 2.2 빌드 - error MSB4018: The "RazorTagHelper" task failed unexpectedly.
12435정성태12/1/202030347Windows: 181. 윈도우 환경에서 클라이언트 소켓의 최대 접속 수 (4) - ReuseUnicastPort를 이용한 포트 고갈 문제 해결 [1]파일 다운로드1
12434정성태11/30/202023767Windows: 180. C# - dynamicport 값의 범위를 알아내는 방법
12433정성태11/29/202021418Windows: 179. 윈도우 환경에서 클라이언트 소켓의 최대 접속 수 (3) - SO_PORT_SCALABILITY파일 다운로드1
12432정성태11/29/202023140Windows: 178. 윈도우 환경에서 클라이언트 소켓의 최대 접속 수 (2) - SO_REUSEADDR [1]파일 다운로드1
12431정성태11/27/202018901.NET Framework: 976. UnmanagedCallersOnly + C# 9.0 함수 포인터 사용 시 x86 빌드에서 오동작하는 문제파일 다운로드1
12430정성태11/27/202022546오류 유형: 686. Ubuntu - E: The repository 'cdrom://...' does not have a Release file.
... 61  62  [63]  64  65  66  67  68  69  70  71  72  73  74  75  ...