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

(시리즈 글이 9개 있습니다.)
.NET Framework: 351. JavaScriptSerializer, DataContractJsonSerializer, Json.NET
; https://www.sysnet.pe.kr/2/0/1391

.NET Framework: 661. Json.NET의 DeserializeObject 수행 시 속성 이름을 동적으로 바꾸는 방법
; https://www.sysnet.pe.kr/2/0/11224

.NET Framework: 756. JSON의 escape sequence 문자 처리 방식
; https://www.sysnet.pe.kr/2/0/11532

사물인터넷: 54. 아두이노 환경에서의 JSON 파서(ArduinoJson) 사용법
; https://www.sysnet.pe.kr/2/0/11766

.NET Framework: 1073. C# - JSON 역/직렬화 시 리플렉션 손실을 없애는 JsonSrcGen
; https://www.sysnet.pe.kr/2/0/12688

.NET Framework: 2087. .NET 6부터 SourceGenerator와 통합된 System.Text.Json
; https://www.sysnet.pe.kr/2/0/13214

.NET Framework: 2115. System.Text.Json의 역직렬화 시 필드/속성 주의
; https://www.sysnet.pe.kr/2/0/13342

닷넷: 2261. C# - 구글 OAuth의 JWT (JSON Web Tokens) 해석
; https://www.sysnet.pe.kr/2/0/13623

닷넷: 2265. C# - System.Text.Json의 기본적인 (한글 등에서의) escape 처리
; https://www.sysnet.pe.kr/2/0/13644




Json.NET의 DeserializeObject 수행 시 속성 이름을 동적으로 바꾸는 방법

제목으로 표현하는 것이 매우 애매한데요. 직접 코드로 살펴보겠습니다.

예를 들어, 테이블 정보를 반환하는 json 응답이 다음과 같은 경우,

{
    "db_tables":
    {
        "name":"member_info"
    }
}

C#에서 class를 이런 식으로 구성하여,

public class DBTable
{
    public string name;
}

public class MyItem
{
    public DBTable db_tables;
}

역 직렬화하는 것이 가능합니다.

// txt == {"db_tables":{"name":"member_info"}}
MyItem item = Newtonsoft.Json.JsonConvert.DeserializeObject<MyItem>(txt);

그런데, 때로는 Web API 개발자가 다음과 같이 "테이블 명"을 속성 이름으로 사용하는 경우가 있습니다.

{
    "db_tables":
    {
        "member_info":"2017-06-13"
    }
}

테이블 이름은 바뀔 수 있는 값이기 때문에 이 필드에 맞춰 C# 클래스를 정의해 줄 수는 없으므로 기존 방법으로는 역 직렬화가 매우 불편하게 됩니다. 바로 이런 상황을 해결하는 용도로 JsonSerializerSettings 클래스가 제공됩니다.

Overwrite Json property name in c#
; https://stackoverflow.com/questions/26882986/overwrite-json-property-name-in-c-sharp

이 글의 예에서는 "member_info" 테이블 이름이 곧 속성 이름으로 사용된 것이기 때문에 이를 실행 중에 바꿀 수 있도록 다음과 같이 ContractResolver를 작성해 JsonSerializerSettings에 넘겨 주면 됩니다.

static void Main(string[] args)
{
    JsonSerializerSettings settings = new JsonSerializerSettings();
    settings.ContractResolver = new CustomNamesContractResolver();

    string txt = "{\"db_tables\":{\"member_info\":\"5\"}}";

    MyItem copy = Newtonsoft.Json.JsonConvert.DeserializeObject<MyItem>(txt, settings);
}

class CustomNamesContractResolver : DefaultContractResolver
{
    protected override IList<JsonProperty> CreateProperties(System.Type type, MemberSerialization memberSerialization)
    {
        IList<JsonProperty> list = base.CreateProperties(type, memberSerialization);

        foreach (JsonProperty prop in list)
        {
            if (prop.UnderlyingName == "name")
            {
                prop.PropertyName = "member_info";
            }
        }

        return list;
    }
}

대충 어떤 용도인지 아시겠죠? ^^

위의 예에서 약간 보완할 항목이라면, C# 클래스(DBTable)의 필드 이름을 "name"으로 주었지만 클래스가 중첩된 경우 필드 이름이 중복될 가능성이 있으므로 "___dbtable_name___"과 같은 식으로 대체하는 것도 고려해 볼 수 있습니다.

참고로, WEB API 2에 포함된 System.Net.Http.Formatting.JsonContractResolver는 Newtonsoft.Json.Serialization.DefaultContractResolver를 상속받은 것입니다.

JsonContractResolver
; https://learn.microsoft.com/en-us/previous-versions/aspnet/dn308832(v=vs.118)

대단하군요. ^^ System.Net 네임스페이스에 있는 타입이 상속받을 정도로 Json.NET 라이브러리가 그만큼 무시할 수 없는 인지도가 있다는!

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




마치기 전에, 여담 하나 이야기하자면.

저도 초보 시절에 응답 XML 데이터를 다음과 같은 식으로 정의한 적이 있었습니다.

<items>
    <csharp created="2017-05-06" />
    <visualbasic created="2017-05-07" />
</items>

그때 당시에 위의 XML 데이터를 보던 경력 개발자 한 분이 저에게 다음과 같은 식으로 바꿀 것을 제안했고,

<items>
    <item name="csharp" created="2017-05-06" />
    <item name="visualbasic" created="2017-05-07" />
</items>

너무나 타당한 그분의 의견에 수긍을 하고 바꾼 적이 있었습니다.

최근에 JSON으로 응답을 하는 몇몇 라이브러리들을 보다가... 저와 같은 실수를 하는 것을 보게 되는군요. ^^




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







[최초 등록일: ]
[최종 수정일: 6/12/2024]

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)
1035정성태5/7/201131055오류 유형: 120. File cannot be opened. Ensure it is a valid Data Link file.
1034정성태5/2/201127914.NET Framework: 211. 파일 잠금 없이 .NET 어셈블리의 버전을 구하는 방법 [2]파일 다운로드1
1033정성태5/1/201133798웹: 19. IIS Express - appcmd.exe를 이용한 applicationHost.config 변경 [2]
1032정성태5/1/201130531웹: 18. IIS Express를 NT 서비스로 변경
1031정성태4/30/201131484웹: 17. IIS Express - "IIS Installed Versions Manager Interface"의 IIISExpressProcessUtility 구하는 방법 [1]파일 다운로드1
1030정성태4/30/201153913개발 환경 구성: 118. IIS Express - localhost 이외의 호스트 이름으로 접근하는 방법 [4]파일 다운로드1
1029정성태4/28/201142717개발 환경 구성: 117. XCopy에서 파일/디렉터리 확인 질문 없애기 [2]
1028정성태4/27/201140078오류 유형: 119. Visual Studio 2010 SP1 설치 후 Windows Phone 개발자 도구로 인한 재설치 문제 [3]
1027정성태4/25/201129242디버깅 기술: 40. 상황별 GetFunctionPointer 반환값 정리 - x86파일 다운로드1
1026정성태4/25/201147950디버깅 기술: 39. DebugDiag 1.1을 사용한 덤프 분석 [7]
1025정성태4/24/201129819개발 환경 구성: 116. IIS 7 관리자 - Active Directory Certification Authority로부터 SSL 사이트 인증서 받는 방법 [2]
1024정성태4/22/201131225오류 유형: 118. Windows 2008 서버에서 Event Viewer / PowerShell 실행 시 비정상 종료되는 문제 [1]
1023정성태4/20/201132102.NET Framework: 210. Windbg 환경에서 확인해 본 .NET 메서드 JIT 컴파일 전과 후 [1]
1022정성태4/19/201127263디버깅 기술: 38. .NET Disassembly 창에서의 F11(Step-into) 키 동작파일 다운로드1
1021정성태4/18/201129633디버깅 기술: 37. .NET 4.0 응용 프로그램의 Main 함수에 BreakPoint 걸기
1020정성태4/18/201130559오류 유형: 117. Failed to find runtime DLL (mscorwks.dll), 0x80004005
1019정성태4/17/201131382디버깅 기술: 36. Visual Studio의 .NET Disassembly 창의 call 호출에 사용되는 주소의 의미는? [1]파일 다운로드1
1018정성태4/16/201135208오류 유형: 116. 윈도우 업데이트 오류 - 0x8020000E
1017정성태4/14/201129664개발 환경 구성: 115. MSBuild - x86/x64, .NET 2/4, debug/release 빌드에 대한 배치 처리파일 다운로드1
1016정성태4/13/201145835개발 환경 구성: 114. Windows Thin PC 설치 [2]
1015정성태4/9/201131039.NET Framework: 209. AutoReset, ManualReset, Monitor.Wait의 차이파일 다운로드1
1014정성태4/7/2011108501오류 유형: 115. ORA-12516: TNS:listener could not find available handler with matching protocol stack [2]
1013정성태4/7/201126405Team Foundation Server: 45. SharePoint 2010 + TFS 2010 환경에서 ProcessGuidance.html 파일 다운로드 문제
1012정성태4/6/201135205.NET Framework: 208. WCF - 접속된 클라이언트의 IP 주소 알아내는 방법 [1]
1011정성태3/31/201137484오류 유형: 114. 인증서 갱신 오류 - The request contains no certificate template information.
1010정성태3/30/201128299개발 환경 구성: 113. 응용 프로그램 디자인 스케치 도구 - SketchFlow [4]
... 151  152  153  154  155  156  157  158  159  160  161  [162]  163  164  165  ...