이글은 Json 에 대해 간략히 설명드리고 C# JSON Serialize Deserialize(직렬화 및 역직렬) 에 대해 공부하며 예제를 보여드립니다. 일반적으로 어떤 모델, 오브젝트 를 네트웍 전송하거나 파일 저장시 Json 포멧 으로 변경하거나 json 포멧을 오브젝트로 변경이 필요합니다. 그 과정을 설명드립니다.
JSON이란 무엇인가?
JSON은 JavaScript Object Notation의 약자입니다. JavaScript 객체 구문을 기반으로 구조화된 데이터를 나타내기 위한 표준 텍스트 기반 형식입니다. 웹 애플리케이션에서 데이터를 전송하는 데 일반적으로 사용되며(예: 서버에서 클라이언트로 일부 데이터를 보내거나 그 반대로), 속성-값 쌍 및 배열(또는 다른 직렬화 가능한 값)으로 구성된 데이터 객체를 저장하고 전송하는 데 인간이 읽을 수 있는 텍스트를 사용하는 개방형 표준 파일 형식 및 데이터 교환 형식입니다.
JSON
예제를 보겠습니다. 아래는 사람을 나타내는 JSON 객체입니다.
{
"이름": "홍길동",
"나이": 30,
"이메일": "hong@example.com",
"주소": {
"도시": "서울",
"거리": "강남대로",
"우편번호": "12345"
},
"전화번호": [
{
"유형": "집",
"번호": "010-1234-5678"
},
{
"유형": "회사",
"번호": "010-9876-5432"
}
]
}
위 예제는 JSON 객체로, 여러 속성-값 쌍으로 구성되어 있습니다. “이름”, “나이”, “이메일” 등의 키에 해당하는 값들이 포함되어 있으며, “주소”와 “전화번호” 같은 키는 객체와 배열로 구조화되어 있습니다. 이러한 방식으로 데이터를 표현하고 전달할 수 있습니다.
JSON 개체 vs 배열 vs 문자열
JSON에서 객체, 배열 및 문자열은 JSON 형식 내의 세 가지 다른 구성 요소 및 구조입니다. 각각의 차이점을 살펴보겠습니다.
JSON 객체
JSON 객체는 중괄호 {}로 둘러싸인 키-값 쌍의 비순서화된 모음입니다. 각 키는 문자열로 시작하여 콜론 :으로 구분되고 해당 값이 이어집니다. JSON 객체는 복잡한 데이터 구조를 나타내며 종종 개체 또는 개체의 속성을 구성하고 나타내는 데 사용됩니다.
예시
{
"이름": "홍길동",
"나이": 30,
"이메일": "hong@example.com",
}
위 예시에서 중괄호 {}로 둘러싸인 구조 전체가 JSON 객체를 나타냅니다. “이름”, “나이”, “이메일” 키는 각각 문자열이며, 이에 해당하는 값은 각각 “홍길동”, 30, “hong@example.com”입니다.
JSON 배열
JSON 배열은 대괄호 []로 둘러싸인 값의 순서화된 모음입니다. JSON 배열 내의 값은 문자열, 숫자, 부울, 개체 또는 다른 배열과 같은 모든 데이터 유형일 수 있습니다. JSON 배열은 관련 데이터의 목록 또는 모음을 나타내거나 처리하는 데 유용합니다.
예시
[
{
"유형": "집",
"번호": "010-1234-5678"
},
{
"유형": "회사",
"번호": "010-9876-5432"
}
]
위 예시에서 대괄호 []로 둘러싸인 구조는 JSON 배열을 나타냅니다.
배열 내에는 위에서 설명한 JSon 객체가 포함되어 있습니다. 즉 “집” 과 “회사” 객체가 배열로 이루어져 있습니다.
JSON 문자열
JSON 문자열은 JSON 구조 내의 이중 인용부호 “”로 둘러싸인 문자의 시퀀스입니다. JSON 문자열은 텍스트 데이터를 나타내며 일반적으로 JSON 객체의 키와 연관되거나 JSON 배열 내 값으로 사용됩니다.
예시
"Hello, World!"
위 예시에서 “Hello, World!”는 이중 인용부호 안에 둘러싸여 있으므로 JSON 문자열을 나타냅니다.
JSON 객체는 중괄호로 둘러싸인 키-값 쌍의 모음이며, JSON 배열은 대괄호로 둘러싸인 값의 순서화된 모음이며, JSON 문자열은 이중 인용부호로 둘러싸인 텍스트 데이터입니다. 이러한 구조들은 JSON 형식 내에서 데이터를 구성하고 나타내는 데 다른 목적으로 사용됩니다.
다음은 여러가지 방법으로 JSON 직렬화/역직렬화를 구현하는 방법을 보여드립니다.
- DataContractJsonSerializer 클래스 사용
- JavaScriptSerializer 클래스 사용
- Newtonsoft.Json 라이브러리 사용
- System.Text.Json 사용
먼저 Json String을 C# 클래스로 만드는 손쉬운 방법은 다음 글에서 확인하실 수 있습니다.
DataContractJsonSerializer 를 활용한 직렬화 및 역직렬화
JSON 데이터를 다루는 데 도움이 되는 DataContractJsonSerializer 클래스에 대해 알아보겠습니다. 이 클래스를 사용하면 객체를 JSON 데이터로 변환하거나 JSON 데이터를 객체로 역직렬화할 수 있습니다. System.Runtime.Serialization.dll 어셈블리 내 System.Runtime.Serialization.Json 네임스페이스에 위치하고 있습니다.
JSON 직렬화와 역직렬화를 위해 사용자 지정 클래스인 HaroStudio 클래스를 만들어 보겠습니다.
[DataContract]
class HaroStudio
{
[DataMember]
public string Name { get; set; }
[DataMember]
public string Description { get; set; }
}
직렬화 (Serialization)
Serialization에서는 사용자 정의 .Net 객체를 JSON 문자열로 변환합니다. 아래 코드는 HaroStudio 클래스의 인스턴스를 생성하고 속성에 값을 할당한 후, DataContractJsonSerializer 클래스의 인스턴스를 만들어 객체를 작성하고 JSON 데이터를 읽기 위한 작업을 수행합니다.
HaroStudio bsObj = new HaroStudio()
{
Name = "Haro",
Description = "Admin"
};
DataContractJsonSerializer js = new DataContractJsonSerializer(typeof(HaroStudio));
MemoryStream msObj = new MemoryStream();
js.WriteObject(msObj, bsObj);
msObj.Position = 0;
StreamReader sr = new StreamReader(msObj);
string json = sr.ReadToEnd();
sr.Close();
msObj.Close();
역직렬화 (Deserialization)
Deserialization에서는 JSON 문자열을 .Net 객체로 변환하는 작업을 수행합니다. 아래 코드는 JSON 문자열을 가지고 있고, 이를 사용하여 다시 객체로 변환합니다.
string json = "{\"Description\":\"Admin\",\"Name\":\"Haro\"}";
using (var ms = new MemoryStream(Encoding.Unicode.GetBytes(json)))
{
// JSON에서 역직렬화
DataContractJsonSerializer deserializer = new
DataContractJsonSerializer(typeof(HaroStudio));
HaroStudio bsObj2 = (HaroStudio)deserializer.ReadObject(ms);
Response.Write("Name: " + bsObj2.Name); // Name: Haro
Response.Write("Description: " + bsObj2.Description); // Description: Admin
}
DataContractJsonSerializer 클래스를 사용하여 JSON 데이터의 직렬화와 역직렬화에 대한 개념을 자세히 살펴보았습니다. 이를 통해 .Net 개체를 JSON으로 변환하거나, 그 반대로 JSON을 .Net 개체로 변환하는 과정을 쉽게 이해할 수 있습니다.
JavaScriptJsonSerializer 를 활용한 직렬화 및 역직렬화
JavaScriptSerializer를 통한 JSON 데이터의 직렬화와 역직렬화는 개체를 다른 형태로 변환하고 처리하는 데 유용합니다. 이 클래스는 JSON 형식을 다루는 데 유용한 도구로, System.Web.Extensions.dll 어셈블리에 있는 System.Web.Script.Serialization 네임스페이스에서 사용할 수 있습니다. 여기서는 JavaScriptSerializer를 사용하여 .NET 개체를 JSON 문자열로 변환하고, 그 반대로 JSON 문자열을 .NET 개체로 변환하는 방법을 살펴보겠습니다.
HaroStudio 클래스는 Name과 Description 속성을 가진 사용자 지정 클래스입니다. 이 클래스는 JavaScriptSerializer를 통해 다른 형태의 데이터로 변환될 수 있습니다.
class HaroStudio
{
public string Name { get; set; }
public string Description { get; set; }
}
직렬화 (Serialization)
Serialization은 .NET 개체를 JSON 문자열로 변환하는 과정입니다. 아래 코드에서는 HaroStudio 클래스의 인스턴스를 만들고 해당 속성에 값을 할당한 후, JavaScriptSerializer의 인스턴스를 만들어 Serialize() 메서드를 호출하여 JSON 데이터로 변환합니다.
// HaroStudio 객체 생성
HaroStudio bsObj = new HaroStudio()
{
Name = "Haro",
Description = "Admin"
};
// 객체를 json 데이터로 직렬화
JavaScriptSerializer js = new JavaScriptSerializer();
string jsonData = js.Serialize(bsObj); // {"Name":"Haro","Description":"Admin"}
역직렬화 (Deserialization)
Deserialization은 JSON 데이터를 .NET 개체로 변환하는 과정입니다. 아래 코드에서는 JavaScriptSerializer의 Deserialize()를 사용하여 JSON 데이터를 HaroStudio 클래스의 객체로 변환합니다.
// json 데이터를 객체로 역직렬화
JavaScriptSerializer js = new JavaScriptSerializer();
HaroStudio blogObject = js.Deserialize<HaroStudio>(jsonData);
string name = blogObject.Name;
string description = blogObject.Description;
// HaroStudio 클래스를 사용하지 않고 역직렬화하는 방법
dynamic blogObject = js.Deserialize<dynamic>(jsonData);
string name = blogObject["Name"];
string description = blogObject["Description"];
JavaScriptJsonSerializer를 사용하면 데이터를 쉽게 변환하고 처리할 수 있으며, .NET 환경에서 JSON 데이터의 유연한 다루임을 제공합니다. 이를 통해 데이터 처리 및 교환 과정에서 효율성과 유연성을 높일 수 있습니다.
Newtonsoft.Json 을 활용한 직렬화 및 역직렬화
Newtonsoft.Json은 JSON 텍스트와 .NET 개체 간의 원활한 변환을 지원하는 타사 라이브러리로, JsonSerializer를 통해 .NET 개체를 JSON 텍스트로 변환하거나 그 반대로 변환할 수 있습니다. 이는 오픈 소스 소프트웨어로, 상업적인 용도로 무료로 사용할 수 있습니다.
Newtonsoft.Json의 주요 기능
- 유연한 JSON Serializer : .NET 개체와 JSON 간의 유연한 변환을 지원하여 데이터 처리를 용이하게 합니다.
- LINQ to JSON 지원 : JSON을 수동으로 읽고 쓰는 능력을 제공하여 데이터 조작을 더욱 효율적으로 할 수 있습니다.
- 고성능 및 빠른 처리 속도 : .NET 기본 제공 JSON Serializer보다 빠르며, 고성능의 데이터 처리를 지원합니다.
- 가독성 높은 JSON 처리 : JSON 데이터를 쉽게 읽고 이해할 수 있도록 지원합니다.
- XML과의 호환성 : JSON을 XML로 변환하거나, 그 반대로 변환하는 기능을 제공합니다.
Newtonsoft.Json 설치 및 구현 방법
Newtonsoft.Json 을 사용하기 위해선 다음과 같은 단계를 따릅니다.
- Visual Studio에서 도구 메뉴를 열고 라이브러리 패키지 관리자를 선택합니다.
- 패키지 관리자 콘솔로 이동하여 다음 명령어를 입력하여 Newtonsoft.Json을 설치합니다.
Install-Package Newtonsoft.Json
또는 Nuget 패키지 관리자를 통해 온라인으로 Newtonsoft.Json 을 검색하고 설치할 수 있습니다.
직렬화 (Serialization)
// HaroStudio 객체 생성
HaroStudio bsObj = new HaroStudio()
{
Name = "Haro",
Description = "Admin"
};
// HaroStudio 객체를 JSON 문자열로 변환
string jsonData = JsonConvert.SerializeObject(bsObj);
역직렬화 (Deserialization)
string json = @"{
'Name': 'Haro',
'Description': 'Admin'
}";
HaroStudio bsObj = JsonConvert.DeserializeObject<HaroStudio>(json);
System.Text.Json 를 활용한 직렬화 및 역직렬화
.NET Core 3.0에서 새로운 Json 지원 클래스로서 System.Text.Json가 내장(built-in) 되었으며, ASP.NET Core 3.0 에서 디폴트 Json Serializer가 서드파티의 Newtonsoft.Json에서 System.Text.Json 으로 변경되었습니다.
.NET Core가 아닌 .NET Framework 혹은 .NET Standard을 사용하는 경우에는, Nuget에서 System.Text.Json 패키지를 설치하여 사용할 수 있습니다.
직렬화 (Serialization)
// HaroStudio 객체 생성
HaroStudio bsObj = new HaroStudio()
{
Name = "Haro",
Description = "Admin"
};
// HaroStudio 객체를 JSON 문자열로 변환
string jsonData = JsonSerializer.Serialize(bsObj);
역직렬화 (Deserialization)
string json = @"{
'Name': 'Haro',
'Description': 'Admin'
}";
HaroStudio bsObj = JsonSerializer.Deserialize<HaroStudio>(json);
결론
C#에서 데이터의 직렬화와 역직렬화는 다양한 방법으로 구현할 수 있습니다.
Newtonsoft.Json 은 다른 라이브러리에 비해 JSON 유효성 검사, 스키마, LINQ to JSON 등 다양한 기능을 보다 편리하게 제공합니다.
System.Text.Json 은 최근 Microsoft 에서 내장시킨 Json 객체입니다.
Newtonsoft.Json 과 System.Text.Json은 약간의 차이가 있습니다.
새로운 project를 시작한다면, System.Text.Json을 사용하는 것을 추천합니다.
