シングルトンパターンを使った GameManager クラスのリファクタリング

2024年9月5日

シングルトンパターンは、あるクラスに対してインスタンスが1つしか存在しないことを保証し、そのインスタンスに対してグローバルアクセスを提供します。ゲームのスコア管理や状態の保持に頻繁に利用されるパターンです。この資料では、スレッドセーフかつ効率的なシングルトンパターンのリファクタリングを説明します。

1. 1. シングルトンパターンの基本
2. 2. 初期の GameManager クラス
- 2.1. 問題点
3. 3. リファクタリング後の GameManager クラス
- 3.1. リファクタリング後のコード
- 3.2. 変更点の詳細
4. 4. スレッドセーフなシングルトンのメリット
5. 5. GameManager クラスの使い方
6. 6. まとめ

1. シングルトンパターンの基本

シングルトンパターンは次の2つの特徴を持っています。

1つのインスタンス: クラスのインスタンスが1つしか存在しないことを保証。
グローバルアクセス: どこからでもそのインスタンスにアクセス可能。

2. 初期の `GameManager` クラス

以下は、リファクタリング前の GameManager クラスです。このクラスはシングルトンパターンを使用しており、ハイスコア（HiScore）を管理します。

public class GameManager
{
    private static GameManager _instance;

    public int HiScore { get; set; }

    public static GameManager Instance
    {
        get
        {
            if (_instance == null)
            {
                 _instance = new GameManager();
            }

            return _instance;
        }
    }
}

問題点

スレッドセーフではない: マルチスレッド環境で同時に Instance にアクセスすると、複数のインスタンスが生成される可能性があります。
複雑なロジック: if (_instance == null) という条件を毎回確認する必要があり、コードがやや冗長。

3. リファクタリング後の `GameManager` クラス

次に、シングルトンパターンをリファクタリングしてスレッドセーフで簡潔な形にします。

リファクタリング後のコード

public class GameManager
{
    private static readonly GameManager _instance = new GameManager();

    public int HiScore { get; set; }

    // コンストラクタを private にすることで外部からのインスタンス化を防ぐ
    private GameManager() { }

    // グローバルにアクセス可能な唯一のインスタンスを提供
    public static GameManager Instance => _instance;
}

変更点の詳細

static readonly の使用: static readonly を用いて GameManager のインスタンスを一度だけ生成し、スレッドセーフな実装にしています。
コンストラクタの非公開化: private コンストラクタを使うことで、外部からのインスタンス化を防いでいます。これにより、クラス内でのみインスタンスが生成されるようになります。
プロパティを簡潔に: Instance プロパティでは、インスタンスを返すだけのシンプルな構造になりました。冗長な if (_instance == null) チェックが不要になりました。

4. スレッドセーフなシングルトンのメリット

リファクタリングによって次の利点が得られます。

スレッドセーフ: マルチスレッド環境で問題なく使用可能です。
パフォーマンスの向上: インスタンス生成が1度だけ行われ、その後のアクセスは高速です。
コードの簡潔化: 不必要なチェックが削除され、クリーンで読みやすいコードになっています。

5. `GameManager` クラスの使い方

シングルトンパターンを利用した GameManager クラスの使い方は非常にシンプルです。どのクラスからでも GameManager.Instance を使用して、唯一のインスタンスにアクセスできます。

例: ハイスコアを管理する

次のコードは、GameManager クラスを使用して、ハイスコアの設定と表示を行う例です。

using System;

class Program
{
    static void Main(string[] args)
    {
        // GameManagerのインスタンスにアクセスしてハイスコアを設定
        GameManager.Instance.HiScore = 100;

        // ハイスコアを表示
        Console.WriteLine($"現在のハイスコア: {GameManager.Instance.HiScore}");

        // ハイスコアを更新
        GameManager.Instance.HiScore = 200;

        // 更新後のハイスコアを表示
        Console.WriteLine($"更新後のハイスコア: {GameManager.Instance.HiScore}");
        }
    }
}