はじめに
C#でNewtonSoft Json.NETを使って、データ(クラスオブジェクト)を「シリアライズする方法」と「JSONファイルを作成する方法」を分かりやすく解説します。
～ この記事の内容 / Contents ～
公式サイトのサンプル
この記事の内容は、公式サイトの以下のサンプルをベースにしています。
Json.NETの解説とインストール
Json.NETの紹介とインストール方法については、以下の記事をご覧ください。
環境
この記事の内容は、以下の環境で作成しています。
| 環境 | バージョンなど | 備考 |
| VisualStudio | 2022 Community | |
| .NET | 4.8 | |
| プロジェクト | C# コンソールプログラム (.NET Framework) | |
| Json.net | 13.0.3 | |
| OS | Windows11 | Win7・10でもO |
プログラム概要
今回解説するのプログラムの概要は以下の通りです。
- データ(クラスオブジェクト)を生成する。
- データをシリアライズする。
- JSONデータをファイルに書き込む。
実行結果
後述するJSONファイル作成するコードの実行結果です。
Cドライブの「ProgramDataフォルダ」に以下の、「Account.json」という名前のJSONファイルが作成されます。
{
"Email": "james@example.com",
"Active": true,
"CreatedDate": "2013-01-20T00:00:00Z",
"Roles": [
"User",
"Admin"
]
}全体コード
JSONファイル作成するコードの全体コードです。詳細は「コードのポイント」で詳しく解説します。
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.IO; // ファイル出力に必要です。
using Newtonsoft.Json; // Json.net用に必要です。
namespace ConsoleApp1
{
//
// シリアライズ用のデータクラスです
//
public class Account
{
public string Email { get; set; }
public bool Active { get; set; }
public DateTime CreatedDate { get; set; }
public IList<string> Roles { get; set; }
}
class Program
{
static void Main(string[] args)
{
//
// データ用のクラスオブジェクトを作成します。
//
Account account = new Account
{
Email = "james@example.com",
Active = true,
CreatedDate = new DateTime(2013, 1, 20, 0, 0, 0, DateTimeKind.Utc),
Roles = new List<string>
{
"User",
"Admin"
}
};
//
// 作成したオブジェクトのデータをJSONにシリアライズします
// 一つ目に引数に、シリアライズするオブジェクトを指定します
// 二つ目に引数に、インデントの有無を指定します。
//
string json = JsonConvert.SerializeObject(account, Formatting.Indented);
//
// シリアライズ済みデータ(文字列)をファイルに書き込みます
//
File.WriteAllText(@"C:\ProgramData\Account.json", json);
}
}
}
ビルド/実行前にJson.NETのインストールが必要です。インストール方法はこちらの記事を参照してください。
プロジェクト名(Nanespace)はデフォルトの「ConsoleApp1」で作成しています。
コードのポイント
データ用クラスの定義
Json.NETでJSONを作成するには「Email」や「CreateDate」など、JSONに書き込みたい内容をクラスとして定義する必要があります。
JSONに配列として作成したい内容は「IList<>型」のメンバ変数で定義し、日付は「DateTime型」のメンバ変数を定義してください。
なお、ここで定義した「クラスのメンバ変数名」が「JSONファイルの変数名」として使われます。
//
// シリアライズ用のデータクラスです
//
public class Account
{
public string Email { get; set; }
public bool Active { get; set; }
public DateTime CreatedDate { get; set; }
public IList<string> Roles { get; set; }
}「クラスの変数名」と「JSONの変数名」を別にしたい場合は『JsonProperty』を使います。詳しくはこちらの記事を参照してください。
JSON用のデータの作成
定義したクラスにデータをセットしてクラスオブジェクト(変数)を作成します。
Emailのアドレスなど、ここでセットした内容が「JSONファイルの各変数のデータ」に設定されます。
Account account = new Account
{
Email = "james@example.com",
Active = true,
CreatedDate = new DateTime(2013, 1, 20, 0, 0, 0, DateTimeKind.Utc),
Roles = new List<string>
{
"User",
"Admin"
}
};JSONファイル用の文字列の作成
クラスオブジェクトからJSON形式の文字列を生成します(シリアライズ)。
引数目の1つ目には、前述したデータ用クラスのオブジェクト、二つ目には、作成するJSONファイルのインデント方式を指定します。
シリアライズが完了すると、「JSON形式の文字列」が返されます。
string json = JsonConvert.SerializeObject(account, Formatting.Indented);インデントの形式
SerializeObject関数の第二引数では、JSONデータのインデントを指定することができます。指定できる内容は以下の通りです。
| インデントなし | Formatting.None |
| インデントあり | Fromatting.Indented |
ファイル出力
前述した「JSON形式の文字列」をファイルに書き込みます。文字列はすでにJSON形式になっているので、そのままファイルに書き込むだけで「JSONファイル」が作成できます。
//
// シリアライズ済みデータ(文字列)をファイルに書き込みます
//
File.WriteAllText(@"C:ProgramDataAccount.json", json);まとめ
C#で人気のライブラリ、NewtonSoft Json.NETを使って「データをシリアライズする方法」と「JSONファイルを作成する方法」を紹介しました。
参考になればうれしいです。
お知らせ
今月号のSoftware Designは「もっとTypeScriptの力を引き出そう」
JavaScriptの拡張言語でしょ？と思っているかたへ、Union型などTypeScriptの持つ秘めたる力を解説する特集となっています。
個人的には第2特集の「Ubuntuの現代的な使い方」がの方が気になりました。より詳しい内容は以下のリンクからご覧ください。
ポチップ
もっと詳しくJson.NETを知りたい
このブログでは、Json.NETの以下内容も解説してます。興味のある方は以下からご覧ください。
Dictionaryのシリアライズ・デシリアライズ
JObjectを使用したパース
JSONデータと違う名前をメンバ変数につける方法
質問・要望 大歓迎です
「こんな解説記事作って」「こんなことがしたいけど、〇〇で困ってる」など、コメント欄で教えてください。 質問・要望に、中の人ができる限り対応します。
使えたよ・設定できたよの一言コメントも大歓迎。気軽に足跡を残してみてください。記事を紹介したい方はブログ、SNSにバシバシ貼ってもらってOKです。
