【Unity】VContainerをざっくりと使ってみた

はじめに

この記事はHamster Output Advent Calendar 2024の4日目の記事です！

ここ最近、ゲーム開発でサービスロケーターを利用して1つの悩みがありました。
それは「インスタンスの登録や解除を毎回手動で行うのが面倒だ」という悩みでした。

そんな時、VContainerを利用している記事を見つけ、もしかしたらサービスロケーターの悩みを解決できるかも知れないと思い、使ってみた...というのが本記事の内容です。

参考にしたリンク

ダウンロードしたらエラーに遭遇した

公式サイトのmanifest.jsonにリンクを追加してダウロードを行いましたが、プロジェクトを起動したらエラーに遭遇しました。

遭遇したエラー

調べたところ、パソコンの環境変数のPathにgit.exeのパスを設定すると解決するエラーらしいです。下の記事を参考にしてエラーを直しました。

とりあえず使ってみる

VContainerを利用するにはLifetimeSpopeを継承したクラスが必要みたいなので、クラスを作成します。

using VContainer;
using VContainer.Unity;

public class TestLifetimeScope : LifetimeScope
{
    protected override void Configure(IContainerBuilder builder)
    {

    }
}

作成したTestLifetimeScopeを適当なGameObjectにアタッチします。

GameObjectにアタッチできるんだ...と思いクラスを覗いたらMonoBehaviourを継承していることが分かりました。後の処理は...良く分からないので飛ばします😓

public partial class LifetimeScope : MonoBehaviour, IDisposable

次にLifetimeScopeに登録するクラスを作ります。Testクラスはシーン上の適当なGameObjectにアタッチします。

using UnityEngine;

public class TestMonoBehaviour : MonoBehaviour
{
    private TestPureCSharp _testPureCSharp;

    private void Start()
    {
        _testPureCSharp.TestLog();
    }
}

public class TestPureCSharp
{
    public void TestLog()
    {
        Debug.Log("TestPureCSharp");
    }
}

作成したクラスをLifetimeScopeに登録します。ピュアC#とMonoBehaviourのクラスでは登録方法が少し違いますが、ひとまずそのまま進めていきます。引き数のLifetimeについては後ほど触れます。

using VContainer;
using VContainer.Unity;

public class TestLifetimeScope : LifetimeScope
{
    protected override void Configure(IContainerBuilder builder)
    {
        builder.Register<TestPureCSharp>(Lifetime.Singleton);
        builder.RegisterComponentInHierarchy<TestMonoBehaviour>();
    }
}

現状、TestMonoBehaviourクラスでTestPureCSharpのインスタンスを作成していないので、実行するとエラーが出ます。ここで、VContainerの登場です。

まず、TestMonoBehaviourクラスの_testPureCSharp変数にInject属性をつけます。

using UnityEngine;
using VContainer;

public class TestMonoBehaviour : MonoBehaviour
{
    // Injectをここに追加する
    [Inject]
    private TestPureCSharp _testPureCSharp;

    private void Start()
    {
        _testPureCSharp.TestLog();
    }
}

LifetimeScopeがアタッチされているGameObjectのインスペクターにはAuto Inject Game Objectsというリストがあります。ここに、先ほどInject属性をつけた変数を持っているTestMonoBehaviourを入れます。

リストの中に入れたら再生を行います。コンソールを確認するとエラーが出ずに、ログが出ていることが分かります。手動登録の手間が少ないので、この時点でサービスロケーターの登録よりも正直楽です。

一度動かすことができたので、先ほど出てきたLifetimeという部分について触れます。
Lifetimeはインスタンスの利用方法について指定をする引き数で3つの中から選ぶことができます。それぞれの違いをざっくりと書きます。

・Singleton

一度生成したインスタンスを使い回す。

・Transient

都度生成してインスタンスを渡す。

・Scoped

Singletonと少し似ていて、LifetimeScopeに既に作成したインスタンスがあればそれを使い回し、なければ新しく生成して使い回す。

かなり雑な説明にはなってしまいましたが、ざっくりと動かしてサービスロケーターのような手動登録の手間が少なく便利そうだということが分かりました。

まとめ

現時点では、～こうやって～こうすると登録出来て～使えますなどかなり省いた内容でしたが...正直サービスロケーターより使いやすいです。

ただ、インスタンス登録処理もかなりあったり、VContainerのインタフェースを利用して色々出来るなど...便利だと感じる反面、利用が難しそうだなと感じる部分もありましたので、アウトプットを通じてVContainerを使いこなせるようになりたいですね。