【Unity】サービスロケーターを使ってみる

はじめに

今回はServiceLocatorパターンというよくDependency Injectionパターンの前座として紹介されるデザインパターンを取り上げたいと思います。

f:id:hanaaaaaachiru:20201107004804p:plain

はじめに
実装
使い方
テストをやる
サービスロケーターの良し悪し
さいごに

実装

サービスロケーターの実装の仕方は無数にありますが、私が好みかつシンプルなのはこんな感じ。

using System;
using System.Collections.Generic;

public static class ServiceLocator
{
    private static readonly Dictionary<Type, object> _container;

    static ServiceLocator()
        => _container = new Dictionary<Type, object>();

    /// <summary>
    /// インスタンスを取得する
    /// </summary>
    public static T Resolve<T>()
        => (T)_container[typeof(T)];

    /// <summary>
    /// インスタンスを登録する
    /// </summary>
    public static void Register<T>(T instance)
        => _container[typeof(T)] = instance;

    /// <summary>
    /// インスタンスを登録解除する
    /// </summary>
    public static void UnRegister<T>(T instance)
    {
        if (Equals(_container[typeof(T)], instance)) _container.Remove(typeof(T));
    }

    /// <summary>
    /// 登録しているインスタンスを削除する
    /// </summary>
    public static void Clear<T>()
        => _container.Remove(typeof(T));
}

またスレッドセーフにしたいなら以下のように変更することも考えられるでしょう。

private static readonly ConcurrentDictionary<Type, object> _container;

static ServiceLocator()
    => _container = new ConcurrentDictionary<Type, object>();

使い方

インスタンスを登録するのはこんな感じ。

public static class Initializer
{
    /// <summary>
    /// Awakeより前に呼ばれる
    /// </summary>
    [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)]
    private static void Init()
    {
        ServiceLocator.Register<ISomeSystem>(new SomeSystem());
    }
}

public interface ISomeSystem
{
    void Execute();
}

public class SomeSystem : ISomeSystem
{
    public void Execute()
    {
        Debug.Log("実行されたよ");
    }
}

基本的にInterfaceもしくはabstract classを通してインスタンスを登録してください。(疎結合，テストを行うため)

次に利用する側はこちら。

public class Client
{
    public void Execute()
    {
        var system = ServiceLocator.Resolve<ISomeSystem>();

        system.Execute();
    }
}

一応言っておくとSomeSystem・ClientのExecuteという名前に特に意味はないです。

Client -> ISomeSystemというclientがISomeSystemを利用している意味合いを込めてます。

テストをやる

モックを作成してテストを行ってみましょう。

public class SomeSystemMock : ISomeSystem
{
    public void Execute()
    {
        Debug.Log("これはテストだよ");
    }
}

UnityにはTest Runnnerというテストをする機能がありますので、そちらを利用してみます。

using NUnit.Framework;

namespace Tests
{
    public class ClientTest
    {
        [OneTimeSetUp]
        public void OneTimeSetup()
        {
            ServiceLocator.Register<ISomeSystem>(new SomeSystemMock());
        }

        [Test]
        public void ClientMockTest()
        {
            var client = new Client();

            client.Execute();

            Assert.Pass();
        }
    }
}