隐藏接口实现 及 ReadOnlyDictionary
隐藏接口实现 及 ReadOnlyDictionary
作者:Anders Liu
摘要:本文介绍了如何从类型中隐藏掉接口的某个成员,并介绍了应用这种技巧实现的只读字典——ReadOnlyDictionary。
接口代表着一种契约。但有的时候,接口所达成的契约并不适用于全部的场景,或者说,接口可能定义得“太宽了”。这个时候,就有必要隐藏起某些接口成员。
然而,接口既然是一种“契约”,这就要求实现方必须为接口中的所有成员提供实现。所以,这里说到的“隐藏”,是指从对象的视角上隐藏。换言之,就是只有直接在对象上调用成员时,看不到某些接口成员,但如果将对象强制转换为接口类型,依然能看到所有的接口成员。
在C#中,接口的显式实现可以帮助我们实现这一功能。下面的代码可以帮助我们回忆一下接口的显式实现。
public interface IFoo { void Foo(); } public class Implement : IFoo { // 显式实现的接口成员: void IFoo.Foo() { /* 实现 */ } } public class Program { static void Main() { Implement impl = new Implement(); impl.Foo(); // 编译错误。显式实现的接口成员不能直接在对象上调用。 IFoo foo = (IFoo)impl; foo.Foo(); // 编译正确。 } }
下面举个实际的例子。熟悉集合的朋友一定对ICollection<T>接口不陌生。该接口定义了集合类型的一般成员,包括Add、Clear、Contains、CopyTo、GetEnumerator、Remove、Count等等。从集合的角度来看,这些成员是很充分的。
但是,考虑这样一个场景——希望实现一个只读集合类,这个类不允许改变集合的内容。很明显,只读集合也“是一个”集合,所以理应实现ICollection<T>接口。然而,接口中的Add、Clear和Remove等方法无疑是破坏了集合的“只读”特征。
因此,在实现只读集合时,可以用这样一种方式来实现只读集合类——在类型中定义一个普通集合类型的私有字段,也就是说,让只读集合“包装”一个普通集合。这个只读集合类依然实现ICollection<T>接口,其中不会破坏“只读”性质的成员,直接采用普通集合的实现;而对于会破坏“只读”性质的接口成员,则采用显式接口实现的方式,从对象实例中隐藏掉该成员。
最后,为了防止用户将对象强制转换为接口类型,并试图调用那些会破坏只读性质的成员,需要在这些成员的实现代码中抛出异常(推荐使用NotSupportedException异常)。
例如,下面介绍一个ReadOnlyCollection类:
首先,令该类实现ICollection<T>接口,定义一个私有字段存放待包装的普通集合,并在构造器中为其赋值。
public class ReadOnlyCollection<T> : ICollection<T> { private ICollection<T> _collection; public ReadOnlyCollection<ICollection<T> collection) { if(collection == null) throw new NotSupportedException(); _collection = collection; } }
对于那些不会破坏只读性质的成员,直接利用普通集合的实现即可。这里以Contains方法为例。
public bool Contains(T value) { return _collection.Contains(value); }
而对于那些会破坏只读性质的成员,则采用接口成员的显式实现,并在实现代码中抛出异常。这里以Add方法为例。
void ICollection<T>.Add(T value) { throw new NotSupportedException(); }
非常cool的是,.NET从2.0开始,已经为我们提供了这样一个只读集合,位于System.Collections.ObjectModel命名空间中。
当然,这里为了能够简单地说明问题,提供的代码示例与.NET中的实现并不太一样,有兴趣的朋友可以用.NET Reflector查看ReadOnlyCollection<T>类的源代码。
遗憾的是,.NET只为我们提供了只读集合,却没有提供只读字典(或者是提供了,但我不知道)。所以在这里我仿照ReadOnlyCollection<T>类,编写了一个ReadOnlyDictionary<TKey, TValue>类。代码略长,这里就不贴了,感兴趣的朋友可以通过下面的链接下载:
https://files.cnblogs.com/AndersLiu/ReadOnlyDirectionary.zip