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

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

1. はじめに

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

2. C#でJSONに書き出す

C#でJSONに書き出すには、DataContractJsonSerializerを使用し、以下の様な実装にします。
今回は.NET Frameworkの場合になります。

実装例

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

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

namespace SampleWriteJson
{
    /// <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)
        {
            var program = new Program();
            var person = new Person()
            {
                id = 1,
                name = "Newral",
                age = 20,
            };
            var json = program.WriteJson(person);
            Console.WriteLine(json);

            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))
            {
                // オブジェクトをJSONに書き出します。
                var serializer = new DataContractJsonSerializer(obj.GetType());
                serializer.WriteObject(stream, obj);

                // 書き出したJSONを文字列として返却します。
                stream.Position = 0;
                var result = reader.ReadToEnd();
                return result;
            }
        }
    }
}

実行結果

{"age":20,"id":1,"name":"Newral"}

API Reference

DataContractJsonSerializer

目次へ

3. おわりに

業務で作成してるアプリの設定ファイルを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

目次へ