【C#】JSONのデシリアライズで、配列の場合とそうでない場合の際の対処法が知りたい

Question

前提・実現したいこと

下記サイトで、配列とそうではい場合はobject型で受けて別途キャストが必要と記載されていましたが（下記画像）、
これは値を使用する際に毎回キャストが必要なんでしょうか？
object型になっている部分そのものをキャストして持てるんでしょうか？（クラス自体のキャスト）
public object api_get_meateriak → public List<int> api_get_meateriak

うまく伝わっているかわかりませんが、デシアライズしたクラスにキャスト後の値を持てるのかということです。
クラスを使う際に
「ApiData.api_get_meateriak(object)」ではなく「ApiData.api_get_meateriak(List<int>)」として使えるのか

宜しくお願いします。

http://www2.hatenadiary.jp/entry/2013/12/14/030112

追記1

JSON 文字列のサンプルを書いて、それのどこで悩んでいるのか具体的に書いてもらえませんか？　今の質問内容ではそのあたりが分からないです。

jsonを送られてくる可能性として、配列の場合とそうでない場合があります

{
  "LoginList": {
    "LoginItem": [
      {
        "ID": "TEST01"
      },
      {
        "ID": "TEST02"
      }
    ]
  }
}

{
  "LoginList": {
    "LoginItem": {
      "ID": "TEST01"
    }
  }
}

visual studioの機能でjsonからクラスを作成

        public class Rootobject
        {
            public Loginlist LoginList { get; set; }
        }

        public class Loginlist
        {
            public Loginitem LoginItem { get; set; }
        }

        public class Loginitem
        {
            public string ID { get; set; }
        }

しかしこのままだと配列ではない場合はデシリアライズが成功しますが、配列だとExceptionになります
逆にpublic List<Loginitem> LoginItem { get; set; }にすると配列でない場合にExceptionになります

なのでそれを避けるために上記で記載したとおりpublic object LoginItem { get; set; }にするという記事を見つけました
ですが、obejctだとそのまま使用できないのでキャストが必要となるらしいのですが、

配列ではないのならば下記のように持ち

配列なら下記のように持つことが出来ないのか

上記のようにクラス自体はどうにもならないのであれば、LoginItem の中身を使用する際に都度キャストが必要なのかという内容です。

補足情報（FW/ツールのバージョンなど）

Visual Studio2019
.Net Core 3.1
C#
Newtonsoft.Json

Comments

[退会済みユーザー]

.Net Core 3.1 で Newtonsoft.Json というのは間違いないですか？　System.Text.Json というのがあるのに知らずに使っているということはないですか？

JSON 文字列のサンプルを書いて、それのどこで悩んでいるのか具体的に書いてもらえませんか？　今の質問内容ではそのあたりが分からないです。

[Leizi]

SurferOnWwwさん
回答有り難うございます。
> System.Text.Json というのがあるのに知らずに使っているということはないですか？
あるのは知っていますが、Newtonsoft.Jsonを使用しています

>JSON 文字列のサンプルを書いて、それのどこで悩んでいるのか具体的に書いてもらえませんか？
追記致しました、確認お願いします

[退会済みユーザー]

JSON 文字列が不定で決まった T の定義ができないということなら、それは配列か否か云々を超えて悩まなければならない話と思いますが、そういう場合でも Dictionary<string,object> 型にならデシリアライズできるので、それからどうするか考えるという話になるかと思います。

[Leizi]

var model = JsonConvert.DeserializeObject<Dictionary<string, object>>(request);
にするということでしょうか？
これはこれで難しいんですが…

[退会済みユーザー]

> これはこれで難しいんですが…

難しい云々以前に、JSON 文字列が不定で決まった T の定義ができないということならそうせざるを得ないかと思います。

質問者さんが気にしている配列か否かで悩むという単純なケースはまず無さそうな気がします。配列になることがあるなら設計時点で配列にして、API 仕様に明記しておけばすむ話だと思います。要素数が 1 つの配列だってあるわけですから。取得するまでどっちか分からないからユーザーによしなに対応してくれというのでは設計がまずいです。

[Leizi]

jsonがほとんど初めて触るので初歩的な質問になってしまうかもしれませんが、要素が1つの配列はjsonの形式として有りなんでしょうか？

例えばxmlから変換すると配列じゃなくなってしまうのですが
<LoginList>
<LoginItem>
<ID>TEST01</ID>
</LoginItem>
</LoginList>
↓
{
"LoginList": {
"LoginItem": {
"ID": "TEST01"
}
}
}

、それは変換の仕様であって普通に
{
"LoginList": {
"LoginItem": [
{
"ID": "TEST01"
}
]
}
}
として作成できるのでしょうか？

ここのコメントですいません…

[退会済みユーザー]

> 要素が1つの配列はjsonの形式として有りなんでしょうか？

有りです。

> 例えばxmlから変換すると配列じゃなくなってしまうのですが

XML から変換って何なのですか？　このスレッドでは初めて出てきた話のようですが？

[Leizi]

例えで出したので、特に気にしなくても問題有りません。
ありがとうございました。

Answer 1

型が変わってしまったら、ただただ扱いづらいだけです。
実際にやりたいことは、どちらを読んでもList<Loginitem>になることではないですか？

sendgrid - How to handle both a single item and an array for the same property using JSON.net - Stack Overflow

using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using System;
using System.Linq;
using System.Collections.Generic;

namespace Questions320367
{
    class Program
    {
        static void Main()
        {
            var arrayJson = @"
{
  ""LoginList"": {
    ""LoginItem"": [
      {
        ""ID"": ""TEST01""
      },
      {
        ""ID"": ""TEST02""
      }
    ]
  }
}";
            var result = JsonConvert.DeserializeObject<Rootobject>(arrayJson);
            List<Loginitem> loginItem = result.LoginList.LoginItem;

            Console.WriteLine(loginItem.Count);
            Console.WriteLine(string.Join(", ", loginItem.Select(x => x.ID)));


            var singleJson = @"
{
  ""LoginList"": {
    ""LoginItem"": {
      ""ID"": ""TEST01""
    }
  }
}";
            result = JsonConvert.DeserializeObject<Rootobject>(singleJson);
            loginItem = result.LoginList.LoginItem;

            Console.WriteLine(loginItem.Count);
            Console.WriteLine(string.Join(", ", loginItem.Select(x => x.ID)));
        }
    }

    public class Rootobject
    {
        public Loginlist LoginList { get; set; }
    }
    public class Loginlist
    {
        [JsonConverter(typeof(SingleOrArrayConverter<Loginitem>))]
        public List<Loginitem> LoginItem { get; set; }
    }
    public class Loginitem
    {
        public string ID { get; set; }
    }

    // [sendgrid - How to handle both a single item and an array for the same property using JSON.net - Stack Overflow](https://stackoverflow.com/questions/18994685/how-to-handle-both-a-single-item-and-an-array-for-the-same-property-using-json-n/18997172#18997172)
    internal class SingleOrArrayConverter<T> : JsonConverter
    {
        public override bool CanConvert(Type objectType) => objectType == typeof(List<T>);
        public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
        {
            var token = JToken.Load(reader);
            if (token.Type == JTokenType.Array)
            {
                return token.ToObject<List<T>>();
            }
            return new List<T> { token.ToObject<T>() };
        }

        public override bool CanWrite => false;
        public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) => throw new NotImplementedException();
    }
}

---

System.Text.Json版

c# - How to handle both a single item and an array for the same property using System.Text.Json? - Stack Overflow

using System;
using System.Collections;
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using System.Text.Json.Serialization;

namespace Questions320367
{
    class Program
    {
        static void Main()
        {
            var arrayJson = @"
{
  ""LoginList"": {
    ""LoginItem"": [
      {
        ""ID"": ""TEST01""
      },
      {
        ""ID"": ""TEST02""
      }
    ]
  }
}";
            var result = JsonSerializer.Deserialize<Rootobject>(arrayJson);
            List<Loginitem> loginItem = result.LoginList.LoginItem;

            Console.WriteLine(loginItem.Count);
            Console.WriteLine(string.Join(", ", loginItem.Select(x => x.ID)));


            var singleJson = @"
{
  ""LoginList"": {
    ""LoginItem"": {
      ""ID"": ""TEST01""
    }
  }
}";
            result = JsonSerializer.Deserialize<Rootobject>(singleJson);
            loginItem = result.LoginList.LoginItem;

            Console.WriteLine(loginItem.Count);
            Console.WriteLine(string.Join(", ", loginItem.Select(x => x.ID)));
        }
    }

    public class Rootobject
    {
        public Loginlist LoginList { get; set; }
    }
    public class Loginlist
    {
        [JsonConverter(typeof(SingleOrArrayConverter<Loginitem>))]
        public List<Loginitem> LoginItem { get; set; }
    }
    public class Loginitem
    {
        public string ID { get; set; }
    }


    // [c# - How to handle both a single item and an array for the same property using System.Text.Json? - Stack Overflow](https://stackoverflow.com/questions/59430728/how-to-handle-both-a-single-item-and-an-array-for-the-same-property-using-system)
    public class SingleOrArrayConverter<TItem> : SingleOrArrayConverter<List<TItem>, TItem>
    {
        public SingleOrArrayConverter() : this(true) { }
        public SingleOrArrayConverter(bool canWrite) : base(canWrite) { }
    }

    public class SingleOrArrayConverter<TCollection, TItem> : JsonConverter<TCollection> where TCollection : class, ICollection<TItem>, new()
    {
        public bool CanWrite { get; }

        public SingleOrArrayConverter() : this(true) { }
        public SingleOrArrayConverter(bool canWrite) => CanWrite = canWrite;

        public override TCollection Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
        {
            switch (reader.TokenType)
            {
                case JsonTokenType.Null: return null;
                case JsonTokenType.StartArray:
                    var list = new TCollection();
                    while (reader.Read())
                    {
                        if (reader.TokenType == JsonTokenType.EndArray) break;
                        list.Add(JsonSerializer.Deserialize<TItem>(ref reader, options));
                    }
                    return list;
                default:
                    return new TCollection { JsonSerializer.Deserialize<TItem>(ref reader, options) };
            }
        }
        public override void Write(Utf8JsonWriter writer, TCollection value, JsonSerializerOptions options)
        {
            if (CanWrite && value.Count == 1)
            {
                JsonSerializer.Serialize(writer, value.First(), options);
            }
            else
            {
                writer.WriteStartArray();
                foreach (var item in value) JsonSerializer.Serialize(writer, item, options);
                writer.WriteEndArray();
            }
        }
    }
}

Comments

[Leizi]

TN8001さん
回答ありがとうございます。
自分で思い描いている感じとして理想形な解決法でした！

Answer 2

質問の私のコメントに対し追記１を書いていただけたので、それに対するレスを以下に書きます。

上記のようにクラス自体はどうにもならないのであれば、LoginItem の中身を使用する際に都度キャストが必要なのかという内容です。

JSON 文字列が、

{"LoginList":{"LoginItem":[{"ID":"TEST01"},{"ID":"TEST02"}]}}

でも、

{"LoginList":{"LoginItem":{"ID":"TEST01"}}}

でも、

var rootObject = JsonConvert.DeserializeObject<Rootobject>(JSON 文字列)

でデシリアライズできるようにするため、Rootobject の定義を、

public class Rootobject
{
    public Loginlist LoginList { get; set; }
}

public class Loginlist
{
    public object LoginItem { get; set; }
}

public class Loginitem
{
    public string ID { get; set; }
}

のようにしたが、その先どのように Loginitem を取得するかという話と理解しています。理解が違っていたら指摘してください。

上記の Rootobject クラスの定義を使ってデシリアライズした結果の rootObject.LoginList.LoginItem は Newtonsoft.Json.Linq.JArray 型または Newtonsoft.Json.Linq.JObject 型になります。

なので、単純に Loginitem または Loginitem[] にキャストして何とかできるということはなくて、JArray, JObject にキャストしてそのプロパティなどを使って Value を取得することになります。

具体例は以下の通りです。

Console.WriteLine("------Newtonsoft.Json---------------------");
            
string str1 = "{\"LoginList\":{\"LoginItem\":[{\"ID\":\"TEST01\"},{\"ID\":\"TEST02\"}]}}";
var ro1 = JsonConvert.DeserializeObject<Rootobject>(str1);
var items1 = ro1.LoginList.LoginItem as JArray;
if (items1 != null)
{
    foreach (JObject jobj in items1)
    {
        JValue idValue = (JValue)jobj["ID"];
        string value = (string)idValue.Value;
        Console.WriteLine($"ID: {value}");
    }
}

Console.WriteLine("---------------------------");

string str2 = "{\"LoginList\":{\"LoginItem\":{\"ID\":\"TEST01\"}}}";            
var ro2 = JsonConvert.DeserializeObject<Rootobject>(str2);
var item2 = ro2.LoginList.LoginItem as JObject;
if (item2 != null)
{
    JValue idValue = (JValue)item2["ID"];
    string value = (string)idValue.Value;
    Console.WriteLine($"ID: {value}");
}

結果は以下のようになります。

------Newtonsoft.Json---------------------
ID: TEST01
ID: TEST02
---------------------------
ID: TEST01

Comments

[Leizi]

SurferOnWwwさん
回答ありがとうございます。
object型の対応としては、理想的だと思いました。

Answer 3

悩みのポイントがよくわかんないけど、ApiData.api_get_meateriakがJArray型か否かを判別する方法までわかっているなら、それがtrueの時にToObject<T>()メソッドを使ってその値をデシリアライズした値を持っておけばいいだけじゃないだろうか。

Comments

[Leizi]

gentaroさん
回答有り難うございます。
結局の所、クラス自体はobject型のままで、その値(object型の中身)を使用したい場合は別途デシリアライズした値を使うしか無いってことで宜しいでしょうか？（元のクラスとしては使えない）
自分も伝え方が難しいです…

[gentaro]

そもそも論としてC#は静的型付けの言語なので、配列の場合はList<T>にマップする、そうでない場合はTにマップする、といったように、マップするクラスまたはプロパティをそれぞれ用意しないと、たぶんあなたの質問にあるような「毎回キャストが必要」な状況は避けられません。
それをデシリアライズ時にやるのか、object等にいったん入れておいて利用する際にやるのか、という違いでしか無いです。
一応dynamicという静的型付けのメリットを捨て去る方法もあるけど、コンパイル時エラーが補足できなくなるなどのデメリットもあるので、あんまりお勧めはしません。

[Leizi]

理解しました。
ありがとうございます！