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

비밀번호

댓글 작성자
 




... 151  152  153  154  155  156  157  158  [159]  160  161  162  163  164  165  ...
NoWriterDateCnt.TitleFile(s)
1108정성태8/22/201132067오류 유형: 134. OLE/COM Object Viewer - DllRegisterServer in IVIEWERS.DLL failed. [1]
1107정성태8/21/201130616디버깅 기술: 43. Windows Form의 Load 이벤트에서 발생하는 예외가 Visual Studio에서 잡히지 않는 문제
1106정성태8/20/201128943웹: 26. FailedRequestTracing 설정으로 인한 iisexpress.exe 비정상 종료 문제
1105정성태8/19/201128441.NET Framework: 238. Web Site Model 프로젝트에서 Trace.WriteLine 출력이 dbgview.exe에서 확인이 안 되는 문제파일 다운로드1
1104정성태8/19/201128930웹: 25. WebDev보다 IIS Express가 더 나은 점 - 다중 가상 디렉터리 매핑 [1]
1103정성태8/19/201134854오류 유형: 133. WCF 포트 바인딩 실패 오류 - TCP error(10013) [1]
1102정성태8/19/201132003Math: 1. 방탈출3 - Room 10의 '중복가능한 조합' 문제를 위한 C# 프로그래밍 [2]파일 다운로드1
1101정성태8/19/201131157.NET Framework: 237. WCF AJAX 서비스와 JavaScript 간의 DateTime 연동 [1]파일 다운로드1
1100정성태8/17/201130300.NET Framework: 236. SqlDbType - DateTime, DateTime2, DateTimeOffset의 차이점파일 다운로드1
1099정성태8/15/201129646오류 유형: 132. 어느 순간 갑자기 접속이 안 되는 TFS 서버
1098정성태8/15/201151837웹: 24. 네이버는 어떻게 로그인 처리를 할까요? [2]
1097정성태8/15/201122994.NET Framework: 235. 메서드의 메타 데이터 토큰 값으로 클래스를 찾아내는 방법
1096정성태8/15/201127178디버깅 기술: 42. Watson Bucket 정보를 이용한 CLR 응용 프로그램 예외 분석 - (2)
1095정성태8/14/201127543디버깅 기술: 41. Windbg - 비정상 종료된 닷넷 프로그램의 StackTrace에서 보이는 offset 값 의미
1094정성태8/14/201132071오류 유형: 131. Fiddler가 강제 종료된 경우, 웹 사이트 방문이 안되는 현상
1093정성태7/27/201125575오류 유형: 130. Unable to connect to the Microsoft Visual Studio Remote Debugging Monitor ... Access is denied.
1092정성태7/22/201128028Team Foundation Server: 46. 코드 이외의 파일에 대해 소스 제어에서 제외시키는 방법
1091정성태7/21/201127085개발 환경 구성: 128. WP7 Emulator 실행 시 audiodg.exe의 CPU 소모율 증가 [2]
1089정성태7/18/201132741.NET Framework: 234. 왜? Button 컨트롤에는 MouseDown/MouseUp 이벤트가 발생하지 않을까요?파일 다운로드1
1088정성태7/16/201125643.NET Framework: 233. Entity Framework 4.1 - 윈도우 폰 7에서의 CodeFirst 순환 참조 문제파일 다운로드1
1087정성태7/15/201128361.NET Framework: 232. Entity Framework 4.1 - CodeFirst 개체의 직렬화 시 순환 참조 해결하는 방법 - 두 번째 이야기파일 다운로드1
1086정성태7/14/201129667.NET Framework: 231. Entity Framework 4.1 - CodeFirst 개체의 직렬화 시 순환 참조 해결하는 방법 [1]파일 다운로드1
1085정성태7/14/201130157.NET Framework: 230. Entity Framework 4.1 - Code First + WCF 서비스 시 EndpointNotFoundException 오류 - 두 번째 이야기파일 다운로드1
1084정성태7/11/201135707.NET Framework: 229. SQL 서버 - DB 테이블의 데이터 변경에 대한 알림 처리 [4]파일 다운로드1
1083정성태7/11/201129661.NET Framework: 228. Entity Framework 4.1 - Code First + WCF 서비스 시 EndpointNotFoundException 오류
1082정성태7/10/201129328.NET Framework: 227. basicHttpBinding + 사용자 정의 인증 구현 [2]파일 다운로드1
... 151  152  153  154  155  156  157  158  [159]  160  161  162  163  164  165  ...