C#でDictionaryをJSONに書き出す - プログラムを書こう！

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

1. はじめに

こんにちは、iOSのエディタアプリPWEditorの開発者の二俣です。
今回は業務で使用しているC#でDictionaryをJSONに書き出す方法についてです。

2. C#でDictionaryをJSONに書き出す

C#でDictionaryを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;

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

        public Sample()
        {
            Data = new Dictionary<int, string>();
        }
    }

    class Program
    {
        static void Main(string[] args)
        {
            // Dictionaryデータを用意する。
            var sample = new Sample();
            sample.Data.Add(0, "Apple");
            sample.Data.Add(1, "Banana");
            sample.Data.Add(2, "Orange");

            // DictionaryデータをJSONに書き出します。
            var program = new Program();
            var result = program.WriteJson(sample);
            Console.WriteLine(result);

            Console.ReadKey();
        }

        /// <summary>
        /// オブジェクトの内容をJSONに書き出します。
        /// </summary>
        /// <param name="obj">オブジェクト</param>
        /// <returns>JSON文字列</returns>
        string WriteJson<T>(T obj)
        {
            using (var stream = new MemoryStream())
            using (var reader = new StreamReader(stream))
            {
                // Dictionary使用を設定します。
                var settings = new DataContractJsonSerializerSettings();
                settings.UseSimpleDictionaryFormat = true;
                var serializer = new DataContractJsonSerializer(obj.GetType(), settings);
                serializer.WriteObject(stream, obj);

                stream.Position = 0;
                var result = reader.ReadToEnd();
                return result;
            }
        }
    }
}

実行結果

{"Data":{"0":"Apple","1":"Banana","2":"Orange"}}

API Reference

DataContractJsonSerializer

DataContractJsonSerializerSettings

目次へ

3. おわりに

前回

www.paveway.info

と処理はほとんど変わりませんが、Dictionaryの場合、Dictionaryを使う設定をする必要があります。

リンク

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

目次へ

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

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

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

目次へ