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://docs.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으로 응답을 하는 몇몇 라이브러리들을 보다가... 저와 같은 실수를 하는 것을 보게 되는군요. ^^
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]