C#でJSONを扱う方法。System.Text.Jsonの使い方とは？
JSON(JavaScript Object Notation)は、XMLと同様にWebアプリケーションでよく利用されるデータ表現形式です。JSON形式のデータをC#で使用する場合には、シリアライズまたはデシリアライズすることになります。C#のオブジェクトをシリアライズしてJSON形式の文字列を取得することや、JSON形式の文字列をデシリアライズしてC#のオブジェクトを取得することが可能となります。
- プログラマー
- JSON、シリアライズ、デシリアライズ……何だか難しそうな単語がいっぱい出てきているのですが、どういったことが可能なのでしょうか？
- プロジェクト
リーダー - シリアライズ、デシリアライズはアプリケーション開発でよく利用します。複雑なデータ構造をひとつの文字列やバイト列で表現する場合には必須ですよ。
実行環境
・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;を実行します。これがないといつまでもビルドエラーは解消されませんので、まず追加しましょう。
シリアライズ
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
|
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Text.Json;
namespace WebApplication20
{
public partial class WebForm1 : System.Web.UI.Page
{
protected void Page_Load(object sender, EventArgs e)
{
// Dictionaryを生成します。
var dic = new Dictionary<string,bool>()
{
{ "Tokyo" ,true},
{ "Osaka" ,false},
{ "Nagoya" ,true},
{ "Fukuoka" ,false}
};
// Dictionaryをシリアライズします。
var jsonstr = JsonSerializer.Serialize(dic);
System.Diagnostics.Debug.Print("{0}", jsonstr);
}
}
}
|
デシリアライズ
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
|
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Text.Json;
namespace WebApplication20
{
public partial class WebForm1 : System.Web.UI.Page
{
protected void Page_Load(object sender, EventArgs e)
{
// Dictionaryを生成します。
var dic = new Dictionary<string,bool>()
{
{ "Tokyo" ,true},
{ "Osaka" ,false},
{ "Nagoya" ,true},
{ "Fukuoka" ,false}
};
// Dictionaryをシリアライズします。
var jsonstr = JsonSerializer.Serialize(dic);
var dictionary = new Dictionary<string, bool>();
// デシリアライズしてDictionaryに戻します。
var json = JsonSerializer.Deserialize<Dictionary<string, bool>>(jsonstr);
foreach (var item in json)
{
System.Diagnostics.Debug.Print("{0}", item.Key);
System.Diagnostics.Debug.Print("{0}", item.Value);
}
}
}
}
|
Json.NETによるシリアライズの方法
次にかつて主流でしたJson.NETでのJSONの扱い方も記載しておきます。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
|
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Newtonsoft.Json;
namespace WebApplication20
{
public partial class WebForm1 : System.Web.UI.Page
{
protected void Page_Load(object sender, EventArgs e)
{
// Dictionaryを生成します。
var dic = new Dictionary<string, bool>()
{
{ "Tokyo" ,true},
{ "Osaka" ,false},
{ "Nagoya" ,true},
{ "Fukuoka" ,false}
};
// Dictionaryをシリアライズします。
var jsonstr = JsonConvert.SerializeObject(dic, Formatting.Indented);
System.Diagnostics.Debug.Print("{0}", jsonstr);
}
}
}
|
Json.NETの他にもDataContractJsonSerializerクラスを使ってシリアライズ、デシリアライズを行う方法もあります。参照からSystem.Runtime.Serializationを追加して対応できます。
- プログラマー
- 今はSystem.Text.Jsonがメインなのですね。System.Text.Jsonを使って開発していきます。
- プロジェクト
リーダー - System.Text.Jsonでこれから開発するのがベストですね。アプリケーションの修正案件では、DataContractJsonSerializerやJson.NETが多く使われると思うので、両方でシリアライズ、デシリアライズの対応ができるようにしておきましょう。
シリアライズ、デシリアライズはできるように
Webアプリケーションの開発を行う場合は、JSONを利用してのシリアライズ、デシリアライズは本当によく使用します。複雑なデータ構造を持っている場合には、クライアントとサーバーサイドでJSONを使ってやり取りするのが一般的です。
今回はC#で解説を行いましたが、もちろんVB.NETでもSystem.Text.Jsonは利用できますので、使い方は早めにマスターして、Webアプリケーションの構築の際には積極的に活用していきましょう。
FEnet.NETナビ・.NETコラムは株式会社オープンアップシステムが運営しています。
株式会社オープンアップシステムはこんな会社です
秋葉原オフィスには株式会社オープンアップシステムをはじめグループのIT企業が集結！
数多くのエンジニアが集まります。
-
スマホアプリから業務系システムまで
スマホアプリから業務系システムまで開発案件多数。システムエンジニア・プログラマーとしての多彩なキャリアパスがあります。
-
充実した研修制度
毎年、IT技術のトレンドや社員の要望に合わせて、カリキュラムを刷新し展開しています。社内講師の丁寧なサポートを受けながら、自分のペースで学ぶことができます。
-
資格取得を応援
スキルアップしたい社員を応援するために資格取得一時金制度を設けています。受験料(実費)と合わせて資格レベルに合わせた最大10万円の一時金も支給しています。
-
東証プライム上場企業グループ
オープンアップシステムは東証プライム上場「株式会社夢真ビーネックスグループ」のグループ企業です。
安定した経営基盤とグループ間のスムーズな連携でコロナ禍でも安定した雇用を実現させています。
株式会社オープンアップシステムに興味を持った方へ
株式会社オープンアップシステムでは、開発系エンジニア・プログラマを募集しています。
年収をアップしたい！スキルアップしたい！大手の上流案件にチャレンジしたい！
まずは話だけでも聞いてみたい場合もOK。お気軽にご登録ください。
C＃新着案件New Job
-
システム開発/東京都新宿区/【WEB面談可/C#経験者/20代前半の方活躍中/経験1年以上の方活躍中】/在宅勤務
月給29万～34万円東京都新宿区(新宿駅) -
システム開発/東京都新宿区/【WEB面談可/C#経験者/20代後半～40代の方活躍中/経験年数不問】/在宅勤務
月給41万～50万円東京都新宿区(新宿駅) -
デバック、テスト項目の作成/神奈川県横浜市/【WEB面談可/C#経験者/20代前半の方活躍中/経験1年以上の方活躍中】/在宅勤務
月給29万～34万円神奈川県横浜市(桜木町駅) -
デバック、テスト項目の作成/神奈川県横浜市/【WEB面談可/C#経験者/20代後半～40代の方活躍中/経験年数不問】/在宅勤務
月給41万～50万円神奈川県横浜市(桜木町駅) -
基幹システム開発導入/東京都新宿区/【WEB面談可/C#経験者/20代前半の方活躍中/経験1年以上の方活躍中】/在宅勤務
月給29万～34万円東京都新宿区(西新宿駅) -
基幹システム開発導入/東京都新宿区/【WEB面談可/C#経験者/20代後半～40代の方活躍中/経験年数不問】/在宅勤務
月給41万～50万円東京都新宿区(西新宿駅)
関連記事Related Posts
-
C#のタイマーの精度と一定間隔で処理をする方法
アプリケーションにて一定間隔で処理を行いたい場合に使用するのがタイマーです。 C#で実装をしたい場合、Windowsフォームアプリケーション やWebアプリケーションなど、アプリケーションの種類によって実装方法が異なりま […]
-
【LINQのメソッド紹介その3】Whereで条件に合うデータを取得する
LINQにおいて、Selectメソッドは繰り返し処理のコードをきれいに書けるということを説明しました。Whereメソッドを併用することで、条件分岐をさせることが可能になります。これによりSelectの次にWhereを使用 […]
-
C#の属性(Attribute)とは？使い方を解説
プログラミングを学習し始めた方なら、C#の属性を一度は目にしたことがあるかもしれません。ここでは「属性とはなに？」と疑問に思われている方に、C#の属性の概要とその使い方をわかりやすく説明していきたいと思います。 属性の定 […]
-
C#のout修飾子で参照渡しを行う方法。ref修飾子との違いとは？
C#でメソッドの引数に、out修飾子やref 修飾子を使用すると、参照渡しで引数を渡すことができます。開発の現場で利用する機会が多い out修飾子とref修飾子を解説します。 out修飾子でメソッドの引数を参照渡し C# […]
-
C#でDisposeメソッドを実装しメモリを解放する
プログラムにおいて、確保したメモリ領域は使い終わった時点で必ず解放してあげる必要があります。今回はC#のDisposeメソッドを実装し、メモリを解放する方法を紹介していきます。本記事が参考になれば幸いです。 Dispos […]
