.net column

.NET開発者のためのブログメディア
プログラムコード

C#でJSONを扱う方法。System.Text.Jsonの使い方とは?

2020年08月17日

JSON(JavaScript Object Notation)は、XMLと同様にWebアプリケーションでよく利用されるデータ表現形式です。JSON形式のデータをC#で使用する場合には、シリアライズまたはデシリアライズすることになります。C#のオブジェクトをシリアライズしてJSON形式の文字列を取得することや、JSON形式の文字列をデシリアライズしてC#のオブジェクトを取得することが可能となります。

PG
JSON、シリアライズ、デシリアライズ……何だか難しそうな単語がいっぱい出てきているのですが、どういったことが可能なのでしょうか?
PL
シリアライズ、デシリアライズはアプリケーション開発でよく利用します。複雑なデータ構造をひとつの文字列やバイト列で表現する場合には必須ですよ。

実行環境
・Visual Studio Community 2017
・.NET Framework 4.6.1

JSON のシリアル化と逆シリアル化とは?

まずシリアル化と逆シリアル化について解説します。
シリアル化(シリアライズ:serialize)とは、プログラミングでオブジェクト化されたデータを、ファイルやストレージに保存したり、ネットワークで送受信したりできるような形に変換することです。

一方で逆シリアル化(デシリアライズ:deserialize)とは、シリアル化されたデータをプログラミングで扱えるようにオブジェクトの型に復元することをいいます。

多くのプログラミング言語では、このシリアライズ/デシリアライズを行う仕組みは準備されています。これまでC#でJSON を使用する際には、 Json.NET がよく使われていましたが、.NET Core 3以降ではマイクロソフト公式のSystem.Text.Json を使用することが多くなっています。

Json.NETはサードパーティのライブラリですので、そちらに依存しないで開発を進められるのは良いことです。今までJson.NETで開発をしていて、System.Text.Jsonに移行するならば、修正が一部必要となってきます。

System.Text.Jsonを使用する

それでは早速System.Text.Jsonを利用して、シリアライズとデシリアライズを行っていきましょう。
.NET Core 3以降の場合では、デフォルトでSystem.Text.Jsonはインストールされています。それ以前のバージョン(例えば.NET Framework 4.6.1)で開発を行う場合には、System.Text.JsonのNuGetパッケージを入れることで使用可能です。

本記事では.NET Framework 4.6.1を使用し、NuGetからインストールしてサンプルコードの作成を進めます。
インストール後はプログラム上部で、using System.Text.Json;を実行します。これがないといつまでもビルドエラーは解消されませんので、まず追加しましょう。

シリアライズ

シリアライズの結果

デシリアライズ

デシリアライズの結果

Json.NETによるシリアライズの方法

次にかつて主流でしたJson.NETでのJSONの扱い方も記載しておきます。

Json.NETの結果

Json.NETの他にもDataContractJsonSerializerクラスを使ってシリアライズ、デシリアライズを行う方法もあります。参照からSystem.Runtime.Serializationを追加して対応できます。

PG
今はSystem.Text.Jsonがメインなのですね。System.Text.Jsonを使って開発していきます。
PL
System.Text.Jsonでこれから開発するのがベストですね。アプリケーションの修正案件では、DataContractJsonSerializerやJson.NETが多く使われると思うので、両方でシリアライズ、デシリアライズの対応ができるようにしておきましょう。

シリアライズ、デシリアライズはできるように

Webアプリケーションの開発を行う場合は、JSONを利用してのシリアライズ、デシリアライズは本当によく使用します。複雑なデータ構造を持っている場合には、クライアントとサーバーサイドでJSONを使ってやり取りするのが一般的です。
今回はC#で解説を行いましたが、もちろんVB.NETでもSystem.Text.Jsonは利用できますので、使い方は早めにマスターして、Webアプリケーションの構築の際には積極的に活用していきましょう。

>>>C#の案件を探すならFEnet .NET Navi


.NET分野でのキャリアアップをお考えの方は、現在募集中の求人情報をご覧ください。

求人一覧

また、直接のエントリーも受け付けております。

エントリー(応募フォーム)