Microsoft MVP성태의 닷넷 이야기
닷넷: 2181. C# - .NET 8 JsonStringEnumConverter의 AOT를 위한 개선 [링크 복사], [링크+제목 복사],
조회: 12745
글쓴 사람
정성태 (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

비밀번호

댓글 작성자
 




... 121  122  123  124  125  126  127  [128]  129  130  131  132  133  134  135  ...
NoWriterDateCnt.TitleFile(s)
2896정성태3/18/201521424VC++: 90. Visual Studio 2013에서 Visual Basic 6용 ATL Control 제작
2895정성태3/18/201524852VC++: 89. Visual Studio 2015 - auto 반환 타입 및 thread_local 예약어 지원(C++ 11 표준) [2]
2894정성태3/18/201522310.NET Framework: 509. ELEMENT_TYPE_MODIFIER의 조합
2893정성태3/18/201523258오류 유형: 277. command line error MIDL1004: cannot execute C preprocessor cl.exe
2892정성태3/17/201528156오류 유형: 276. robocopy - Logon failure: unknown user name or bad password.
2891정성태3/17/201544155개발 환경 구성: 262. Visual Basic 6 (Enterprise Edition)을 Windows 7 x86에 설치하는 방법 [1]
2890정성태3/17/201525802오류 유형: 275. Internet Explorer - This page can't be displayed
2889정성태3/17/201527236Windows: 107. (2015-03-12) 업데이트 이후 작업 표시줄 또는 탐색기의 반응이 느려지는 문제 [1]
2888정성태3/17/201525280.NET Framework: 508. Visual Studio 빌드 - fatal error C1033: cannot open program database ''
2887정성태3/13/201522572.NET Framework: 507. CoreFx 빌드하는 방법
2886정성태3/13/201524489오류 유형: 274. CoreFx, CoreCLR 빌드 시 "error CS0518: Predefined type 'System.Object' is not defined or imported" 오류 해결 방법
2885정성태3/13/201535228VS.NET IDE: 99. Visual Studio는 2019는 32비트, 2022부터 64비트 버전입니다. [2]
2884정성태3/12/201528950.NET Framework: 506. .NETCore = CoreFX + CoreCLR [5]
2883정성태3/10/201526017.NET Framework: 505. OpenCover 소스 코드 분석을 Visual Studio 2013에서 하는 방법 [1]
2882정성태3/10/201524668.NET Framework: 504. OpenCover 코드 커버리지 도구의 동작 방식을 통해 살펴보는 Calli IL 코드 사용법
2881정성태3/9/201525450개발 환경 구성: 261. OpenCover 오픈 소스를 이용한 .NET 코드 커버리지(Code coverage)
2880정성태3/7/201523508개발 환경 구성: 260. C# Code Coverage 도구 - Semantic Designs 소개
2879정성태3/3/201528640개발 환경 구성: 259. Visual Studio 없이 Visual C++ 컴파일하는 방법
2878정성태2/28/201529600.NET Framework: 503. == 연산자보다는 Equals 메서드의 호출이 더 권장됩니다. [3]파일 다운로드1
2877정성태2/28/201522882.NET Framework: 502. 연산자 재정의(operator overloading)와 메서드 재정의(method overriding)의 다른 점 - 가상 함수 호출 여부 [3]파일 다운로드1
2876정성태2/27/201525694VS.NET IDE: 98. IntegraStudio - Visual Studio에서 Java 프로그램 개발
2875정성태2/26/201525004디버깅 기술: 72. Visual Studio 2013에서의 sos.dll 사용 제한
2874정성태2/26/201521166디버깅 기술: 71. windbg + 닷넷 디버깅 (2) - null 체크 패턴
2873정성태2/25/201539172.NET Framework: 501. FtpWebRequest 타입을 이용해 FTP 파일 업로드 [4]파일 다운로드1
2872정성태2/25/201523164디버깅 기술: 70. windbg + 닷넷 디버깅 (1) - 배열 인덱스 사용 패턴
2871정성태2/24/201526959개발 환경 구성: 258. 윈도우 8.1에서 방화벽과 함께 FTP 서버 여는 (하지만, 권장하지 않는) 방법 [1]
... 121  122  123  124  125  126  127  [128]  129  130  131  132  133  134  135  ...