不変のディクショナリを提供できるコア C# ライブラリに組み込まれているものはありますか?
Javaのラインに沿ったもの:
Collections.unmodifiableMap(myMap);
明確にするために、私はキー/値自体が変更されるのを止めようとしているのではなく、辞書の構造だけを止めようとしています。IDictionary のミューテーター メソッドのいずれかが呼び出された場合に、すばやく大きな音で失敗するものが必要です ( Add, Remove, Clear
)。
不変のディクショナリを提供できるコア C# ライブラリに組み込まれているものはありますか?
Javaのラインに沿ったもの:
Collections.unmodifiableMap(myMap);
明確にするために、私はキー/値自体が変更されるのを止めようとしているのではなく、辞書の構造だけを止めようとしています。IDictionary のミューテーター メソッドのいずれかが呼び出された場合に、すばやく大きな音で失敗するものが必要です ( Add, Remove, Clear
)。
いいえ、しかしラッパーはかなり簡単です:
public class ReadOnlyDictionary<TKey, TValue> : IDictionary<TKey, TValue>
{
IDictionary<TKey, TValue> _dict;
public ReadOnlyDictionary(IDictionary<TKey, TValue> backingDict)
{
_dict = backingDict;
}
public void Add(TKey key, TValue value)
{
throw new InvalidOperationException();
}
public bool ContainsKey(TKey key)
{
return _dict.ContainsKey(key);
}
public ICollection<TKey> Keys
{
get { return _dict.Keys; }
}
public bool Remove(TKey key)
{
throw new InvalidOperationException();
}
public bool TryGetValue(TKey key, out TValue value)
{
return _dict.TryGetValue(key, out value);
}
public ICollection<TValue> Values
{
get { return _dict.Values; }
}
public TValue this[TKey key]
{
get { return _dict[key]; }
set { throw new InvalidOperationException(); }
}
public void Add(KeyValuePair<TKey, TValue> item)
{
throw new InvalidOperationException();
}
public void Clear()
{
throw new InvalidOperationException();
}
public bool Contains(KeyValuePair<TKey, TValue> item)
{
return _dict.Contains(item);
}
public void CopyTo(KeyValuePair<TKey, TValue>[] array, int arrayIndex)
{
_dict.CopyTo(array, arrayIndex);
}
public int Count
{
get { return _dict.Count; }
}
public bool IsReadOnly
{
get { return true; }
}
public bool Remove(KeyValuePair<TKey, TValue> item)
{
throw new InvalidOperationException();
}
public IEnumerator<KeyValuePair<TKey, TValue>> GetEnumerator()
{
return _dict.GetEnumerator();
}
System.Collections.IEnumerator
System.Collections.IEnumerable.GetEnumerator()
{
return ((System.Collections.IEnumerable)_dict).GetEnumerator();
}
}
明らかに、値の変更を許可する場合は、上記の this[] セッターを変更できます。
私の知る限り、ありません。しかし、これらの記事からいくつかのコードをコピーする (そして多くのことを学ぶ) ことができるかもしれません。
.NET 4.5のリリースに伴い、新しいReadOnlyDictionaryクラスがあります。コンストラクターにを渡すだけでIDictionary
、不変の辞書が作成されます。
これは、読み取り専用辞書の作成を簡素化するために使用できる便利な拡張方法です。
オープンソースのPowerCollectionsライブラリには、クラスの静的ReadOnly()
メソッドを介してアクセスできる、読み取り専用のディクショナリ ラッパー (およびその他のほぼすべての読み取り専用ラッパー) が含まれています。Algorithms
dbkkの回答に加えて、最初に ReadOnlyDictionary を作成するときにオブジェクト初期化子を使用できるようにしたかったのです。次の変更を加えました。
private readonly int _finalCount;
/// <summary>
/// Takes a count of how many key-value pairs should be allowed.
/// Dictionary can be modified to add up to that many pairs, but no
/// pair can be modified or removed after it is added. Intended to be
/// used with an object initializer.
/// </summary>
/// <param name="count"></param>
public ReadOnlyDictionary(int count)
{
_dict = new SortedDictionary<TKey, TValue>();
_finalCount = count;
}
/// <summary>
/// To allow object initializers, this will allow the dictionary to be
/// added onto up to a certain number, specifically the count set in
/// one of the constructors.
/// </summary>
/// <param name="key"></param>
/// <param name="value"></param>
public void Add(TKey key, TValue value)
{
if (_dict.Keys.Count < _finalCount)
{
_dict.Add(key, value);
}
else
{
throw new InvalidOperationException(
"Cannot add pair <" + key + ", " + value + "> because " +
"maximum final count " + _finalCount + " has been reached"
);
}
}
これで、次のようにクラスを使用できます。
ReadOnlyDictionary<string, string> Fields =
new ReadOnlyDictionary<string, string>(2)
{
{"hey", "now"},
{"you", "there"}
};
私はそうは思わない。読み取り専用のリストと読み取り専用のコレクションを作成する方法はありますが、読み取り専用のディクショナリが組み込まれているとは思いません。System.ServiceModel には ReadOnlyDictinoary 実装がありますが、その内部です。ただし、Reflector を使用してコピーしたり、ゼロから独自のものを作成したりするのは、おそらくそれほど難しくありません。基本的に辞書をラップし、ミューテーターが呼び出されたときにスローします。
回避策の 1 つは、Dictionary から KeyValuePair の新しいリストをスローして、元の値を変更しないようにすることです。
var dict = new Dictionary<string, string>();
dict.Add("Hello", "World");
dict.Add("The", "Quick");
dict.Add("Brown", "Fox");
var dictCopy = dict.Select(
item => new KeyValuePair<string, string>(item.Key, item.Value));
// returns dictCopy;
このようにして、元の辞書は変更されません。
次のようなことを試すことができます:
private readonly Dictionary<string, string> _someDictionary;
public IEnumerable<KeyValuePair<string, string>> SomeDictionary
{
get { return _someDictionary; }
}
これにより、呼び出し元がそれを独自の辞書に変換する必要がなくなり、可変性の問題が解消されます。
foo.SomeDictionary.ToDictionary(kvp => kvp.Key);
... または、インデックス ルックアップではなく、キーに対して比較演算を使用します。例:
foo.SomeDictionary.First(kvp => kvp.Key == "SomeKey");
I've found an implementation of an Inmutable (not READONLY) implementation of a AVLTree for C# here.
An AVL tree has logarithmic (not constant) cost on each operation, but stills fast.
「箱から出して」これを行う方法はありません。独自の Dictionary クラスを派生させ、必要な制限を実装することで作成できます。
一般に、最初から辞書を渡さない方がはるかに良い考えです (そうする必要がない場合)。
代わりに、ディクショナリを変更する (ラップする)メソッドを提供しないインターフェイスを持つドメイン オブジェクトを作成します。代わりに、キーによって辞書から要素を取得する必要な LookUp メソッドを提供します (おまけに、辞書よりも使いやすくなります)。
public interface IMyDomainObjectDictionary
{
IMyDomainObject GetMyDomainObject(string key);
}
internal class MyDomainObjectDictionary : IMyDomainObjectDictionary
{
public IDictionary<string, IMyDomainObject> _myDictionary { get; set; }
public IMyDomainObject GetMyDomainObject(string key) {.._myDictionary .TryGetValue..etc...};
}
Linq 以来、ジェネリック インターフェイスILookupがあります。詳細については、MSDNを参照してください。
したがって、不変の辞書を簡単に取得するには、次のように呼び出します。
using System.Linq;
// (...)
var dictionary = new Dictionary<string, object>();
// (...)
var read_only = dictionary.ToLookup(kv => kv.Key, kv => kv.Value);
私が説明したように、別の選択肢もあります:
http://www.softwarerockstar.com/2010/10/readonlydictionary-tkey-tvalue/
基本的に、これは ReadOnlyCollection> のサブクラスであり、より洗練された方法で作業を完了します。Dictionary 内の項目を変更するメソッドから例外をスローするのではなく、Dictionary を読み取り専用にするためのコンパイル時サポートがあるという意味でエレガントです。