C#でリストをJSONから読み込む - プログラムを書こう！

この記事は2022年04月23日に投稿しました。

1. はじめに

こんにちは、iOSのエディタアプリPWEditorの開発者の二俣です。
今回は業務で使用しているC#でリストをJSONから読み込む方法についてです。

2. C#でリストをJSONから読み込む

C#でリストをJSONから読み込むには、DataContractJsonSerializerを使用し、以下の様な実装にします。
今回は.NET Frameworkの場合になります。

実装例

※参照に"System.Runtime.Serialization"を追加してください。

using System;
using System.Collections.Generic;
using System.IO;
using System.Runtime.Serialization;
using System.Runtime.Serialization.Json;
using System.Text;

namespace SampleReadJsonList
{
    /// <summary>
    /// JSONに書き出すオブジェクトクラスを定義します。
    /// クラス名に[DataContract]、メンバーに[DataMember]を付加します。
    /// </summary>
    [DataContract]
    class Person
    {
        [DataMember]
        public int id { get; set; }

        [DataMember]
        public string name { get; set; }

        [DataMember]
        public int age { get; set; }
    }

    class Program
    {
        static void Main(string[] args)
        {
            // 読み込むJSON文字列
            var json = @"[{ ""age"":21,""id"":1,""name"":""Newral1""},{ ""age"":22,""id"":2,""name"":""Newral2""},{ ""age"":23,""id"":3,""name"":""Newral3""}]";

            // 読み込んだJSONを設定するリストオブジェクト
            var personList = new List<Person>();

            // リストオブジェクトにJSONを読み込みます。
            var program = new Program();
            program.ReadJson(json, ref personList);

            // 読み込んだ内容を確認します。
            foreach (var person in personList)
            {
                Console.WriteLine("id:{0} name:{1} age:{2}", person.id, person.name, person.age);
            }

            Console.ReadKey();
        }

        /// <summary>
        /// JSON文字列をオブジェクトに読み込みます。
        /// </summary>
        /// <param name="json">JSON文字列</param>
        /// <param name="obj">オブジェクト</param>
        void ReadJson<T>(string json, ref T obj)
        {
            using (var stream = new MemoryStream(Encoding.Unicode.GetBytes(json)))
            {
                var serializer = new DataContractJsonSerializer(obj.GetType());
                obj = (T)serializer.ReadObject(stream);
            }
        }
    }
}

実行結果

id:1 name:Newral1 age:21
id:2 name:Newral2 age:22
id:3 name:Newral3 age:23

API Reference

DataContractJsonSerializer

目次へ

3. おわりに

前回

www.paveway.info

と処理は変わらず、リストを渡せばJSONを読み込めます。

リンク

紹介している一部の記事のコードはGitlabで公開しています。
興味のある方は覗いてみてください。

目次へ

私が勤務しているニューラルでは、主に組み込み系ソフトの開発を行っております。
弊社製品のハイブリッドOS Bi-OSは高い技術力を評価されており、特に制御系や通信系を得意としています。
私自身はiOSモバイルアプリやウィンドウズアプリを得意としております。
ソフトウェア開発に関して相談などございましたら、お気軽にご連絡ください。

また一緒に働きたい技術者の方も随時募集中です。
興味がありましたらご連絡ください。

EMAIL : info-nr@newral.co.jp / m-futamata@newral.co.jp
TEL : 042-523-3663
FAX : 042-540-1688

目次へ