PlayFab TitleData を利用した汎用マスターテーブル設計と実践例

はじめに

　ゲーム開発をしていると、キャラクターデータ、アイテムデータ、スキルデータなど、膨大な「マスターデータ」を「テーブル」として扱う必要があります。
Unity ではスクリプタブルオブジェクトを利用したテーブル管理の方法があります。

　こちらの記事では「スプレッドシート → Json → PlayFab TitleData → ゲーム内テーブル」という一連のデータフローを、ジェネリック型とシングルトンパターンを使ってシンプルに管理する方法と活用事例を紹介します。

設計の全体像

　今回の設計では、マスターデータ管理の中核となるクラスとして MasterTableBase クラスと TitleDataManager クラスを用意します。

　MasterTableBase クラスは MasterTableBase<T, U> としてジェネリック型で定義を行い、テーブル用クラスの親クラスとして利用する目的で作成します。
各マスターデータのテーブル用クラスは MasterTableBase<T, U> を継承したクラスとなり、こちらでマスターデータをリストとして保持することでテーブルとしての機能を持ちます。

　TitleDataManager クラスは、PlayFab から取得した TitleData を各テーブルに振り分ける役割を担います。
そして各テーブルをインスペクターで可視化する目的で作成します。

　インスペクターでの可視化も目的になっているため、ヒエラルキー上のゲームオブジェクトの構造は下記のような形になります。

　オブジェクトの名称については、～ Master、～ MasterTable のいずれでも問題ないです。
ここでは例として分けて記載していますが、ご自分のプロジェクトに応じて、いずれかに名称を統一して利用するとよいでしょう。

＜ヒエラルキー構造例＞

TitleDataManager (GameObject)
　├─ ActiveSkillMasterTable (GameObject)
　├─ CharaMasterTable (GameObject)
　├─ ItemMasterTable (GameObject)
　└─ ...（他のテーブルもここに追加）

サンプル画像(こちらではサンプルのため、名称を両方で用意しています)

設計のメリット

　今回の設計上のメリットを順番に提示します。

１．コードの再利用性が高い(共通化)

　ジェネリック型のクラス MasterTableBase<T, U> を使うことで、どのマスターデータも同じ仕組みで、異なるマスターテーブルを１行～数行で実装できます。

　MasterTableBase クラスには、指定した ID で検索を行うメソッドなどが実装されているので、わざわざ同じようなメソッドを複数のクラスに記載する必要がありません。
そのため、そのマスターテーブルで利用したいメソッドのみを追加することで実装が済みます。

２．データアクセスがシンプル。どこからでも参照可能

　シングルトン化されているため CharaMasterTable.instance.GetData(id) のように、マスターテーブル用のクラスを指定し、共通のメソッドで簡単にアクセスできます。
慣れてきたら DI コンテナ化も視野に入れてみてください。

３．インスペクターでマスターデータを確認できる

　インスペクターより各マスターデータを確認できるため、動作確認、データの不整合、不具合の調査が容易になります。

４．新しいマスターデータを追加しやすい(拡張性が高い)

　新しいマスターデータを追加するときは、マスターデータの構造を持つクラス、テーブル用の子クラス(MasterTableBase を継承)の２つのクラスを用意し、
あとは TitleDataManager ゲームオブジェクトの子オブジェクトを 1 つ追加するだけで対応可能です。

５．PlayFab / 外部サーバーとの親和性が高い

　Playfab であれば、TitleData に Json ファイルの内容をそのまま配置可能ですので、マスターデータの追加や修正が容易にできます。

　以上のようなメリットがあげられます。

実装手順

１．スプレッドシートでマスターデータを作成し、Json 形式でファイル出力する

　まずは Google スプレッドシートや Excel でデータを作成します。
列を変数名、行をデータレコードとして入力してください。

参考画像

　１つのシートにつき、１つの種類のマスターデータになります(スプレッドシートは１つです)。
例えば、敵のマスターデータ、スキルのマスターデータの２つを作成したいのであれば、１つのスプレッドシート内に、２つのシートに分けて作成します。

参考画像

　その後、各シートを Json 形式のファイルとして出力してください。
PlayFab の TitleData には Json 形式で登録する必要があるためです。

　スプレッドシートを利用している場合には、下記の記事を参考していただくと Json ファイルを書き出すことが可能です。

　　=>　スプレッドシートの内容を Json 形式で書き出す(配列対応)

２．PlayFab の TitleData に Json データを登録

　スプレッドシートなどの各マスターデータを Json ファイルに変換したら、PlayFab の TitleData に登録します。

　PlayFab の GameManager 画面からコンテンツ → タイトルデータを選択し、新しいタイトルデータを作成します。
Key にはマスターデータの名称(SkillMaster や CharaMasterData など)と登録し、Value には前回の手順で Json 形式で書き出しているファイルの内容をそのまま貼り付けます。
シートの名称と同じに設定しておくとよいでしょう。

登録例

SkillMaster → [{ "id": 1, "name": "Fire", ... }, ...]

CharaMaster → [ ... ]

参考画像

３．MasterTableBase クラスを作成

　共通化された基底クラスを作成します。
クラス内には List<T> を用意して、マスターデータをテーブルとして管理できるようにします。

　Set(), GetData(), TryGetData() など汎用的なメソッドを用意しておくことで、共通処理の実装を簡略化します。

MasterTableBase.cs

using UnityEngine;
using System.Collections.Generic;
using System.Linq;

/// <summary>
/// 各マスターに実装する
/// </summary>
public interface IMasterData {
    int Id { get; }
}

/// <summary>
/// アイコンID を利用したい各マスターに実装する
/// </summary>
public interface IHasIcon {
    string IconId { get; }
}


/// <summary>
/// IMasterData インターフェースを実装しているマスターデータをテーブル化する抽象クラス
/// </summary>
/// <typeparam name="T"></typeparam>
public abstract class MasterTableBase<T, U> : AbstractSingleton<U> where T : IMasterData where U : Component {

    [SerializeField] protected List<T> list;
    public List<T> List => list; // Get専用プロパティ

    protected override void Awake() {
        if (instance == null) {
            instance = this as U;
        } else {
            Destroy(gameObject);
        }
    }

    /// <summary>
    /// PlayFab の TitleData をキャッシュする
    /// </summary>
    /// <param name="data"></param>
    public void Set(IEnumerable<T> data) {
        if (data == null) {
            Debug.LogWarning($"{typeof(T).Name} のデータが null です");
            return;
        }
        list = new List<T>(data); // List にデータをセット
    }

    /// <summary>
    /// 指定した ID のマスターデータ取得
    /// </summary>
    /// <param name="id"></param>
    /// <returns></returns>
    public T GetData(int id) {
        return list.FirstOrDefault(masterData => masterData.Id == id);
    }

    /// <summary>
    /// 指定した ID のマスターデータがあるかチェック
    /// </summary>
    /// <param name="id"></param>
    /// <param name="data"></param>
    /// <returns></returns>
    public bool TryGetData(int id, out T data) {
        data = list.FirstOrDefault(masterData => masterData.Id == id);
        return data != null;
    }
}

４．各マスターデータクラス、テーブルクラスを作成

　
　スプレッドシートで作成したマスターデータを取り込むための、マスターデータ用クラスを作成します。
スプレッドシートと同じプロパティ名を public の変数として用意してください。

　サンプルです。

＜マスターデータ用クラス＞

[System.Serializable]
public class ActiveSkillMaster : IMasterData {
    public int Id;
    public string effect;
    public int priority;
    // 追加のフィールド...
}

　続いて、基底クラス(MasterTableBase)を継承して、先ほど作成したマスターデータをテーブルとして管理するためのクラスを用意していきます。
１つのマスターデータのテーブルにつき、基底クラスを継承した１つの子クラスを作成してください。

　新しいマスターデータをテーブルとして追加したい場合には、クラスを 1 行で定義できます。
特に新しい変数やメソッドの登録も不要です。そのテーブルに必要な情報だけを追記してください。

＜テーブル用子クラス＞

public class ActiveSkillMasterTable : MasterTableBase<ActiveSkillMaster, ActiveSkillMasterTable> {}

５．TitleDataManager クラスを作成して、PlayFab の TitleData から一括ロード

　PlayFab にログインし、LoginResult で取得した TitleData より、マスターデータをまとめてキャッシュします。
PlayFab へのログイン方法については割愛します。記事がたくさんありますので、ご自分の環境に合わせて、それらを参考にして実装してください。
(async/await で非同期処理がかけるので、PlayFab C# SDK を利用した実装がおすすめです。)

　各テーブルクラスにデータを渡して Set() メソッドを実行することでテーブルとして取り込みます。

　ここでは JsonHelper クラスと AbstractSingleton クラスを利用します。

　こちらを参考にして作成してから、こちらの処理を実装してください。

JsonHelper クラス
　　→　ローカライズ対応の実装例②

AbstractSingleton クラス
　　→　アイテム獲得時のログ表示機能の実装例③

　　サンプルです。

using System.Collections.Generic;

public class TitleDataManager : AbstractSingleton<TitleDataManager> {
    public ActiveSkillMasterTable activeSkillMasterTable;
    public CharaMasterTable charaMasterTable;

    // 他のマスターテーブルもここに追加


    /// <summary>
    /// PlayFab から取得したデータ群をローカル(端末)のテーブルにキャッシュ
    /// </summary>
    /// <param name="loginResult"></param>
    /// <returns></returns>
    public void CacheTilteData(Dictionary<string, string> titleData) {

        activeSkillMasterTable.Set(JsonHelper.ListFromJson<ActiveSkillMaster>(titleData["ActiveSkillMaster"]));
        charaMasterTable.Set(JsonHelper.ListFromJson<CharaMaster>(titleData["CharaMaster"]));

        // 他のマスターテーブルも同様に追加

    }
}

６．シーンに配置して確認

　ヒエラルキーにて Create Empty を行い新しいゲームオブジェクトを作成し、名前を TitleDataManager に変更します。

　TitleDataManager ゲームオブジェクトの子オブジェクトとして各テーブルを追加していきます。
なお子オブジェクトは、テーブル名をアルファベット順に並べて置くと、指定のマスターテーブルを見つけやすいです。

　各マスターデータの List(データの中身)は 0 になっています。

　ゲーム起動後、インスペクターから PlayFab の TitleData より各マスターデータがロードされていることを確認してください。

活用事例

１．IMasterData を活用して汎用的にデータ検索

　MasterTableBase は T : IMasterData 制約を持っているので、下記のようなメソッドを用意することにより、ID ベースの検索処理を汎用化できます。
メソッドを記載するクラスは TitleDataManager などのシングルトンクラス、ないしはユーティリティ用の static クラスがいいでしょう。

　この場合、AbstractSingleton クラスが public の instance 変数か参照可能なプロパティを保持している前提です。

public T FindById<T, U>(int id) where T : IMasterData where U : MasterTableBase<T, U> {   // static クラスの場合には static を追加する
    return AbstractSingleton<U>.instance.GetData(id);
}

var chara = FindById<CharaMaster, CharaMasterTable>(1001);
Debug.Log($"キャラ名: {chara.name}");

　どのマスターテーブルでも、同じ呼び出し方で ID 検索が可能になります。

２．IHasIcon を活用してアイコン取得を汎用化

　複数のマスターデータが IHasIcon を実装していれば、アイコン取得処理をひとつにまとめられます。

public Sprite GetIcon<T>(T data) where T : IHasIcon {
    string iconId = data.IconId;
    return IconLoader.Load(iconId); // 任意のアイコン読み込み処理
}

var item = ItemMasterTable.instance.GetData(2001);
var icon = GetIcon(item);

　もし IHasIcon を持たないデータが来ても安全にハンドリング可能です。

public Sprite TryGetIcon(object data) {
    if (data is IHasIcon iconHolder) {
        return IconLoader.Load(iconHolder.IconId);
    }
    Debug.Log($"{data.GetType().Name} はアイコンを持ちません");
    return null;
}

３．is キーワードでクラス別処理を自動化

　マスターデータの種類によって処理を切り替えたい場合、is を使った分岐が便利です。

public void PrintMasterInfo(IMasterData data) {
    if (data is ActiveSkillMaster skill) {
        Debug.Log($"スキル名: {skill.Id}, 効果: {skill.effect}");
    } 
    else if (data is CharaMaster chara) {
        Debug.Log($"キャラ名: {chara.name}, レアリティ: {chara.rarity}");
    }
    else {
        Debug.Log($"汎用マスターデータ: {data.Id}");
    }
}

　この仕組みを使えば、マスターデータを一括でループして種類ごとに処理することも可能です。

４．すべてのテーブルを一括処理

　IMasterTable という空のインターフェースを作って、すべてのテーブルに実装させると、ヒエラルキーの子オブジェクトにアタッチされたテーブルを一括で処理できます。

using System.Linq;

/// <summary>
/// 各マスターテーブルクラスに実装する
/// </summary>
public interface IMasterTable {
    // 中身は空でよい
}


public void LogAllMasterCounts() {
    var tables = GetComponentsInChildren<Component>()
        .Where(c => c is IMasterTable) // マーカー用インターフェースを付与しておく
        .Cast<IMasterTable>();

    foreach (var table in tables) {
        Debug.Log($"{table.GetType().Name}: {table.Count} 件");
    }
}

　これにより、新しいマスターデータが増えても、ほぼノーコストで既存の仕組みに乗せられるようになります。

まとめ

　この設計(MasterTableBase クラス)により、共通化されたマスターデータ管理が可能になります。
コード量を大幅削減できますので、マスターデータの追加・変更が容易になり、保守コストも削減されます。

　PlayFab よりマスターデータをテーブルとして TitleDataManager で一括ロードできるのでメンテナンスも楽になります。
インスペクターでデータを確認可能なので、デバッグ効率も向上します。

　このパターンを導入すれば、新しいマスターデータ追加も数分で完了できますので、
運用コストを抑えながらデータを拡張できますし、今後、データ更新や差分配信機能を追加する際にも、同じ構造を流用できます。

　以上になります。

このページを編集するこのページを元に新規ページを作成

印刷する

コメント（0）

PlayFab TitleData を利用した汎用マスターテーブル設計と実践例 - i-school 先頭へ

コメントをかく

名前	ユーザIDを使用しないで書き込む	ユーザーIDを使う	ログインする
画像コード	画像に記載されている文字を下のフォームに入力してください。
備考	「http://」を含む投稿は禁止されています。
本文
利用規約をご確認のうえご記入下さい

i-school