【问题标题】:Unity C# creating observable variables with delegatesUnity C# 使用委托创建可观察变量
【发布时间】:2022-01-23 10:34:57
【问题描述】:

我想做什么:

一个 ScriptableObject 类,用于保存单个变量,可以在观察者模式中订阅该变量,以便在值更改时接收通知。

我的目的是让 UI 显示之类的东西在它们显示发生变化时更新,而不必在每次更改时手动触发事件。

此外,我希望我的班级具有三个特点:

  1. 使用 try/catch 来真正解耦,而不是让所有的侦听器都失败
  2. 可以选择记录内容以进行调试
  3. 在检查器中显示当前活跃的观察者列表

我认为这是 Delegates 的几行代码,但事实证明,这根本行不通。

我的第一次天真的迭代是这样的:

using System;
using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.Events;


[CreateAssetMenu(fileName = "New Observable Float", menuName = "Observables/Float")]
public class ObservableFloat : ScriptableObject {

    public event Action<float> get;

    [SerializeField] private float m_Value;
    public float Value {
        get {
            return m_Value;
        }
        set {
            m_Value = value;
            get?.Invoke(value);
        }
    }
}

我的第二次迭代在功能上有效,但没有向我显示检查器中的观察者列表,是这样的:

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.Events;


[CreateAssetMenu(fileName = "New Observable Float", menuName = "Observables/Float")]
public class ObservableFloat : ScriptableObject {

    [SerializeField] List<UnityAction<float>> listeners = new List<UnityAction<float>>();

    [SerializeField] private float m_Value;
    public float Value {
        get {
            return m_Value;
        }
        set {
            m_Value = value;
            foreach (UnityAction<float> action in listeners) {
                action.Invoke(value);
            }
        }
    }

    public void AddListener(UnityAction<float> func) => listeners.Add(func);
    public void RemoveListener(UnityAction<float> func) => listeners.Remove(func);
}

我的第三次迭代,将 UnityAction 替换为 UnityEvents,乍一看似乎可以正常工作(列表显示在 Inspector 中),但它从不更新列表,并且始终显示为空,即使在功能上它再次起作用:

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.Events;
using Sirenix.OdinInspector;


[CreateAssetMenu(fileName = "New Observable Float", menuName = "Observables/Float")]
public class ObservableFloat : ScriptableObject {

    public UnityEvent<float> listeners = new UnityEvent<float>();

    [SerializeField] private float m_Value;
    public float Value {
        get {
            return m_Value;
        }
        set {
            m_Value = value;
            listeners?.Invoke(value);
        }
    }
}

【问题讨论】:

  • 属性(setter 和 getter)是这样的,但为什么不这样呢?
  • @Confused 我不明白这个问题。有了属性,您就有了紧密耦合的组件。这是我想避免的。
  • 让 setter 存储订阅对象的列表或数组。比创建垃圾的委托更快、更轻且无限好。
  • @Confused 仍然不明白。也许您可以将其扩展为简短的答案?

标签: c# unity3d events delegates observable


【解决方案1】:

总的来说,我认为您正在寻找的是UnityEvent

[SerializeField] private UnityEvent<float> listeners;

public void AddListener(Action<float> action) => listeners.AddListener(action);

public void  RemoveListener(Action<float> action) => listeners.RemoveListener(action);

[SerializeField] private float m_Value;
public float Value {
    get {
        return m_Value;
    }
    set {
        m_Value = value;
        listeners?.Invoke(value);
    }
}

不幸的是,这些只会在 Inspector 中显示 persistent 听众。没有简单的内置方法也可以显示运行时回调,如果你想这样做,我想没有办法绕过 Reflection 和/或非常复杂的特殊 Inspector 实现。

你可以例如存储类似的东西

using System.Reflection;
using System.Linq;

...

[Serializable]
public class ListenerInfo
{
    public Action<float> action;
    public string MethodName;
    public string TypeName;
}

[SerializeField] private List<string> listenerInfos;

public void AddListener(Action<float> action)
{
    listeners.AddListener(action);

    var info = action.GetMethodInfo();
    listenerInfos.Add(new ListenerInfo { action = action, MethodName = info.Name, TypeName = info.DeclaringType.Name });
}

public void RemoveListener (Action<float> action)
{
    listeners.RemoveListener(action);

    var info = var info = action.GetMethodInfo();
    listenerInfos.RemoveAll(l => l.action == action);
}

另见例如Action delegate. How to get the instance that call the method

我想这可能是您在不深入研究 Unity 编辑器脚本甚至更多反思的情况下所能获得的最接近的结果 ^^

【讨论】:

  • 这很遗憾有同样的问题,即在脚本中添加的观察者没有出现在检查器中。我现在开始相信这是 UnityEvent 的一个限制,它根本没有获取非持久侦听器的方法。 :-(
  • 没关系吧?运行时添加的侦听器永远不会出现在 Inspector 中...
  • 但这是我想要的功能之一(上面列表中的#3)。在检查游戏功能、寻找错误等时。我希望在运行时检查所有侦听器是否设置正确等。
  • @Tom 这根本不可能。至少与可以单击对象等的持久侦听器的方式不同...您可以使用反射并存储例如类型和方法名称的字符串列表,但我想这是没有更复杂的自定义 Inspector 实现的最接近的结果
  • 谢谢。是的,我想我需要使用反射。
【解决方案2】:

我想出了一个可行的解决方案,虽然我不是很确定,所以我将它发布在 CodeReview - https://codereview.stackexchange.com/questions/272241/unity3d-observable-variable

这是代码(但请查看上面的链接以了解可能的修复/改进)。非常感谢@derHugo,他为我指明了正确的方向:

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.Events;
using UnityEditor;
using Sirenix.OdinInspector;


[CreateAssetMenu(fileName = "New Observable Float", menuName = "Observables/Float")]
public class ObservableFloat : ScriptableObject {

    [System.Serializable]
    public class Listener {
        [DisplayAsString, HideInInspector] public int ID;
        [DisplayAsString, HideLabel, HorizontalGroup] public string Observer;
        [DisplayAsString, HideLabel, HorizontalGroup] public string Method;
        [HideInInspector] public UnityAction<float> Callback;
        
        public Listener(UnityAction<float> cb) {
            ID = cb.GetHashCode();
            Observer = cb.Target.ToString();
            Method = cb.Method.ToString();
            Callback = cb;
        }
    }

    [Delayed]
    [OnValueChanged("NotifyListeners")]
    [SerializeField] private float m_Value;
    public float Value {
        get {
            return m_Value;
        }
        set {
            m_Value = value;
            NotifyListeners();
        }
    }

    [Tooltip("Log Invoke() calls")]
    [SerializeField] bool Trace;

    [Tooltip("Use try/catch around Invoke() calls so events continue to other listeners even if one fails")]
    [SerializeField] bool CatchExceptions;

    [ListDrawerSettings(DraggableItems = false, Expanded = true, ShowIndexLabels = false, ShowPaging = false, ShowItemCount = true)]
    [SerializeField] List<Listener> listeners = new List<Listener>();


    void Awake() {
        // clear out whenever we start - just in case some observer doesn't properly remove himself
        // maybe later I'll also add persistent listeners, but for now I don't see the use case
        listeners = new List<Listener>();
    }

    void NotifyListeners() {
        foreach (Listener listener in listeners) {
            if (Trace) {
                Debug.Log("invoking "+listener.Observer+" / "+listener.Method+ " / value = "+m_Value);
            }
            if (CatchExceptions) {
                try {
                    listener.Callback.Invoke(m_Value);
                } catch (System.Exception exception) {
                    Debug.LogException(exception, this);
                }
            } else {
                listener.Callback.Invoke(m_Value);              
            }
        }
    }

    public void AddListener(UnityAction<float> func) { listeners.Add(new Listener(func)); }
    public void RemoveListener(UnityAction<float> func) { listeners.RemoveAll(l => l.ID == func.GetHashCode()); }
}

这很有效,并为我提供了我想要的功能,但不确定它是否是一个很好的解决方案,所以我会留下这个问题以获得更好的答案。

【讨论】:

    猜你喜欢
    • 2023-04-02
    • 2010-11-17
    • 2010-11-04
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2020-05-02
    • 2020-04-02
    • 1970-01-01
    相关资源
    最近更新 更多