VContainer-registering/register-monobehaviour | 注册——注册 MonoBehaviour

合集 - VContainer 中文文档(33)

1.VContainer 介绍02-172.VContainer-about/what-is-vcontainer | 概述——VContainer 是什么？02-173.VContainer-about/what-is-di | 概述——DI 是什么？02-174.VContainer-getting-started/installation | 入门——安装02-175.VContainer-getting-started/hello-world | 入门——Hello World02-176.VContainer-resolving/constructor-injection | 解析——构造函数注入02-177.VContainer-resolving/method-injection | 解析——方法注入02-178.VContainer-resolving/property-field-injection | 解析——属性/字段注入02-179.VContainer-resolving/gameobject-injection | 解析——注入到 MonoBehaviours 中02-1710.VContainer-resolving/container-api | 解析——容器 API02-1711.VContainer-registering/register-type | 注册——注册纯 C# 类型02-1712.VContainer-registering/register-using-delegate | 注册——注册使用委托02-1713.VContainer-registering/register-factory | 注册——注册工厂02-17

14.VContainer-registering/register-monobehaviour | 注册——注册 MonoBehaviour02-17

15.VContainer-registering/register-scriptable-object | 注册——注册 ScriptableObject02-1716.VContainer-registering/register-collection | 注册——注册集合02-1717.VContainer-registering/register-callbacks | 注册——注册回调02-1718.VContainer-integrations/entrypoint | 集成——纯 C# 入口点02-1719.VContainer-integrations/unitask | 集成——Unitask02-1820.VContainer-integrations/unirx | 集成——UniRx02-1821.VContainer-integrations/messagepipe | 集成——MessagePipe02-1822.VContainer-integrations/ecs | 集成——ECS (beta)02-1823.VContainer-scoping/lifetime-overview | 作用域——生命周期管理总览02-1824.VContainer-scoping/generate-child-via-scene | 作用域——通过场景或 prefab 生成子作用域02-1825.VContainer-scoping/generate-child-with-code-first | 作用域——通过代码优先生成子作用域02-1826.VContainer-scoping/project-root-lifetimescope | 作用域——项目根作用域 LifetimeScope02-1827.VContainer-diagnostics/diagnostics-window | 诊断——VContainer 诊断窗口02-1828.VContainer-optimization/source-generator | 优化——源码生成器02-1829.**VContainer-optimization/async-container-build | 优化——异步容器构建02-1830.VContainer-optimization/parallel-container-build | 优化——并行容器构建02-1831.VContainer-optimization/codegen | 优化——预生成 IL 代码（已弃用）02-1832.VContainer-comparing/comparing-to-zenject | 对比 Zenject02-1833.MessagePipe 中文文档02-20

收起

通过 LifetimeScope 的 [SerializeField] 注册

[SerializeField]
YourBehaviour yourBehaviour;

// ...

builder.RegisterComponent(yourBehaviour);

:::note
RegisterComponent 和 RegisterInstance 类似，唯一区别是：通过 RegisterComponent 注册的 MonoBehaviour 即使未被显式解析，也会自动注入依赖。
:::

从场景中注册（带 LifetimeScope）

builder.RegisterComponentInHierarchy<YourBehaviour>();

:::note
RegisterComponentInHierarchy 的生命周期固定为 Scoped，因为它的生命周期与场景一致。
:::

注册 prefab 预制体组件（解析时动态生成）

[SerializeField]
YourBehaviour prefab;

// ...

builder.RegisterComponentInNewPrefab(prefab, Lifetime.Scoped);

注册到新 GameObject 的组件（解析时创建）

builder.RegisterComponentOnNewGameObject<YourBehaviour>(Lifetime.Scoped, "NewGameObjectName");

以接口形式注册组件

builder.RegisterComponentInHierarchy<YourBehaviour>()
    .AsImplementedInterfaces();

注册到指定父级 Transform

// 在指定父级下创建新 GameObject
builder.RegisterComponentOnNewGameObject<YourBehaviour>(Lifetime.Scoped)
    .UnderTransform(parent);

// 在指定父级下实例化预制体
builder.RegisterComponentInNewPrefab(prefab, Lifetime.Scoped)
    .UnderTransform(parent);

// 在指定父级下查找现有组件
builder.RegisterComponentInHierarchy<YourBehaviour>()
    .UnderTransform(parent);

或运行时动态获取父级：

builder.RegisterComponentOnNewGameObject<YourBehaviour>(Lifetime.Scoped)
    .UnderTransform(() => {
        // ...
        return parent;
    });

注册为 DontDestroyOnLoad

RegsiterComponent* 方法链可以设置为 DontDestroyOnLoad：

// 新创建的 GameObject 不随场景销毁
builder.RegisterComponentOnNewGameObject<YourBehaviour>(Lifetime.Scoped)
    .DontDestroyOnLoad();

// 实例化的预制体对象不随场景销毁
builder.RegisterComponentInNewPrefab(prefab, Lifetime.Scoped)
    .DontDestroyOnLoad();

批量注册 MonoBehaviour

builder.UseComponents(components =>
{
    components.AddInstance(yourBehaviour);
    components.AddInHierarchy<YourBehaviour>();
    components.AddInNewPrefab(prefab, Lifetime.Scoped);
    components.AddOnNewGameObject<YourBehaviour>(Lifetime.Scoped, "name");
});

等价于逐条注册：

builder.RegisterComponent(yourBehaviour);
builder.RegisterComponentInHierarchy<YourBehaviour>();
builder.RegisterComponentInNewPrefab(prefab, Lifetime.Scoped);
builder.RegisterComponentOnNewGameObject<YourBehaviour>(Lifetime.Scoped, "name");

指定父级批量注册：

builder.UseComponents(parentTransform, components =>
{
    // 在 `parentTransform` 下查找 GetComponentInChildren
    components.AddInHierarchy<YourBehaviour>();

    // 在 `parentTransform` 下实例化
    components.AddInNewPrefab(prefab, Lifetime.Scoped);
    components.AddOnNewGameObject<YourBehaviour>(Lifetime.Scoped, "name");
})

等价于：

builder.RegisterComponentInHierarchy<YourBehaviour>()
    .UnderTransform(parentTransform);

builder.RegisterComponentInNewPrefab(prefab, Lifetime.Scoped)
    .UnderTransform(parentTransform);
builder.RegisterComponentOnNewGameObject<YourBehaviour>(Lifetime.Scoped, "name")
    .UnderTransform(parentTransform);