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

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

1. はじめに

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

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

C#でKeyValuePairをJSONに書き出すには、次のような実装にします。

実装例

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

namespace SampleWriteJsonKeyValuePair
{
    /// <summary>
    /// KeyValuePairを保持するクラス
    /// </summary>
    [DataContract]
    public class Person
    {
        [DataMember]
        public KeyValuePair<string, int> Data { get; set; }
    }

    public class Program
    {
        private static void Main(string[] args)
        {
            // KeyValuePairを保持するクラスを生成、データを設定します。
            var person = new Person()
            {
                Data = new KeyValuePair<string, int>("Taro", 20)
            };

            // KeyValuePairを保持するクラスをJSONに書き出します。
            var program = new Program();
            var json = program.WriteJson(person);
            
            // JSONに書き出した内容を確認します。
            Console.WriteLine(json);
            Console.ReadKey();
        }

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

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

実行結果

{"Data":{"key":"Taro","value":20}}

API Reference

JSON

KeyValuePair構造体

目次へ

3. おわりに

業務でKeyValuePairをJSONに書き出す必要がありその方法を調査しました。
特に他のクラスと変わりなくJSONに書き出せるようです。
ただ書き出したJSONのキー項目と値項目にはKeyとValueというキーワードも書き出されるようです。

リンク

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

目次へ

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

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

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

目次へ