Hulk' Den

in-depth thinking and keep moving.

将自定义的值类型用作字典的键,要特别注意什么?

  前天关注了老赵的微信公众号:赵人希。昨天就推送了一个快速问答,下面把我的答题经历跟大家分享,希望对于菜鸟同胞们有所帮助启发。

  其实这个问题在他的博客里有专门的篇幅讲解,我猜到了,哈哈。但是大牛讲问题都是在一个高度上,水平差点的需要费点力气才能理解,而这个过程就是拉进我们与大牛距离的过程,用心总结下,才能不断强化自己靠近他们。

一、通常的字典用法(熟练可直接略过)

  在我平时的编码中,用的最频繁的就是代码段[1]:

public class Example
{
    public static void Main()
    {
        Dictionary<string, string> openWith = new Dictionary<string, string>();

        openWith.Add("txt", "notepad.exe");
        openWith.Add("bmp", "paint.exe");
        openWith.Add("rtf", "wordpad.exe");

        if (!openWith.ContainsKey("ht"))
        {
        openWith.Add("ht", "hypertrm.exe");
        }

        foreach (KeyValuePair<string, string> kvp in openWith)
        {
        Console.WriteLine("Key = {0}, Value = {1}",
        kvp.Key, kvp.Value);
        }

        Dictionary<string, string>.ValueCollection valueColl = openWith.Values;
        foreach (string s in valueColl)
        {
        Console.WriteLine("Value = {0}", s);
        }

        Dictionary<string, string>.KeyCollection keyColl = openWith.Keys;
        foreach (string s in keyColl)
        {
        Console.WriteLine("Key = {0}", s);
        }
        Console.ReadKey();
    }
}

  其中Dictionary<键,值>的键通常就是int或者string类型,那现在我们需要自定义值类型,并把它作为字典的键应该怎么做?

二、自定义值类型,并考虑用于字典的键时遇到的问题

  整天定义引用类型,值类型还真写的少,其实是对值类型的优势了解的少!代码段[2]:

private struct MyKey
{
    private readonly int _a;
    private readonly int _b;
    public MyKey(int a, int b)
    {
        _a = a;
        _b = b;
    }
}

  这就OK了,可以根据自己的需求加入一些属性和方法,对于一些简单的需求,定义一个struct要更高效节省。

  代码段[2]中的值类型就可以用于字典的键,但是,这就够了吗?万事都有不完美,你有没有考虑到值类型随之而来的[装箱]!比如代码段[3]:

public static void Main()
{
    Dictionary<MyKey, string> testDic = new Dictionary<MyKey, string>();
    MyKey key12 = new MyKey(1, 2);
    testDic.Add(key12, "1&2");
    Console.ReadKey();
}

  插一句:在我们分析问题时,要想明白原理,弄清楚.net框架中是怎么实现的,就必须抄家伙(.NET Reflector)!这是我们进步的一个重要工具。

  Dictionary中Add方法调用的Insert方法的部分实现,如代码段[4]:

int num = this.comparer.GetHashCode(key) & 0x7fffffff;
int index = num % this.buckets.Length;
int num3 = 0;
for (int i = this.buckets[index]; i >= 0; i = this.entries[i].next)
{
    if ((this.entries[i].hashCode == num) && this.comparer.Equals(this.entries[i].key, key))
    {
        if (add)
        {
            ThrowHelper.ThrowArgumentException(ExceptionResource.Argument_AddingDuplicate);
        }
        this.entries[i].value = value;
        this.version++;
        return;
    }
    num3++;
}

注意:其中用到了对象的GetHashCode和Equals方法,我们知道所有类型最终都继承自System.Object,如果在自定义的类型以及其继承层次的所有类中没有重写GetHashCode和Equals方法(自定义值类型的继承层次是MyKey=>System.ValueType=>System.Object),那么就会调用基类Object的相应方法,那必然会导致[装箱]操作。

三、发现问题了,那就解决问题!

  而在Dictionary中,代码段[4]显示的是通过this.comparer调用的这两个方法,那this.comparer是什么呢?继续挖掘,是Dictionary类中维护的一个IEqualityComparer<T>类型的对象。代码段[5]:

public Dictionary(int capacity, IEqualityComparer<TKey> comparer)
{
    if (capacity < 0)
    {
        ThrowHelper.ThrowArgumentOutOfRangeException(ExceptionArgument.capacity);
    }
    if (capacity > 0)
    {
        this.Initialize(capacity);
    }
    this.comparer = comparer ?? EqualityComparer<TKey>.Default;
}

  如果在创建Dictionary时没有在参数中提供比较器,则会使用默认的EqualityComparer<T>.Default对象给this.comparer赋值,它的构造方法是代码段[6]:

[SecuritySafeCritical]
private static EqualityComparer<T> CreateComparer()
{
    RuntimeType c = (RuntimeType) typeof(T);
    if (c == typeof(byte))
    {
        return (EqualityComparer<T>) new ByteEqualityComparer();
    }
    if (typeof(IEquatable<T>).IsAssignableFrom(c))
    {
        return (EqualityComparer<T>) RuntimeTypeHandle.CreateInstanceForAnotherGenericParameter((RuntimeType) typeof(GenericEqualityComparer<int>), c);
    }
    if (c.IsGenericType && (c.GetGenericTypeDefinition() == typeof(Nullable<>)))
    {
        RuntimeType type2 = (RuntimeType) c.GetGenericArguments()[0];
        if (typeof(IEquatable<>).MakeGenericType(new Type[]{ type2 }).IsAssignableFrom(type2))
        {
        return (EqualityComparer<T>) RuntimeTypeHandle.CreateInstanceForAnotherGenericParameter((RuntimeType) typeof(NullableEqualityComparer<int>), type2);
        }
    }
    if (c.IsEnum && (Enum.GetUnderlyingType(c) == typeof(int)))
    {
        return (EqualityComparer<T>) RuntimeTypeHandle.CreateInstanceForAnotherGenericParameter((RuntimeType) typeof(EnumEqualityComparer<int>), c);
    }
    return new ObjectEqualityComparer<T>();
}

  可以看出,根据不同的情况它会使用各式不同的比较器。其中最适合我们的自然就是实现IEquatable<T>接口的分支了:

if (typeof(IEquatable<T>).IsAssignableFrom(c))
{
    return (EqualityComparer<T>) RuntimeTypeHandle.CreateInstanceForAnotherGenericParameter((RuntimeType) typeof(GenericEqualityComparer<int>), c);
}

  为了能够符合这个if的条件,我们的自定义值类型MyKey应当实现IEquatable<MyKey>接口(实现Equals方法),并且重写GetHashCode方法(Object的GetHashCode方法也会导致装箱),才能彻底避免装箱操作。

  因此,我的最终实现是代码段[7]:

public struct MyKey : IEquatable<MyKey>
{
    private readonly int _a;
    private readonly int _b;

    public MyKey(int a, int b)
    {
        _a = a;
        _b = b;
    }
    public override int GetHashCode()
    {
        return (this._a ^ this._b);
    }

    public bool Equals(MyKey that)
    {
        return (this._a == that._a) && (this._b == that._b);
    }
}

  就这样,一个简单的问答被我们剖析了个遍,很过瘾吧!

 

  最后,文中如果有不对的地方,欢迎各位大牛指正!这里先谢过了!

  如果你觉得本文对你有帮助,那就点个赞吧,权当鼓励。

 

最近的文章

简单实现弹出页更换头像的功能

  在Win 8应用里,对弹出页(Popup)的灵活操作必不可少,下面我们就来简单实现一个。一、先让Popup弹出到指定位置  先来看看效果图,如图[1]:        下面是前端代码,代码段[1]:<Grid Background="#0054a2"> <Border Background="AliceBlue" Margin="40,40,1126,528" Width="150" Height="150"> ...…

C# | .NETWin8 | WP8继续阅读
更早的文章

从闭包说起

   世界杯车轮战开始了,连通三天,基本进入世界杯状态。看球也不能忘了玩技术,这次打算把接触c#以来的点滴总结起来,让原本模糊的概念清晰起来,博友们一起来吧!  [闭包]接触这个词的第一感觉就是晦涩难懂,下面我们就来啃一啃。一、邂逅[闭包]  第一次接触闭包是在js里,先来看代码段[1]:function a() { var i = 0; function b() { alert(++i); } return b; } var c = a(...…

C# | .NET继续阅读