【Unity】VContainerのLifetimeScopeのParent機能使って見た # 1

はじめに

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

今回はVContainerのParent機能を使ったことや...制作中に悩んだことなどをこの記事に書きたいと思います！詳細な内容は、詳しい解説などは本記事を見るよりも、参考にしたリンクの記事を見ることをオススメします。

参考にしたリンク

この記事を作ったきっかけ

LifetimeScopeを作って配置している時に、ふとあることを考えました。他のLifetimeScopeに登録されている型とかインスタンスを取得したい時ってどうするんだろう...と考えました。

試してみる

試しに、LifetimeScopeを2つ作り片方に型を登録、もう片方に型を利用するインスタンスを登録しました。その後にAuto Inject Game Objectsに入れて実験をしました。ソースコードが4つあって長ったるいですが、大した内容は書いていません。

型として登録したクラス

using UnityEngine;

public class Test
{
    public void Call()
    {
        Debug.Log("Test !");
    }
}

型を登録するLifetimeScope

using VContainer;
using VContainer.Unity;

public class ParentLifetimeScope : LifetimeScope
{
    protected override void Configure(IContainerBuilder builder)
    {
        builder.Register<Test>(Lifetime.Singleton);
    }
}

型を利用するインスタンス

using UnityEngine;
using VContainer;

public class TestMonoBehaviour : MonoBehaviour
{
    [Inject]
    private Test _test;

    void Start()
    {
        _test.Call();
    }
}

インスタンスを登録するLifetimeScope

using VContainer;
using VContainer.Unity;

public class ChildLifetimeScope : LifetimeScope
{
    protected override void Configure(IContainerBuilder builder)
    {
        builder.RegisterComponentInHierarchy<TestMonoBehaviour>();
    }
}

GameObjectにLifetimeScopeとMonoBehaviourをアタッチして、ParentのAuto Inject Game ObjectsにTestMonoBehaviourを入れました。

そして実行すると、このような結果になります。

結果としては、Parentは問題なく依存関係を解決出来たけど、Childの方ではTestという型は登録されていないというエラーになっています。

正直、ChildのLifetimeScopeでの登録を止めればいいだけの話にはなりますが...

Parent機能を利用して解決

やること自体はとても簡単です。ChildLifetimeScopeのParentという項目をクリックして、ParentLifetimeScopeを選択します。

実行すると、エラーがなくメソッドが実行されていることが分かります。

Parentの親設定に関して、子は同じ親を指定することができます。この時に子が親を指定している状態で、親が他のLifetimeScopeを親にしているとエラーが出ます。また、親は子の内容を利用することはできません。

そして、このParent機能の面白いところは親から子、さらにその子に型とインスタンスを利用させることができます。

すっごい雑な図になるんですけど、図の状態だと親は指定されているだけで、何も利用できない。子Aは親と自身が登録した型やインスタンスを利用できる。そして、その下の階層の子B、Cは親と子Aの型やインスタンスが利用できます。

さっきのインスペクタの内容をこのように変更します。

・親
変更なし

・子1
変更なし

・子2 new
子1を親にして、親に登録してある型と、子が登録したインスタンスを利用するクラスを登録する。

public class ChildTest : IStartable
{
    private readonly Test _test;
    private readonly TestMonoBehaviour _testMonoBehaviour;

    public ChildTest(Test test, TestMonoBehaviour testMonoBehaviour)
    {
        _test = test;
        _testMonoBehaviour = testMonoBehaviour;
    }

    public void Start()
    {
        _test.Call();

        // こそっとLogを出す処理を追加しました
        _testMonoBehaviour.Call();
    }
}

実行結果としてはこうなります！子2で、親と子1の型、インスタンスを利用できています。おぉ～便利だ～～

まとめ

LifetimeScopeで親子関係を作ることができて、親の型やインスタンスを利用することができる。

親→子1→子2という親子関係を作ると、子2では親と子1の型やインスタンスを利用することができる。

そして、この親子関係を利用する場合Lifetime辺りが少し変わってくるらしいです。その部分は明日に続く！