Microsoft MVP성태의 닷넷 이야기
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일

C# - JSON 역/직렬화 시 리플렉션 손실을 없애는 JsonSrcGen

Source Generator를 이용해,

C# - Source Generator 소개
; https://www.sysnet.pe.kr/2/0/12223

Reflection 단계를 없애고 JSON을 직렬화/역직렬화하는 nuget 패키지가 나왔습니다. ^^

Is the era of reflection-heavy C# libraries at an end?
; https://blog.marcgravell.com/2021/05/is-era-of-reflection-heavy-c-libraries.html

JsonSrcGen
; https://github.com/trampster/JsonSrcGen

따라서 단순히 JsonSrcGen 패키지만 참조 추가하고, 다음과 같이 적절하게 특성을 적용해 주면 JSON 직렬화/역직렬화를 고속으로 수행할 수 있습니다.

using System;
using JsonSrcGen;

namespace ConsoleApp2
{
    // Install-Package JsonSrcGen
    class Program
    {
        static void Main(string[] args)
        {
            var converter = new JsonConverter();

            ReadOnlySpan<char> json = converter.ToJson(new MyType() { MyProperty = "Some value" });
            Console.WriteLine(json.ToString());

            var myType = new MyType();
            converter.FromJson(myType, "{ \"my_name\" : \"Some value\" }");
            // 또는, converter.FromJson(myType, json);

            Console.WriteLine(myType);
        }
    }


    [Json]
    public class MyType
    {
        [JsonName("my_name")]
        public string MyProperty { get; set; }

        [JsonIgnore]
        public string IgnoredProperty { get; set; }

        public override string ToString()
        {
            return $"MyProperty = {MyProperty}";
        }
    }
}

/* 출력 결과
{"my_name":"Some value"}
MyProperty = Some value
*/

이때 Source Generator가 자동 생성하는 코드는 JsonConverter이고, 위와 같은 경우 MyType에 대해 다음과 같은 식의 소스 코드를 생성해 냅니다.

// %LOCALAPPDATA%\Temp\VSGeneratedDocuments\6aae0b5e-b25f-5c50-066b-6883b1eb7a7f\JsonConverter.cs

using System;
using System.Text;
using System.Collections.Generic;

namespace JsonSrcGen
{
#nullable enable
    public class JsonConverter
    {
        [ThreadStatic]
        JsonStringBuilder? Builder;
        public ReadOnlySpan<char> ToJson(ConsoleApp2.MyType value)
        {

            var builder = Builder;
            if(builder == null)
            {
                builder = new JsonStringBuilder();
                Builder = builder;
            }
            builder.Clear();
            ToJson(value, builder);
            return builder.AsSpan();
        }
        public void ToJson(ConsoleApp2.MyType value, JsonStringBuilder builder)
        {
            if(value.MyProperty == null)
            {
                builder.Append("{\"my_name\":null");
            }
            else
            {
                builder.Append("{\"my_name\":\"");
                builder.AppendEscaped(value.MyProperty);
                builder.Append("\"");
            }
            builder.Append("}");
        }
        public ReadOnlySpan<char> FromJson(ConsoleApp2.MyType value, ReadOnlySpan<char> json)
        {
            json = json.SkipWhitespaceTo('{');
            while(true)
            {
                json = json.SkipWhitespace();
                char value452 = json[0];
                if(value452 == '\"')
                {
                    json = json.Slice(1);
                }
                else if(value452 == '}')
                {
                    return json.Slice(1);
                }
                else
                {
                    throw new InvalidJsonException($"Unexpected character! expected '}}' or '\"' but got '{value452}'", json);
                }
                var propertyName = json.ReadTo('\"');
                json = json.Slice(propertyName.Length + 1);
                json = json.SkipWhitespaceTo(':');
                switch(propertyName.Length % 1)
                {
                    case 0:
                        if(!propertyName.EqualsString("my_name"))
                        {
                            json = json.SkipProperty();
                            break;
                        }
                        json = json.Read(out string? property453Value);
                        value.MyProperty = property453Value;
                        break;
                }
                json = json.SkipWhitespace();
                if(json[0] == ',')
                {
                    json = json.Slice(1);
                }
            }
        }
    }
}
#nullable restore

재미있군요. ^^ 현재 .NET Core 2.1 이상의 프로젝트에서 사용할 수 있습니다.

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




(아래의 버그는 1.1 버전에서 해결될 거라고 합니다. ^^ 대응이 무척 빠르군요.)

참고로, JsonSrcGen 대상이 되는 타입을 namespace 없이 정의하면,

using System;
using JsonSrcGen;

/*
namespace ConsoleApp2
{
*/
    [Json]
    public class MyType
    {
        [JsonName("my_name")]
        public string MyProperty { get; set; }

        [JsonIgnore]
        public string IgnoredProperty { get; set; }
    }
// }

이런 식의 무수한 컴파일 오류 메시지를 보게 될 것입니다. ^^;

Error CS0501 '<invalid-global-code>.<invalid-global-code>(value, builder)' must declare a body because it is not marked abstract, extern, or partial

Error CS0501 'JsonConverter.ToJson(global)' must declare a body because it is not marked abstract, extern, or partial

Error CS0116 A namespace cannot directly contain members such as fields or methods

Error CS1520 Method must have a return type

아직 1.0.3의 초기 버전이라 현업에 적용하실 때는 적절한 사전 검증 작업이 필요할 듯합니다.




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



donaricano-btn



[최초 등록일: ]
[최종 수정일: 6/25/2021]

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

비밀번호

댓글 쓴 사람
 



2021-07-30 09시43분
정성태

1  2  3  4  [5]  6  7  8  9  10  11  12  13  14  15  ...
NoWriterDateCnt.TitleFile(s)
12750정성태8/3/2021211디버깅 기술: 181. windbg - 콜 스택의 "Call Site" 오프셋 값이 가리키는 위치
12749정성태8/2/2021249개발 환경 구성: 590. Visual Studio 2017부터 단위 테스트에 DataRow 특성 지원
12748정성태8/2/2021167개발 환경 구성: 589. Azure Active Directory - tenant의 관리자(admin) 계정 로그인 방법
12747정성태8/1/2021188오류 유형: 748. 오류 기록 - MICROSOFT GRAPH – HOW TO IMPLEMENT IAUTHENTICATIONPROVIDER파일 다운로드1
12746정성태7/31/2021351개발 환경 구성: 588. 네트워크 장비 환경을 시뮬레이션하는 Packet Tracer 프로그램 소개
12745정성태7/31/2021167개발 환경 구성: 587. Azure Active Directory - tenant의 관리자 계정 로그인 방법
12744정성태7/30/2021167개발 환경 구성: 586. Azure Active Directory에 연결된 App 목록을 확인하는 방법?
12743정성태7/30/2021218.NET Framework: 1083. Azure Active Directory - 외부 Token Cache 저장소를 사용하는 방법파일 다운로드1
12742정성태7/30/2021235개발 환경 구성: 585. Azure AD 인증을 위한 사용자 인증 유형
12741정성태7/29/2021221.NET Framework: 1082. Azure Active Directory - Microsoft Graph API 호출 방법파일 다운로드1
12740정성태7/29/2021248오류 유형: 747. SharePoint - InvalidOperationException 0x80131509
12739정성태7/28/2021252오류 유형: 746. Azure Active Directory - IDW10106: The 'ClientId' option must be provided.
12738정성태7/28/2021367오류 유형: 745. Azure Active Directory - Client credential flows must have a scope value with /.default suffixed to the resource identifier (application ID URI).
12737정성태7/28/2021249오류 유형: 744. Azure Active Directory - The resource principal named api://...[client_id]... was not found in the tenant
12736정성태7/28/2021219오류 유형: 743. Active Azure Directory에서 "API permissions"의 권한 설정이 "Not granted for ..."로 나오는 문제
12735정성태7/27/2021291.NET Framework: 1081. C# - Azure AD 인증을 지원하는 데스크톱 애플리케이션 예제(Windows Forms)파일 다운로드1
12734정성태7/26/2021511스크립트: 20. 특정 단어로 시작하거나/끝나는 문자열을 포함/제외하는 정규 표현식 - Look-around
12733정성태7/23/2021252.NET Framework: 1081. Self-Contained/SingleFile 유형의 .NET Core/5+ 실행 파일을 임베딩한다면?파일 다운로드2
12732정성태7/23/2021176오류 유형: 742. SharePoint - The super user account utilized by the cache is not configured.
12731정성태7/23/2021190개발 환경 구성: 584. Add Internal URLs 화면에서 "Save" 버튼이 비활성화 된 경우
12730정성태7/23/2021288개발 환경 구성: 583. Visual Studio Code - Go 코드에서 입력을 받는 경우
12729정성태7/22/2021240.NET Framework: 1080. xUnit 단위 테스트에 메서드/클래스 수준의 문맥 제공 - Fixture
12728정성태7/22/2021206.NET Framework: 1079. MSTestv2 단위 테스트에 메서드/클래스/어셈블리 수준의 문맥 제공
12727정성태7/21/2021325.NET Framework: 1078. C# 단위 테스트 - MSTestv2/NUnit의 Assert.Inconclusive 사용법(?)
12726정성태7/21/2021306VS.NET IDE: 169. 비주얼 스튜디오 - 단위 테스트 선택 시 MSTestv2 외의 xUnit, NUnit 사용법
12725정성태7/21/2021354오류 유형: 741. Failed to find the "go" binary in either GOROOT() or PATH
1  2  3  4  [5]  6  7  8  9  10  11  12  13  14  15  ...