C#でファイルからJSONを読み込む - プログラムを書こう！

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

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;
using System.Text;

namespace SampleReadJsonFile
{
    /// <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ファイル名
           // ファイルの内容:{"id":1, "name":"Newral", "age":20}
            var path = "person.json";

            // 読み込んだJSONを格納するオブジェクト
            var person = new Person();

            // JSONファイルを読み込み、オブジェクトに設定します。
            var program = new Program();
            program.ReadJsonFile(path, ref person);

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

            Console.ReadKey();
        }

        /// <summary>
        /// JSONファイルを読み込みます。
        /// </summary>
        /// <typeparam name="T">読み込んだJSONを格納するオブジェクトの型</typeparam>
        /// <param name="path">JSONファイルパス名</param>
        /// <param name="obj">読み込んだJSONを格納するオブジェクト</param>
        public void ReadJsonFile<T>(string path, ref T obj)
        {
            using (var reader = new StreamReader(path))
            {
                var text = reader.ReadToEnd();
                using (var stream = new MemoryStream(Encoding.Unicode.GetBytes(text)))
                {
                    var serializer = new DataContractJsonSerializer(obj.GetType());
                    obj = (T)serializer.ReadObject(stream);
                }
            }
        }
    }
}

実行結果

id:1 name:Newral age:20

API Reference

DataContractJsonSerializer

DataContractJsonSerializerSettings

目次へ

3. おわりに

前回

www.paveway.info

と対になる機能です。

リンク

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

目次へ

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

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

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

目次へ