Microsoft MVP성태의 닷넷 이야기
닷넷: 2181. C# - .NET 8 JsonStringEnumConverter의 AOT를 위한 개선 [링크 복사], [링크+제목 복사],
조회: 12017
글쓴 사람
정성태 (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)
10881정성태1/3/201623374오류 유형: 316. 윈도우 10 - 바탕/돋음 체가 사라져 한글이 깨지는 현상 [2]
10880정성태12/16/201521421오류 유형: 315. 닷넷 프로파일러의 오류 코드 정보
10879정성태12/16/201523276오류 유형: 314. Error : DEP0700 : Registration of the app failed. error 0x80070005
10878정성태12/9/201526508디버깅 기술: 75. UWP(유니버설 윈도우 플랫폼) 앱에서 global::System.Diagnostics.Debugger.Break 예외 발생 시 대응 방법
10877정성태12/9/201530774VC++: 93. std::thread 사용 시 R6010 오류 [2]
10876정성태11/26/201526678.NET Framework: 541. SignedXml을 이용한 ds:Signature만드는 방법 [3]파일 다운로드1
10875정성태11/26/201531851개발 환경 구성: 279. signtool.exe의 다중 서명 기능 [2]
10874정성태11/26/201527572개발 환경 구성: 278. 인증서와 인증서를 이용한 코드 사인의 해시 구분
10873정성태11/25/201526230.NET Framework: 540. C# - 부동 소수 계산 왜 이렇게 나오죠? (2) [3]파일 다운로드1
10872정성태11/24/201534294.NET Framework: 539. C# - 부동 소수 계산 왜 이렇게 나오죠? (1) [1]
10871정성태11/23/201528727오류 유형: 313. SignTool Error: No certificates were found that met all the given criteria.
10870정성태11/23/201529923오류 유형: 312. 윈도우 10 TH2 (버전 1511) 업데이트가 안되는 경우 [1]
10869정성태11/23/201526083오류 유형: 311. certutil 실행 오류 - 0x80070057 [1]
10868정성태11/20/201525509제니퍼 .NET: 25. 제니퍼 닷넷 적용 사례 (5) - RestSharp 라이브러리의 CPU High 현상파일 다운로드1
10867정성태10/18/201528666.NET Framework: 538. Thread.Abort로 인해 프로세스가 종료되는 현상
10866정성태10/14/201523914.NET Framework: 537. C# - Reflection의 박싱 없이 값 형식을 다루는 방법파일 다운로드1
10865정성태10/13/201524235.NET Framework: 536. Thread.Abort의 스레드 종료 지연파일 다운로드1
10864정성태10/12/201521935.NET Framework: 535. aspnet.config 파일의 설정을 읽는 방법
10863정성태10/9/201527473.NET Framework: 534. ASP.NET 응용 프로그램이 예외로 프로세스가 종료된다면?
10862정성태10/9/201525710오류 유형: 310. 비주얼 스튜디오 - Unspecified error (Exception from HRESULT: 0x80004005 (E_FAIL))
10861정성태10/9/201530395기타: 54. 도서: 시작하세요! C# 6.0 프로그래밍: 기본 문법부터 실전 예제까지 (2)
10860정성태10/5/201528112개발 환경 구성: 277. IIS AppPool의 시작/중단에 대한 이벤트 로그 확인 방법
10859정성태10/5/201528525.NET Framework: 533. C#에서 string 형식이 primitive일까요? [6]
10858정성태10/2/201525000VS.NET IDE: 105. Visual Studio의 단위 테스트 작성 시 Fakes를 이용한 메서드 재정의 방법 [1]파일 다운로드1
10857정성태10/1/201521717VS.NET IDE: 104. Visual C++ 프로젝트의 빌드 이벤트에서 환경 변수 사용하는 방법
10856정성태9/30/201533166.NET Framework: 532. WPF DataGrid의 데이터 바인딩 시 리플렉션의 부하는 어느 정도일까요?파일 다운로드1
... 121  122  [123]  124  125  126  127  128  129  130  131  132  133  134  135  ...