JsonUtility.ToJson() でシリアライズしたクラス配列に初期値が入る問題を回避したい

Question

解決したい問題

JsonUtility.ToJson()でJSONに変換したクラス配列データの要素にnullの要素があった時、クラスのフィールド変数の型の初期値が入るようです。JSONに変換するだけで配列に値が入ってしまうようで、nullチェックなどが通用しなくなって困っています。配列に要素を入れないようにする方法はありますでしょうか？

該当のソースコード

データ用クラス ItemData

using System;
using UnityEngine;

[Serializable]
public class ItemData
{
    [SerializeField] int id;
    [SerializeField] string name;

    public int ID { get { return id; } }
    public string NAME { get { return name; } }

    public ItemData(int id, string name)
    {
        this.id = id;
        this.name = name;
    }
}

データ管理用クラス ItemManager

using System;
using UnityEngine;

[Serializable]
public class ItemManager
{
    // 簡易的なシングルトン
    public static ItemManager Instance { get { return instance; } }

    private static ItemManager instance = new ItemManager();

    private ItemManager()
    {
        Debug.Log("Created Instance.");
    }

    // JSONに変換したいクラス配列
    [SerializeField] private ItemData[] itemDataArray = new ItemData[5];

    // アイテムをnullのインデックスに格納
    public void CreateItemData()
    {
        for(int i = 0; i < itemDataArray.Length; i++) {
            if(itemDataArray[i] == null) {
                itemDataArray[i] = new ItemData(i, "Test" + i.ToString());
                break;
            }
        }
    }

    // 配列をJSONに変更（外部にデータ保存のため）
    public void ConvertToJson()
    {
        string json = JsonUtility.ToJson(ItemManager.Instance);
        Debug.Log(json);
    }

    // Debug.Log()にアイテムの名前一覧を表示
    public void PrintData()
    {
        for(int i = 0; i < itemDataArray.Length; i++) {
            if(itemDataArray[i] != null) {
                Debug.Log(itemDataArray[i].NAME);
            }
        }
    }
}

実際にデータクラスを呼ぶクラス

using UnityEngine;

public class Test : MonoBehaviour
{

    private void Start()
    {
        // 適当に3つくらいデータを格納する
        ItemManager.Instance.CreateItemData();
        ItemManager.Instance.CreateItemData();
        ItemManager.Instance.CreateItemData();
        
        // まずはそのまま表示
        ItemManager.Instance.PrintData();
        
        // Jsonに変換
        ItemManager.Instance.ConvertToJson();

        // Jsonに変換してからまた表示すると、なぜか値が入っている
        ItemManager.Instance.PrintData();
    }
}

出力結果

Jsonにシリアライズしてから表示すると、nullチェックが効いていない

開発環境

• Unity 2019.4.15f

現状の回避方法

    // 配列をJSONに変更（外部にデータ保存のため）
    public void ConvertToJson()
    {
        string json = JsonUtility.ToJson(ItemManager.Instance);
        Debug.Log(json);

        // 現状の回避方法として、配列要素が初期値になっていたら
        // nullにするという方法をとっていますが、そのためにこの処理を追加するのもつらいです
        for(int i = 0; i < itemDataArray.Length; i++) {
            if(itemDataArray[i].NAME == null) {
                itemDataArray[i] = null;
            }
        }
    }

Answer 1

デバッガで実行過程を見てみると、おっしゃる通りToJsonを通過するとたちまち要素3番と4番が出現していました。

ToJsonの説明を見てみてもこの現象に関する言及はなさそうですし、ToJsonの実装を見てみても肝心の処理内容はネイティブコードになっていて追跡困難で、これはもうこういうものとしてあきらめて、何とか対処するしかないのかもしれません。

あくまでも想像に過ぎませんが、ToJsonでシリアライズする際に、内部的にはItemManager自身は実はJSON表現から（あるいはもしかするとその中間表現から）デシリアライズされる過程があるのかもしれませんね。
ご質問者さんがお試しの通り、nullだったインデックスにはデフォルト値の要素が入ってきてしまうのなら、逆にそれを利用して要素が元々はnullだったのかどうか識別するというのは、不本意かもしれませんが妥当な手段なような気がします。

あるいはItemDataを下記のようにして、ニセnull判定を行うとかでしょうかね?
個人的にはnullじゃないのにnullのふりをするというのは余計な混乱を招きそうで、不健全な香りがしますが...

using System;
using UnityEngine;

[Serializable]
public class ItemData
{
    [SerializeField] private bool isNotNull;
    [SerializeField] int id;
    [SerializeField] string name;

    public int ID { get { return this.id; } }
    public string NAME { get { return this.name; } }

    public ItemData(int id, string name)
    {
        this.isNotNull = true;
        this.id = id;
        this.name = name;
    }

    public static bool operator ==(ItemData x, ItemData y) => CompareEquality(x, y);

    public static bool operator !=(ItemData x, ItemData y) => !CompareEquality(x, y);

    public override bool Equals(object obj)
    {
        return CompareEquality(this, obj as ItemData);
    }

    public override int GetHashCode()
    {
        return base.GetHashCode();
    }

    private static bool CompareEquality(ItemData lhs, ItemData rhs)
    {
        var lhsIsActualNull = ReferenceEquals(lhs, null);
        var rhsIsActualNull = ReferenceEquals(rhs, null);
        
        if (rhsIsActualNull && lhsIsActualNull)
        {
            return true;
        }

        if (rhsIsActualNull)
        {
            return !lhs.isNotNull;
        }

        return lhsIsActualNull ? !rhs.isNotNull : ReferenceEquals(lhs, rhs);
    }
}

Comments

[honjoriki]

Bongo様。ご回答ありがとうございます。

JsonUtility.ToJson()の実装まで確認していただきありがとうございます。
やはり現状、こちらのほうで何らかの対処をしなければいけないようですね...。
ToJsonの仕様上、こうなってしまうことが明らかになりましたので、Bongo様のご回答のとおり、
「あらかじめbool変数を用意しておき、その変数で判断する」のがセオリーになるのではないかと思いました。

ありがとうございました。