ObservableDictionary<TKey, TValue>¶

继承链: System.Object → ObservableDictionary<TKey, TValue>

实现接口: System.Collections.Generic.IReadOnlyDictionary<TKey, TValue>，System.Collections.Generic.IDictionary<TKey, TValue>，Runestone.AesirArchitecture.IReadOnlyObservableDictionary<TKey, TValue>，System.Collections.Generic.IEnumerable<KeyValuePair<TKey, TValue>>，System.Collections.IEnumerable，Runestone.AesirArchitecture.IObservableCollection<KeyValuePair<TKey, TValue>>，System.Collections.Generic.ICollection<KeyValuePair<TKey, TValue>>，System.Collections.Generic.IReadOnlyCollection<KeyValuePair<TKey, TValue>>，Runestone.AesirArchitecture.IObservableDictionary<TKey, TValue>

类型参数

• TKey — 键类型
• TValue — 值类型

声明¶

[DefaultMember]
[Serializable]
public sealed class ObservableDictionary<TKey, TValue> : System.Collections.Generic.IReadOnlyDictionary<TKey, TValue>, 
System.Collections.Generic.IDictionary<TKey, TValue>, 
Runestone.AesirArchitecture.IReadOnlyObservableDictionary<TKey, TValue>, 
System.Collections.Generic.IEnumerable<KeyValuePair<TKey, TValue>>, 
System.Collections.IEnumerable, 
Runestone.AesirArchitecture.IObservableCollection<KeyValuePair<TKey, TValue>>, 
System.Collections.Generic.ICollection<KeyValuePair<TKey, TValue>>, 
System.Collections.Generic.IReadOnlyCollection<KeyValuePair<TKey, TValue>>, 
Runestone.AesirArchitecture.IObservableDictionary<TKey, TValue>  

可观察字典实现。 Model 层持有可写实例，View 层通过 IReadOnlyObservableDictionary{TKey, TValue} 只读订阅。

备注

内部组合 Dictionary{TKey,TValue} 存储键值，变更通知经 MiniEvent{T} 分发——Invoke 路径零分配（直接多播调用）。注意：订阅路径（AddListener / 句柄创建）有与监听者数量成正比的委托分配， 勿在每帧订阅场景使用。 [SerializeField] 标记 dictionary 字段——Unity 原生不序列化 Dictionary{TKey, TValue} （该标记对 Unity 序列化无效果），安装 Odin Inspector 且宿主走 Odin 序列化（如 AesirMonoBehaviour 派生组件）时， 该字段可被 Odin 序列化管线接管，便于在 Inspector 中编辑初始键值。

变更通知为单一事件（AddListener），载荷为 CollectionChangedEventArgs{T} （T = KeyValuePair{TKey,TValue}）：写操作完成后才触发，监听者回调中读取到的集合已是变更后的状态； 索引器为不存在的键赋值触发 Add、为已有键赋新值触发 Replace（旧值见载荷 OldItem）、赋相同值不通知； Remove 不存在的键、Clear 空字典不通知。字典无索引概念，载荷索引固定 -1。

遍历性能：foreach 具体类型走结构体枚举器，零分配；通过 IReadOnlyObservableDictionary{TKey, TValue} / IEnumerable{T} 接口遍历会装箱一次枚举器（与 BCL Dictionary{TKey, TValue} 行为一致）。

构造方法¶

ObservableDictionary()¶

默认构造，创建空字典。

public ObservableDictionary<TKey, TValue>()

ObservableDictionary(IEnumerable<KeyValuePair>)¶

指定初始键值构造。初始键值不触发变更通知（语义同反序列化填充）。

public ObservableDictionary<TKey, TValue>(IEnumerable<KeyValuePair<TKey, TValue>> initialItems)

参数

ObservableDictionary(IEqualityComparer)¶

指定键比较器构造。

public ObservableDictionary<TKey, TValue>(IEqualityComparer<TKey> comparer)

参数

属性¶

Keys¶

所有键的集合。

public IEnumerable<TKey> Keys { get; }

Values¶

所有值的集合。

public IEnumerable<TValue> Values { get; }

Comparer¶

内部 Dictionary{TKey, TValue} 使用的键比较器。

public IEqualityComparer<TKey> Comparer { get; }

Item¶

读写指定键的值。 读取：键不存在时抛 KeyNotFoundException（fail-fast）。

写入：键不存在时添加并触发 Add；键已存在且新值不同时更新并触发 Replace（旧值见载荷 OldItem）；值相同不通知。

public TValue Item { get; set; }

IsReadOnly¶

固定返回 false，该集合可写。

public bool IsReadOnly { get; }

Count¶

键值对数量。

public int Count { get; }

方法¶

声明的方法

继承的方法

AddListener(Action<CollectionChangedEventArgs<KeyValuePair>>)¶

public AutoRemoveListenerHandle AddListener(Action<CollectionChangedEventArgs<KeyValuePair<TKey, TValue>>> callback)

参数

返回值

GetEnumerator()¶

返回遍历键值对的结构体枚举器，foreach 具体类型时零分配。

public ObservableDictionary<TKey, TValue>.Enumerator<TKey, TValue> GetEnumerator()

返回值

Contains(KeyValuePair)¶

判断是否包含指定键值对（键存在且值相等）。

public bool Contains(KeyValuePair<TKey, TValue> item)

参数

返回值

ContainsKey(TKey)¶

判断是否包含指定键。

public bool ContainsKey(TKey key)

参数

返回值

Remove(KeyValuePair)¶

移除与指定键值对匹配的项（键存在且值相等），成功时触发 Remove 通知。

备注

不复用 Remove(TKey)——其按键删除不校验值；此处先验证键值对完全匹配再移除，避免误删同键不同值。

public bool Remove(KeyValuePair<TKey, TValue> item)

参数

返回值

Remove(TKey)¶

移除指定键的键值对，成功时触发 Remove 通知（参数含被移除的键值对）。

备注

使用 Remove(TKey, out TValue) 在移除的同时取回旧值，单次哈希查找。

public bool Remove(TKey key)

参数

返回值

TryGetValue(TKey, ref TValue)¶

获取与指定键关联的值。

public bool TryGetValue(TKey key, out ref TValue value)

参数

返回值

Add(KeyValuePair)¶

添加键值对，触发 Add 通知。键已存在时抛 ArgumentException（fail-fast）。

public void Add(KeyValuePair<TKey, TValue> item)

参数

Add(TKey, TValue)¶

添加键值对，触发 Add 通知。键已存在时抛 ArgumentException（fail-fast）。

public void Add(TKey key, TValue value)

参数

Clear()¶

清空字典。字典非空时以 Reset 通知；已为空时不通知。

public void Clear()

ClearListeners()¶

清空所有变更监听。

备注

清除全部监听引用，防止因监听者未释放导致的内存泄漏。 与 Clear 不同——后者清空的是字典键值。

public void ClearListeners()

CopyTo(KeyValuePair[], int)¶

从指定数组索引开始复制键值对到目标数组。

public void CopyTo(KeyValuePair<TKey, TValue>[] array, int arrayIndex)

参数

RemoveListener(Action<CollectionChangedEventArgs<KeyValuePair>>)¶

public void RemoveListener(Action<CollectionChangedEventArgs<KeyValuePair<TKey, TValue>>> callback)

参数

Additional Notes¶

首个 ## Additional Notes 是增量生成文档标识符，请勿修改标题级别和内容！本文档由 Script Doc Generator 辅助生成。