デシリアライズにより失われる参照関係への対策

Question

前提・実現したいこと

Unity/C#によるゲーム開発をしています。
データのセーブ・ロードをJSONシリアライズ／デシリアライズにより実現しようと考えていたところ、
下記の問題に思い当たりました。

発生している問題・エラーメッセージ

「シリアライズによりオブジェクト参照関係が失われ、デシリアライズ時には複数のインスタンスが生成されてしまう」

例えばRPGで考えますと、キャラクターを管理するCharacterクラスのインスタンスと、
パーティーを管理するList<Character>のインスタンスがあるとします。
また、キャラクタはA, B, Cの３人。パーティーは１つだけで、キャラクタA,Bが所属している（Listに含まれている）と考えます。

PGMの初めの実行時（メモリ上）では、パーティーのインスタンスにはキャラクタA,Bへの参照として情報が保持されています。
そのため、アイテムの装備画面などでキャラクタAの情報を更新した場合でも、パーティーのインスタンスにも情報が反映されています。
（もちろん、同じオブジェクトを参照しているので当たり前のことです）

つまり、戦闘を行う場合は、パーティーインスタンスの情報だけを持っていれば問題ないということです。

しかし、セーブ・ロードのためのシリアライズ／デシリアライズをかませることで、問題が発生します。
パーティーのインスタンスと、キャラクタのインスタンスをデシリアライズした結果、オブジェクトの参照関係が失われてしまうからです。
上記の例でいうと、パーティーに所属しているキャラクタAのインスタンスと、個別のキャラクタのインスタンスAが、別々に存在してしまいます。
アイテムの装備画面でキャラクタAの情報を更新した場合、パーティーのインスタンスのAには反映されなくなってしまいます。

検討したこと

対策案１．
シリアライズするクラスは、他のクラスへのオブジェクト参照は持たずに、間接的に情報を持つようにする。
上記の例でいうと、パーティーの管理はList<Character>ではなく、CharacterにIDを持たせて、そのIDを参照するList<int>として、実装する。

　メリット：やりたいことは実現できそう
デメリット：直感的なロジックではなくなる

対策案２．
オブジェクトへの参照箇所を１つにする。
個別にCharacterのインスタンスを持つのではなく、List<Character>のみを管理するようにする。

　メリット：やりたいことはできそう。
デメリット：アイテムの装備画面など、Characterだけを相手にしたいときは多いはず。そのようなときにノイズとなる。また、例のような簡単なケースではなく、規模が大きくなるほどに問題も膨れ上がりそう。

対策案1を採用することになるのかなと考えていますが、検討してみた対策に自信がなかったため、質問をさせていただきました。
上記の対策案の是非、他のやり方などを教えていただければ幸いです。

###補足
このデシリアライズによる問題点を調べたのですが、困っているという情報すら出てこなかったため、困惑しております。
そもそもの私の設計思想が間違っているため、この問題に突き当たっている可能性もあるのかなと考えてはいます。

Answer 1

Unityを使用したことがなく、業務系アプリしか作ったことがないのですが下記のような感じでどうでしょうか？
y_waiwai様の内容をコードにした程度ではありますが・・
基本的な考えとしてこのような状況では自分もy_waiwai様と同じでオブジェクト参照を回復するという方法で管理すると思います。
なのであまりそういった情報が無い&ライブラリ等も無いのかなと思います。

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

namespace ConsoleApp1 {

    class Program {

        static void Main(string[] args) {

            Party = new List<Character>();
            Characters = new Dictionary<string, Character>();

            var characterA = Add(new Character() { Name = "A", Job = "勇者" });
            var characterB = Add(new Character() { Name = "B", Job = "賢者" });
            var characterC = Add(new Character() { Name = "C", Job = "戦士" });
            var characterD = Add(new Character() { Name = "D", Job = "戦士" });
            var characterE = Add(new Character() { Name = "E", Job = "戦士" });

            Party.AddRange(new[] { characterA, characterB, characterC });

            Save();

            Load();

            System.Diagnostics.Debug.WriteLine(Party[1].Job);
            Characters["B"].Job = "忍者";
            System.Diagnostics.Debug.WriteLine(Party[1].Job);
        }

        private static Character Add(Character character) {
            Characters.Add(character.Name, character);
            return character;
        }

        [Serializable()]
        private class Character {
            public string Name { set; get; }
            public string Job { set; get; }
        }

        private static List<Character> Party;
        private static Dictionary<string, Character> Characters;

        private static void Save() {

            using (var stream = new FileStream("Characters.dat", FileMode.Create)) {
                var serializer = new DataContractJsonSerializer(typeof(Dictionary<string, Character>));
                serializer.WriteObject(stream, Characters);
            }

            using (var stream = new FileStream("Party.dat", FileMode.Create)) {
                var serializer = new DataContractJsonSerializer(typeof(IEnumerable<string>));
                serializer.WriteObject(stream, Party.Select(x => x.Name));
            }
        }

        private static void Load() {

            using (var stream = new FileStream("Characters.dat", FileMode.OpenOrCreate)) {
                var serializer = new DataContractJsonSerializer(typeof(Dictionary<string, Character>));
                Characters = (Dictionary<string, Character>)serializer.ReadObject(stream);
            }

            IEnumerable<string> names;

            using (var stream = new FileStream("Party.dat", FileMode.OpenOrCreate)) {
                var serializer = new DataContractJsonSerializer(typeof(IEnumerable<string>));
                names = (IEnumerable<string>)serializer.ReadObject(stream);
            }

            Party = new List<Character>();
            foreach (var name in names) {
                if (Characters.TryGetValue(name, out var character)) {
                    Party.Add(character);
                }
            }
        }

    }
}

Comments

[m3m3]

コードの作成もしていただき、ありがとうございます。
やはりコードで見ると理解が進みますね。

私もあれから検討した結果、オブジェクトの参照を回復させる方向で考えています。
具体的には、Unityで用意されているインタフェース（Unityの話になりますが、ISerializationCallbackReceiver らしいです）を利用することで、該当のクラスがシリアライズ／デシリアライズされる際に、自動でオブジェクト参照を回復してくれるようにするつもりです。

本題とはそれますが、上記に関係して地味な悩みが出てきました。
オブジェクト参照を回復させるための、関連付けをする情報をどこに持つべきなのか、という問題です。
書いていただいたコード
var characterA = Add(new Character() { Name = "A", Job = "勇者" });
にあるように、DictionaryなどでCharacterクラスの外に関連付けの情報（上記ではName = "A"）を持つべきか、Characterクラスの中に、Name=Aのように持つべきか。

管理のしやすさ（直感的なわかりやすさ、バグのはいる余地の少なさなど）と、PGM実行効率のメリデメを考えて判断しようとしていますが、なかなか答えがでませんね。

話がそれてしまいましたが、コメントありがとうございました。
やはり、オブジェクト参照は各自が回復させることを考えて、ライブラリにはないのでしょうね。
個人的に、ライブラリ側で対応することを希望する人が多いかと思っていたので、そのようなライブラリがないことに動揺しましたが、実行速度を求める人の方が多いのかなと、今では納得しています。

[dekaaki]

>DictionaryなどでCharacterクラスの外に関連付けの情報（上記ではName = "A"）を持つべきか、Characterクラスの中に、Name=Aのように持つべきか。

私自身のやり方としてはあまりプログラム起点として考えるのではなく、現実世界でのやり方をプログラム化するという考えでいつも考えてます。
例えば

私の出した例で考えると
・複数人の冒険者がいて冒険者に連絡(アクセス)を取りたい。
・複数の冒険者でパーティを組む
ということを現実世界の管理に当てはめると

■複数人の冒険者がいて冒険者に連絡を取りたい。

・ある冒険者を特定するためにはどうすればいいか
　→何らかの固有名詞（ユニークな情報）を使用＝Nameプロパティ

・冒険者へのアクセス
　→前述の固有名詞の一覧から冒険者を特定し連絡＝DictionaryのキーにNameプロパティの値、値には冒険者のインスタンス

■複数の冒険者でパーティを組む

前述の冒険者を特定するための情報(Nameプロパティ)を使用してパーティ台帳に記帳
パーティ台帳を見れば冒険者へのアクセスは可能
　→パーティ台帳に記帳＝保存時にNameプロパティを保存

といった感じでしょうか

[dekaaki]

そのうえで

>DictionaryなどでCharacterクラスの外に関連付けの情報（上記ではName = "A"）を持つべきか、Characterクラスの中に、Name=Aのように持つべきか。

に対する私の回答としては

冒険者の一覧の管理は必要と考え、冒険者の一覧から特定の冒険者にアクセスする機能があれば便利
　→Dictionaryを使用
　　例えばある友人に電話で連絡したいとき、電話帳に1000人登録されていれば名前で検索しますよね

特定条件下の冒険者一覧を抽出
　→DictionaryのValuesプロパティから条件に一致する冒険者を抽出
　　例えば電話帳に1000人登録されていて同級生を抽出するような場合は面倒でも電話帳に登録されている人を全て調べる
　　ただ上記の抽出がたびたび行われるのであれば毎回調べるのは面倒なので県別の一覧を作成

となり、Dictionaryでの管理は必要と考えます。
なんか長文になってしまいすみません^_^;

Answer 2

• シリアライザ・デシリアライザのカスタマイズが可能ならカスタム処理を書く
• 別のシリアライザにする（バイナリでもいいならMessagePack for C#とか）

JSON形式に拘りがあるかどうかという点が気になります。

Comments

[m3m3]

回答ありがとうございます。
JSON形式への拘りはないため、バイナリでも構いません。
しかし、JSON/バイナリで、挙動に違いが出るのでしょうか？
どちらもオブジェクト参照関係の保存、復活は出来ないもので、実行速度と確認のしやすさに違いがあるだけかと思っていました。
それとも、形式というよりは、シリアライザ(の実装)によるのでしょうか？

もう1つ書いていただいたシリアライザのカスタムはできるため、そちらも検討してみます。
(どれとどれが参照関係にあるのか、情報を保持して関係を復活させる)

ps.MessagePackは初めて知りましたが、速度だけみてもかなり魅力的ですね.

[退会済みユーザー]

よく質問を見返してみましたが、問題の本質を少し勘違いしていたかもしれません。参照関係は対策案１のようにIDを割り振って、自力で戻す必要があるかもしれません。

[m3m3]

コメントありがとうございます。
あれから引き続き調べたのですが、オブジェクト参照までカバーしてくれるライブラリが見つからず、またunity公式にもネスト構造をシリアライズしないことを推奨とありました。
使いやすさと実行速度のトレードオフでは使いやすさを取りたかったのですが、実装が困難・推奨されていないことから、案1の方向性で進めたいと思います。

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

Answer 3

一案ですが、
他クラスのオブジェクトともに、インデックスも持たせるようにすれば。
デシリアライズ時に、インデックスからオブジェクト参照を回復させればいい。

Comments

[m3m3]

回答ありがとうございます。
間接的に参照するのではなく、参照関係を回復する点で、案1に比べて直感的なプログラムを作れそうです。