[Tips] Newtonsoft.Jsonライブラリの使用方法

{"IP":"192.168.1.1"}
<p>{} の中に キーと値のペアを「:」で連結して記述します。</p>
<p>キーは「変数」、値は「変数に入れるデータと」考えることができ、上記の例では変数が「IP」データが「192.168.1.1」ということになります。</p>
<h2><a id="jsonFormat"></a>JSONの構文を覚えよう</h2>
<h3><a id="basicFmt"></a>JSONの基本構文</h3>
<p>前述の通り、JSON ではキーと値を「:」で連結して１組とします。</p>
<p>また、キー（変数）はダブルクォーテーションで囲みます。データは文字列の場合はダブルクォーテーションで囲み、数字であればそのまま記述します。</p>
{"IP":"192.168.1.1"} // OK:正しい書き方
{IP:"192.168.1.1"}   // NG:キーをダブルクォーテーションで囲んでいない
{'IP':"192.168.1.1}  // NG:キーをダブルクォーテーションで囲んでいない。シングルクォーテーションは×
{"IP":192.168.1.1}   // NG:192.168.1.1 は数字ではなく文字列扱い
<h3><a id="someKeyValue"></a>複数のキーと値の持たせ方</h3>
<p>以下のようにカンマで区切ることで、複数のキーと値を持たせることもできます。</p>
{"IP1":"192.168.1.2","IP2":"192.168.1.3"}
<p>上記のコードは、読みやすくするために以下のように書くこともできます。なおインデントは2文字か4文字にすることが多いようです。</p>
{
  "IP1":"192.168.1.2",
  "IP2":"192.168.1.3"
}
<h3><a id="dataValue"></a>データ型</h3>
<p>値に使用できるデータ型には以下のものがあります。</p>
<ul>
<li>文字列</li>
<li>数値</li>
<li>ヌル</li>
<li>真偽値</li>
<li>オブジェクト</li>
<li>配列</li>
</ul>
<p>&nbsp;</p>
<h4>文字列</h4>

<p>すでに説明した通り、文字列はダブルクォーテーションで囲みます。</p>

{"name":"takahiro"}  // 文字列データ takahiro をダブルクォーテーション囲む

<p>また、以下のエスケープシーケンス（*）を使用することができます。</p>

<p class="has-text-color has-small-font-size has-vivid-cyan-blue-color">*エスケープシーケンスは、改行やタブ記号など普通の文字記号で表現したもの。JSON の場合、文字列はダブルクォーテーションで囲むので、その中にダブルクォーテーションを含めたい場合はエスケープ処理をする必要がある。このような場合はエスケープシーケンスを使うことで表現できる。</p>

<table class="wp-block-table alignleft">
<tbody>
<tr>
<td><strong>エスケープシーケンス</strong></td>
<td><strong>説明</strong></td>
</tr>
<tr>
<td>\"</td>
<td>ダブルクォーテーション</td>
</tr>
<tr>
<td>\\</td>
<td>バックスラッシュ</td>
</tr>
<tr>
<td>\/</td>
<td>スラッシュ</td>
</tr>
<tr>
<td>\b</td>
<td>バックスペース</td>
</tr>
<tr>
<td>\f</td>
<td>改ページ（フォームフィード）</td>
</tr>
<tr>
<td>\n</td>
<td>改行（new line）</td>
</tr>
<tr>
<td>\r</td>
<td>復帰（carriage return）</td>
</tr>
<tr>
<td>\t</td>
<td>タブ（horizontal tab）</td>
</tr>
<tr>
<td>\uXXXX</td>
<td>4桁16進表記のUnicode文字</td>
</tr>
</tbody>
</table>

<p>例えば、文字列中にダブルクォーテーションを含めたい場合は以下のようにします。</p>

{"name":"\"takahiro\""}  // 文字列の中に「"takahiro"」を入れている

<h4>数値</h4>

<p>数値は、整数や浮動小数点数、指数表記が使用できます。</p>

<p><"pre class="json">{ "age":18, "weight":54.3, "exp":1.0e-3 }</p>

<h4>ヌル</h4>

<p>ヌルは「null」で表します。</p>

{
  "age":null
}

<h4>真偽値</h4>

<p>真偽値は、 true または false で表します。</p>

<p>&nbsp;</p>

{
  "真":true,
  "偽":false
}

<h4>オブジェクト</h4>

<p>オブジェクトは　{} で表します。これまでに学んだ JSONデータを入れることができると考えるとよいです。以下の場合は network という変数が IP と SUBNET を持っていることになります。</p>

{
  "network" : {
    "IP":"192.168.1.2",
    "SUBNET":"255.255.255.o0"
  }
}

<h4>配列</h4>

<p>値は配列にすると複数持つことができます。配列は [] で表し、カンマで区切って複数入れることができます。また、値には文字列、数値、ヌル、真偽値、オブジェクト、配列のすべてを入れることができます。</p>

{
  "fruit":["orange","apple","banana"]
}

<h2><a id="fileFmt"></a>JSON のファイル形式について </h2>

<p>ファイルフォーマットは以下の通りです。</p>

<table class="wp-block-table alignleft">
<tbody>
<tr>
<td>エンコーディング</td>
<td>UTF-8</td>
</tr>
<tr>
<td>拡張子</td>
<td>.json</td>
</tr>
<tr>
<td>MIMEタイプ</td>
<td>application/json</td>
</tr>
</tbody>
</table>

<h2><a id="nuget"></a>NuGet による Newtonsoft.Jsonライブラリの追加</h2>

<p>それでは本題に入ります。</p>
<p>ここでは、新規プロジェクトとして「コンソールアプリ（.NET Framework）」を作成しているものとして話を進めます。</p>
<p>はじめに Visual Studio のメニューで [プロジェクト] - [NuGet パッケージの管理]を選択します。</p>
<p>続いて、「Json.net」という文字列で検索したら、一覧から「Newtonsoft.Json」を選択して、「インストール」をクリックします。</p>

<figure class="wp-block-image"><a href="https://blog.hiros-dot.net/wp-content/uploads/2019/06/image-5.png"><img class="wp-image-8782" src="https://blog.hiros-dot.net/wp-content/uploads/2019/06/image-5.png" alt="Newtonsoft.Json のインストール" /></a>
<figcaption>Newtonsoft.Json のインストール</figcaption>
</figure>

<p>インストールをする際、以下のように変更のプレビューが表示されます。[OK]を押してインストールをしてください。</p>

<figure class="wp-block-image"><img class="wp-image-8788" src="https://blog.hiros-dot.net/wp-content/uploads/2019/06/image-6.png" alt="" />
<figcaption>変更のプレビュー</figcaption>
</figure>

<p>インストールが完了すると、プロジェクトエクスプローラーの「参照」には「Newtonson.Json」が追加されます。</p>
<
<figure class="wp-block-image"><img class="wp-image-8789" src="https://blog.hiros-dot.net/wp-content/uploads/2019/06/image-7.png" alt="" />
<figcaption>追加されたNewtosnsoft.Json</figcaption>
</figure>

<h2><a id="createClass"></a>クラスの作成</h2>

<p>Newtonsoft.Json を使用するとクラスデータを JSONフォーマットに変換したり、JSONフォーマットのデータをクラスに設定したりすることができます。</p>

<p>はじめに、以下のテスト用クラスを作成します。この Person クラスは、Name（氏名）, Age（年齢）, Weigth（体重）の3つのデータを持ちます。</p>

<p>JSON フォーマットとして読み書きしたいクラスは 属性 [JsonObject("任意の名前")]　をつけます。また、読み書きしたいデータは属性 [JsonProperty("任意の名前")] をつけます。[JsonProperty()] の属性を指定しなかったデータは読み書き対象にならないので注意が必要です。</p>

using Newtonsoft.Json;

namespace JsonSample
{
    [JsonObject("Person")]
    class Person
    {
        [JsonProperty("Person Name")]
        public string Name { get; set; }

        [JsonProperty("Person Age")]
        public int Age { get; set; }

        [JsonProperty("Person Weight")]
        public double Weight { get; set; }
    }
}

<p>&nbsp;</p>

<h2><a id="serialize"></a>シリアライズしてみよう</h2>
<p>シリアライズとは、ある複数の要素を一定の規則で並べる操作や処理のことをいいます。</p>

<p>以下はシリアライズの例です。</p>

<p>先ほど作成した Person クラスのインスタンス化をして、データを設定した後、JsonConvert.SerializeObject メソッドを使用して JSON データにシリアライズしています。</p>

using Newtonsoft.Json;  // Newtonsoft.Jsonを使用するために追加
using System;

namespace JsonSample
{
    class Program
    {
        static void Main(string[] args)
        {
            Person person = new Person();

            // データを設定
            person.Name = "takahiro";
            person.Age = 46;
            person.Weight = 63.5;

            // JSON データにシリアライズ
            var jsonData = JsonConvert.SerializeObject(person);

            // シリアライズされたデータを表示
            Console.WriteLine(jsonData);

            Console.ReadLine();
        }
    }
}
<p>作成したデータは以下のようになります。JSON 形式で出力されていることを確認してください。また、キー名は 属性で指定した名称になることがわかります。</p>

{"Person Name":"takahiro","Person Age":46,"Person Weight\":63.5}

<h2><a id="desirealize"></a>デシリアライズしてみよう</h2>

<p>次にデシリアライズをしてみましょう。</p>

<p>デシリアライズはシリアライズの逆で、元のデータ構造に復元する操作や処理のことを言います。</p>

<p>デシリアライズをするには JsonConvert.DeserializeObject<デシリアライズ先のデータ型>(JSONデータ文字列) を使用します。</p>

<p>デシリアライズの例を以下に示します。</p>

using Newtonsoft.Json;
using System;

namespace JsonSample
{
    class Program
    {
        static void Main(string[] args)
        {
            // JSON 形式の文字列を作成
            var jsonData = "{\"Person Name\":\"takahiro\",\"Person Age\":46,\"Person Weight\":63.5}";

            Person person = new Person();

            // インスタンス person にデシリアライズ
            person = JsonConvert.DeserializeObject<Person>(jsonData);

            Console.ReadLine();
        }
    }
}
<!-- wp:image {"id":8792,"linkDestination":"media"} -->
<figure class="wp-block-image"><a href="https://blog.hiros-dot.net/wp-content/uploads/2019/06/image-8.png"><img class="wp-image-8792" src="https://blog.hiros-dot.net/wp-content/uploads/2019/06/image-8-1024x216.png" alt="" /></a>
<figcaption>デシリアライズされたデータの確認</figcaption>
</figure>

<p>デシリアライズをすると、以下のように person の Name, Age, Weight にそれぞれデータが格納されていることがわかります。</p>

<h2><a id="writeFile"></a>JSONデータをファイルに書き込もう</h2>

<p>JSON のシリアライズと組み合わせてファイルに書き込む方法について説明します。</p>

<p>ファイルの書き込みは　StreamWriter クラスを使用することとします。22行目で使用している StreamWriter は第１引数が 書き込み先のファイルパス、第２引数が追加書き込みをするかどうか、第３引数が書き込み時のエンコーディング を指定できるものです。第１引数のファイルパスの先頭にある @ ですが、これは文字列中の「\」をエスケープ処理しなくてもいいようにするものです。@をつけない場合は「C:\\work\\json.data」のようにエスケープ処理をしたパスの文字列を書く必要があります。</p>

<p>実際のデータの書き込みは、25行目の write メソッドで行っています。</p>

<p>なお、以下の例ではエラー処理をしていません。書き込み先のディレクトリがなかったり書き込もうとしたファイルがすでにつかまれているような場合はエラーが発生しますので注意してください。</p>

using Newtonsoft.Json;
using System;
using System.IO;  // ファイル書き込みのために追加

namespace JsonSample
{
    class Program
    {
        static void Main(string[] args)
        {            
            Person person = new Person();
  
            // データを設定
            person.Name = "takahiro";
            person.Age = 46;
            person.Weight = 63.5;

            // JSON データにシリアライズ
            var jsonData = JsonConvert.SerializeObject(person);

            // C:¥Work¥test.json を UTF-8 で書き込み用でオープン
            using (var sw = new StreamWriter(@"C:\Work\test.json", false, System.Text.Encoding.UTF8))
            {
                // JSON データをファイルに書き込み
                sw.Write(jsonData);
            }

            Console.ReadLine();
        }
    }
}

<h2><a id="readFile"></a>JSONファイルを読み込もう</h2>

<p>続いて、JSONファイルのデータを読み込んでシリアライズする例を示します。ファイルの読み込みには　StreamReader を使用することとします。 StreamReader の第１引数には読み込み対象のファイルパスを、第２引数にエンコーディングを指定しています。</p>

<p>実際のデータ読み込みは、17行目の ReadToEnd メソッドで行っています。ReadToEndメソッドは指定したファイルを先頭から末尾までをすべて読み込んで文字列として返します。</p>

<p>読み込んだデータは20行目でデシリアライズをしています。</p>

<p>なお以下の例ではエラー処理をしていません。読み込み先のファイルがない場合や、デシリアライズでできない場合はエラーになるので注意してください。</p>

using Newtonsoft.Json;
using System;
using System.IO;  // ファイル書き込みのために追加

namespace JsonSample
{
    class Program
    {
        static void Main(string[] args)
        {
            Person person = new Person();

            // C:¥Work¥test.json を UTF-8 で開く
            using (var sr = new StreamReader(@"C:\Work\test.json", System.Text.Encoding.UTF8))
            {
                // 変数 jsonData にファイルの内容を代入 
                var jsonData = sr.ReadToEnd();

                // デシリアライズして person にセット
                person = JsonConvert.DeserializeObject<Person>(jsonData);
            }

            Console.ReadLine();
        }
    }
}
<h2>Newtonsoft.Jsonを使ったアプリの例</h2>
<p>Newtonsoft.Jsonを利用したアプリのサンプル例を公開しました。</p>
<p><a href="https://blog.hiros-dot.net/?p=14267">[Windowsフォームアプリ] Jsonデータをツリービューに表示する方法1</a></p>