C Sharpの基礎 - JSONのソースを表示

== 概要 ==
JSON (JavaScript Object Notation) は、データを格納・交換するための軽量なテキストベースのフォーマットである。<br>
<br>
C#では、JSONデータの操作が便利に行えるようになっている。<br>
<br>
主に、<code>System.Text.Json</code>名前空間を使用してJSONの処理を行う。<br>
この名前空間には、JSONのシリアライズ (オブジェクトをJSON文字列に変換) とデシリアライズ (JSON文字列をオブジェクトに変換) を行うためのクラスやメソッドが含まれている。<br>
<br>
JSONファイルの読み込みは、通常のテキストファイルと同様に<code>File.ReadAllText</code>メソッドを使用して行う。<br>
その後、<code>JsonSerializer.Deserialize<T></code>メソッドを使用して、JSONデータをC#のオブジェクトに変換する。<br>
<br>
逆に、C#のオブジェクトをJSONファイルとして保存する場合は、まず、<code>JsonSerializer.Serialize</code>メソッドを使用してオブジェクトをJSON文字列に変換して、<br>
その後、<code>File.WriteAllText</code>メソッドでファイルに書き込む。<br>
<br>
JSONデータの操作には、動的な方法と静的な方法がある。<br>
* 動的な方法
*: <code>JsonDocument.Parse</code>メソッドを使用してJSONデータを解析して、JsonElement型を通じてデータにアクセスする。
* 静的な方法
*: JSONデータ構造に対応するC#のクラスを定義して、そのクラスのインスタンスとしてデータを扱う。
<br>
C#では、LINQ to JSONを使用することにより、JSONデータに対して複雑なクエリやフィルタリングを行うことも可能である。<br>
これにより、大規模なJSONデータセットから必要な情報を効率的に抽出することができる。<br>
<br>
<u>※注意</u><br>
<u>大規模なJSONファイルを1度にメモリに読み込むとパフォーマンスの問題が生じる可能性がある。</u><br>
<u>このような場合は、<code>JsonDocument.ParseAsync</code>メソッドを使用してストリーミング処理を行うことにより、メモリ使用量を抑えることができる。</u><br>
<br>
また、セキュリティの観点から、信頼できないソースからのJSONデータを扱う場合は、適切なバリデーションを行うことが重要である。<br>
不正なデータによる脆弱性を防ぐため、デシリアライズ時には型チェックや範囲チェックを実施することを推奨する。<br>
<br><br>

== 動的な方法 : JsonDocument.Parseメソッドの使用 ==
==== JSONファイルの読み込み ====
以下の例では、非同期処理およびストリーミング処理を使用して、JSONファイルの読み込んでいる。<br>
<br>
具体的には、JsonDocument.ParseAsyncメソッドを使用してJSONデータを非同期で解析して、JsonElementクラスを通じてデータにアクセスしている。<br>
また、FileStreamクラスを使用してストリーミング処理することにより、大きなJSONファイルを扱う場合にもメモリ効率が向上している。<br>
<br>
 <syntaxhighlight lang="c#">
 using System;
 using System.IO;
 using System.Text.Json;
 using System.Threading.Tasks;
 
 class JsonFileReader
 {
    public static async Task ReadJsonFileAsync(string filePath)
    {
       try
       {
          using FileStream fileStream = File.OpenRead(filePath);
          using JsonDocument document = await JsonDocument.ParseAsync(fileStream);
 
          JsonElement root = document.RootElement;
 
          // JSONの構造に応じて、適切にデータにアクセス
          if (root.TryGetProperty("name", out JsonElement nameElement))
          {
             Console.WriteLine($"名前: {nameElement.GetString()}");
          }
 
          if (root.TryGetProperty("age", out JsonElement ageElement))
          {
             Console.WriteLine($"年齢: {ageElement.GetInt32()}");
          }
 
          if (root.TryGetProperty("hobbies", out JsonElement hobbiesElement) && hobbiesElement.ValueKind == JsonValueKind.Array)
          {
             Console.WriteLine("趣味:");
             foreach (JsonElement hobby in hobbiesElement.EnumerateArray())
             {
                Console.WriteLine($"- {hobby.GetString()}");
             }
          }
       }
       catch (FileNotFoundException)
       {
          Console.WriteLine("エラー: 指定されたファイルが存在しない");
       }
       catch (JsonException ex)
       {
          Console.WriteLine($"JSONパースエラー: {ex.Message}");
       }
       catch (Exception ex)
       {
          Console.WriteLine($"予期せぬエラーが発生: {ex.Message}");
       }
    }
 }
 </syntaxhighlight>
<br>
以下の例では、上記のクラスを使用してJSONファイルを読み込んでいる。<br>
 <syntaxhighlight lang="c#">
 class Program
 {
    static async Task Main(string[] args)
    {
       string readFilePath = "sample.json";
 
       // JSONファイルの読み込み
       await JsonFileReader.ReadJsonFileAsync(readFilePath);
    }
 }
 </syntaxhighlight>
<br>
==== JSONファイルの書き込み ====
以下の例では、非同期処理およびストリーミング処理を使用して、JSONファイルを書き込んでいる。<br>
<br>
具体的には、JsonSerializer.SerializeAsyncメソッドを使用して、オブジェクトをJSONに非同期でシリアライズして、ファイルに書き込んでいる。<br>
また、FileStreamクラスを使用してストリーミング処理することにより、大きなJSONファイルを扱う場合にもメモリ効率が向上している。<br>
<br>
 <syntaxhighlight lang="c#">
 using System;
 using System.IO;
 using System.Text.Json;
 using System.Threading.Tasks;
 
 class JsonFileWriter
 {
    public static async Task WriteJsonFileAsync(string filePath, object data)
    {
       try
       {
          using FileStream createStream = File.Create(filePath);
          await JsonSerializer.SerializeAsync(createStream, data, new JsonSerializerOptions
          {
             WriteIndented = true  // 整形されたJSONを出力
          });
 
          Console.WriteLine("JSONファイルの書き込みが完了");
       }
       catch (UnauthorizedAccessException)
       {
          Console.WriteLine("エラー: ファイルへの書き込み権限がない");
       }
       catch (JsonException ex)
       {
          Console.WriteLine($"JSONシリアライズエラー: {ex.Message}");
       }
       catch (Exception ex)
       {
          Console.WriteLine($"予期せぬエラーが発生: {ex.Message}");
       }
    }
 }
 </syntaxhighlight>
<br>
以下の例では、上記のクラスを使用してJSONファイルを書き込んでいる。<br>
 <syntaxhighlight lang="c#">
 class Program
 {
    static async Task Main(string[] args)
    {
       string writeFilePath = "sample.json";
 
       // JSONファイルの書き込み
       var data = new
       {
          name = "山田太郎",
          age = 30,
          hobbies = new[] { "読書", "旅行", "料理" }
       };
 
       await JsonFileWriter.WriteJsonFileAsync(writeFilePath, data);
    }
 }
 </syntaxhighlight>
<br><br>

== 静的な方法 : JSONデータ構造に対応するC#のクラスの定義 ==
==== JSONデータ構造に対応するクラス ====
 <syntaxhighlight lang="c#">
 using System.Text.Json.Serialization;
 
 public class Person
 {
    [JsonPropertyName("name")]
    public string Name { get; set; }
 
    [JsonPropertyName("age")]
    public int Age { get; set; }
 
    [JsonPropertyName("hobbies")]
    public List<string> Hobbies { get; set; }
 
    public Person()
    {
       Hobbies = new List<string>();
    }
 }
 </syntaxhighlight>
<br>
静的な方法を使用することにより、型安全性が向上して、IDEの補完機能を活用できる等のメリットがある。<br>
また、JSONデータの構造が変更された場合でも、Personクラスを修正するだけで対応できるため、保守性も高くなる。<br>
<br>
==== JSONファイルの読み込み ====
以下の例では、非同期処理およびストリーミング処理を使用して、JSONファイルを読み込んでいる。<br>
<br>
具体的には、JsonSerializer.DeserializeAsync<Person>メソッドを使用して、JSONデータを非同期でPersonオブジェクトにデシリアライズしている。<br>
また、FileStreamクラスを使用してストリーミング処理することにより、大きなJSONファイルを扱う場合にもメモリ効率が向上している。<br>
<br>
 <syntaxhighlight lang="c#">
 using System;
 using System.IO;
 using System.Text.Json;
 using System.Threading.Tasks;
 
 public class StaticJsonFileReader
 {
    public static async Task<Person> ReadJsonFileAsync(string filePath)
    {
       try
       {
          using FileStream fileStream = File.OpenRead(filePath);
          var options = new JsonSerializerOptions
          {
             PropertyNameCaseInsensitive = true
          };
 
          Person person = await JsonSerializer.DeserializeAsync<Person>(fileStream, options);
 
          if (person != null)
          {
             Console.WriteLine($"名前: {person.Name}");
             Console.WriteLine($"年齢: {person.Age}");
             Console.WriteLine("趣味:");
             foreach (var hobby in person.Hobbies)
             {
                Console.WriteLine($"- {hobby}");
             }
          }
 
          return person;
       }
       catch (FileNotFoundException)
       {
          Console.WriteLine("エラー: 指定されたファイルが存在しない");
       }
       catch (JsonException ex)
       {
          Console.WriteLine($"JSONパースエラー: {ex.Message}");
       }
       catch (Exception ex)
       {
          Console.WriteLine($"予期せぬエラーが発生: {ex.Message}");
       }
 
       return null;
    }
 }
 </syntaxhighlight>
<br>
以下の例では、上記のクラスを使用してJSONファイルを読み込んでいる。<br>
 <syntaxhighlight lang="c#">
 class Program
 {
    static async Task Main(string[] args)
    {
       string readFilePath = "sample.json";
 
       // JSONファイルの読み込み
       Person person = await StaticJsonFileReader.ReadJsonFileAsync(readFilePath);
    }
 }
 </syntaxhighlight>
<br>
==== JSONファイルの書き込み ====
以下の例では、非同期処理およびストリーミング処理を使用して、JSONファイルを書き込んでいる。<br>
<br>
具体的には、JsonSerializer.SerializeAsyncメソッドを使用して、PersonオブジェクトをJSONに非同期でシリアライズして、ファイルに書き込んでいる。<br>
また、FileStreamクラスを使用してストリーミング処理することにより、大きなJSONファイルを扱う場合にもメモリ効率が向上している。<br>
<br>
 <syntaxhighlight lang="c#">
 using System;
 using System.IO;
 using System.Text.Json;
 using System.Threading.Tasks;
 
 public class StaticJsonFileWriter
 {
    public static async Task WriteJsonFileAsync(string filePath, Person person)
    {
       try
       {
          using FileStream createStream = File.Create(filePath);
          var options = new JsonSerializerOptions
          {
             WriteIndented = true  // 整形されたJSONを出力
          };
 
          await JsonSerializer.SerializeAsync(createStream, person, options);
 
          Console.WriteLine("JSONファイルの書き込みが完了");
       }
       catch (UnauthorizedAccessException)
       {
          Console.WriteLine("エラー: ファイルへの書き込み権限がない");
       }
       catch (JsonException ex)
       {
          Console.WriteLine($"JSONシリアライズエラー: {ex.Message}");
       }
       catch (Exception ex)
       {
          Console.WriteLine($"予期せぬエラーが発生: {ex.Message}");
       }
    }
 }
 </syntaxhighlight>
<br>
以下の例では、上記のクラスを使用してJSONファイルを書き込んでいる。<br>
 <syntaxhighlight lang="c#">
 class Program
 {
    static async Task Main(string[] args)
    {
       string writeFilePath = "sample.json";
 
       // JSONファイルの読み込み
       Person person = await StaticJsonFileReader.ReadJsonFileAsync(readFilePath);

       if (person != null)
       {
          // 読み込んだデータを修正
          person.Age++;
          person.Hobbies.Add("プログラミング");
 
          // 修正したデータをJSONファイルに書き込み
          await StaticJsonFileWriter.WriteJsonFileAsync(writeFilePath, person);
       }
    }
 }
 </syntaxhighlight>
<br><br>

== LINQ to JSON : JSONファイルの読み込み ==
以下の例では、LINQ to JSON、非同期処理、ストリーミング処理を使用して、JSONファイルの読み込んでいる。<br>
<br>
FileStreamクラスを使用してストリーミング処理することにより、大きなJSONファイルを扱う場合にもメモリ効率が向上している。<br>
<br>
* 読み込みに使用するJSONファイル
 <syntaxhighlight lang="json">
 {
    "appDesc": {
       "description": "SomeDescription",
       "message": "SomeMessage"
    },
 
    "appName": {
       "description": "Home",
       "message": "Welcome",
       "imp":["awesome","best","good"]
    }
 }
 </syntaxhighlight>
<br>
 <syntaxhighlight lang="c#">
 using System;
 using System.IO;
 using System.Threading.Tasks;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 
 public class JsonReader
 {
    public async Task ReadJsonFileAsync(string filePath)
    {
       try
       {
          using (var fileStream = File.OpenRead(filePath))
          using (var streamReader = new StreamReader(fileStream))
          using (var jsonReader = new JsonTextReader(streamReader))
          {
             var jsonObject = await JObject.LoadAsync(jsonReader);
 
             // JSONデータの処理
             Console.WriteLine("アプリの説明: " + jsonObject["appDesc"]["description"]);
             Console.WriteLine("アプリの名前: " + jsonObject["appName"]["message"]);
 
             // 配列の処理
             var impArray = jsonObject["appName"]["imp"].ToObject<string[]>();
             Console.WriteLine("重要な特徴:");
             foreach (var item in impArray)
             {
                Console.WriteLine("- " + item);
             }
          }
       }
       catch (FileNotFoundException)
       {
          Console.WriteLine("エラー: 指定されたJSONファイルが存在しない");
       }
       catch (JsonException ex)
       {
          Console.WriteLine($"エラー: JSONの解析中にエラーが発生: {ex.Message}");
       }
       catch (Exception ex)
       {
          Console.WriteLine($"予期せぬエラーが発生: {ex.Message}");
       }
    }
 }
 </syntaxhighlight>
<br>
 <syntaxhighlight lang="c#">
 class Program
 {
    static async Task Main(string[] args)
    {
       // JSONファイルの読み込み
       var reader = new JsonReader();
       await reader.ReadJsonFileAsync("input.json");
    }
 }
 </syntaxhighlight>
<br><br>

== サードパーティ製ライブラリ ==
C#には標準ライブラリの他にも、いくつかの人気の高いサードパーティ製JSONパーサーライブラリが存在する。<br>
<br>
* Newtonsoft.Json (Json.NET)
*: 長年に渡り最も広く使用されているJSONライブラリである。
*: 機能が豊富で柔軟性が高く、多くのプロジェクトで採用されている。
*: <br>
*: Newtonsoft.Jsonは機能が豊富で柔軟性が高いため、複雑なJSONデータ構造を扱う場合に適している。
*: <br>
* ServiceStack.Text
*: 高速なJSONシリアライズ / デシリアライズを提供するライブラリであり、特にパフォーマンスを重視する場合に選択されることがある。
*: ServiceStack.Textは、パフォーマンスを重視するアプリケーションで使用されることが多い。
*: <br>
* Jil
*: 非常に高速なJSONシリアライゼーションライブラリとして知られている。
*: Jilは、パフォーマンスを重視するアプリケーションで使用されることが多い。
*: <br>
* UTF8Json
*: UTF-8バイナリデータとC#オブジェクト間の高速な変換を特徴とするライブラリである。
*: UTF8Jsonは、大量のデータを高速に処理する必要がある場合に選択されることがある。
*: <br>
* Utf8Json
*: UTF8Jsonと同様に、UTF-8エンコーディングに最適化された高速なJSONライブラリである。
*: Utf8Jsonは、大量のデータを高速に処理する必要がある場合に選択されることがある。
<br><br>

== Newtonsoft.Json (Json.NET) ライブラリ ==
==== Newtonsoft.Json (Json.NET) ライブラリとは ====
Newtonsoft.Json (Json.NET) は、C#およびその他の.NET言語で使用される非常に人気の高いJSONフレームワークである。<br>
James Newton-King氏によって開発されており、長年にわたり.NETエコシステムにおいてデファクトスタンダードとしての地位を築いてきた。<br>
<br>
このライブラリの主な特徴は、その柔軟性と豊富な機能セットにある。<br>
JSON文字列とC#オブジェクト間の変換 (シリアライズ / デシリアライズ) を簡単に行うことができ、複雑なJSONデータ構造も容易に扱うことができる。<br>
また、LINQ to JSONという機能を提供しており、これによりJSONデータに対して強力なクエリやマニピュレーションが可能になる。<br>
<br>
Json.NETは高度にカスタマイズ可能であり、独自のコンバータを定義および既存の型に対するシリアライズ / デシリアライズの動作をカスタマイズ等をすることができる。<br>
これにより、特殊なデータ形式や複雑なオブジェクトグラフも適切に処理することができる。<br>
<br>
パフォーマンスの面でも、Json.NETは優れた結果を示している。<br>
大規模なJSONデータセットを効率的に処理することができ、多くの実運用環境で使用されている。<br>
<br>
Json.NETは、JSONスキーマの検証やJSONパスの実装等、JSONに関連する幅広い機能をサポートしている。<br>
<br>
これらの機能により、JSONデータの操作や検証がより柔軟かつ強力に行えるようになっている。<br>
<br>
Json.NETは長年にわたり広く使用されてきたため、豊富なドキュメントとコミュニティサポートが存在する。<br>
そのため、問題があった場合でも解決策を見つけやすいというメリットがある。<br>
<br>
ただし、最近の.NETでは、System.Text.JsonというMicrosoftの公式JSONライブラリが導入されたため、一部のシナリオではJson.NETの使用が減少傾向にある。<br>
しかし、その豊富な機能セットと柔軟性から、多くのプロジェクトでJson.NETは依然として重要な役割を果たしている。<br>
<br>
<u>Json.NETのライセンスは、MITライセンスに準拠している。</u><br>
<br>
==== LINQ to JSON : JSONファイルの読み込み ====
以下の例では、LINQ to JSON、非同期処理、ストリーミング処理を使用して、JSONファイルの読み込んでいる。<br>
<br>
FileStreamクラスを使用してストリーミング処理することにより、大きなJSONファイルを扱う場合にもメモリ効率が向上している。<br>
<br>
* 読み込みに使用するJSONファイル
 <syntaxhighlight lang="json">
 {
    "appDesc": {
       "description": "SomeDescription",
       "message": "SomeMessage"
    },
 
    "appName": {
       "description": "Home",
       "message": "Welcome",
       "imp":["awesome","best","good"]
    }
 }
 </syntaxhighlight>
<br>
 <syntaxhighlight lang="c#">
 using System;
 using System.IO;
 using System.Threading.Tasks;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 
 public class JsonReader
 {
    public async Task ReadJsonFileAsync(string filePath)
    {
       try
       {
          using (var fileStream = File.OpenRead(filePath))
          using (var streamReader = new StreamReader(fileStream))
          using (var jsonReader = new JsonTextReader(streamReader))
          {
             var jsonObject = await JObject.LoadAsync(jsonReader);
 
             // JSONデータの処理
             Console.WriteLine("アプリの説明: " + jsonObject["appDesc"]["description"]);
             Console.WriteLine("アプリの名前: " + jsonObject["appName"]["message"]);
 
             // 配列の処理
             var impArray = jsonObject["appName"]["imp"].ToObject<string[]>();
             Console.WriteLine("重要な特徴:");
             foreach (var item in impArray)
             {
                Console.WriteLine("- " + item);
             }
          }
       }
       catch (FileNotFoundException)
       {
          Console.WriteLine("エラー: 指定されたJSONファイルが存在しない");
       }
       catch (JsonException ex)
       {
          Console.WriteLine($"エラー: JSONの解析中にエラーが発生: {ex.Message}");
       }
       catch (Exception ex)
       {
          Console.WriteLine($"予期せぬエラーが発生: {ex.Message}");
       }
    }
 }
 </syntaxhighlight>
<br>
 <syntaxhighlight lang="c#">
 class Program
 {
    static async Task Main(string[] args)
    {
       // JSONファイルの読み込み
       var reader = new JsonReader();
       await reader.ReadJsonFileAsync("sample.json");
    }
 }
 </syntaxhighlight>
<br><br>


__FORCETOC__
[[カテゴリ:C_Sharp]]