C#程序编写高质量代码改善的157个建议【10-12】[创建对象时需要考虑是否实现比较器、区别对待==和Equals]

前言

　　建议10、创建对象时需要考虑是否实现比较器

　　建议11、区别对待==和equals

　　建议12、重写equals时也要重写gethashcode

建议10、创建对象时需要考虑是否实现比较器

　　有对象的地方就会存在比较，就像小时候每次拿着考卷回家，妈妈都会问你隔壁的那谁谁谁考了多少分呀。下面我们也来举个简单的例子，就是有几个人的salary列表。我们根据基本工资来进行罗列：

    class program
    {
        static void main(string[] args)
        {
            arraylist array = new arraylist();
            array.add(1100);
            array.add(1200);
            array.add(1160);
            array.sort();
            foreach (var obj in array)
            {
                console.writeline(obj.tostring());
            }
            console.readline();
        }
    }

 可以发现通过arraylist.sort()方法即可完成排序的任务。不过arraylist这里只能是一个字段的。假如有姓名、工资两个字段，然后根据工资进行排序那么按照现在的情况来看，arraylist是无法实现的。所以接口icomparable现在可以派上用场了。现在先定义一个实体，并且实现接口icomparable。

public class salary:icomparable
    {
        /// <summary>
        /// 姓名
        /// </summary>
        public string name { get; set; }

        /// <summary>
        /// 基本工资
        /// </summary>
        public int basesalary { get; set; }

        /// <summary>
        /// 实现icomparable接口
        /// </summary>
        /// <param name="obj"></param>
        /// <returns></returns>
        public int compareto(object obj)
        {
            salary staff = obj as salary;
            if (basesalary > staff.basesalary)
            {
                return 1;
            }
            else if (basesalary == staff.basesalary)
            {
                return 0;
            }
            else
            {
                return -1;
            }
        }
    }

进行排序

                arraylist array = new arraylist();
                array.add(new salary() { name = "aehyok", basesalary = 12000 });
                array.add(new salary() { name = "kris", basesalary = 11200 });
                array.add(new salary() { name = "leo", basesalary = 18000 });
                array.add(new salary() { name = "niki", basesalary = 20000 });
                array.sort();
                foreach (salary obj in array)
                {
                    console.writeline(string.format("{0} basesalary:{1}", obj.name, obj.basesalary));
                }
                console.readline();

如果未继承icomparable接口。那么会出现如下错误。

正确的进行排序，结果如下所示

假如现在在salary类中添加了一个奖金的字段如下

public class salary:icomparable
    {
        /// <summary>
        /// 姓名
        /// </summary>
        public string name { get; set; }

        /// <summary>
        /// 基本工资
        /// </summary>
        public int basesalary { get; set; }

        /// <summary>
        /// 奖金
        /// </summary>
        public int bouns { get; set; }

        /// <summary>
        /// 实现icomparable接口
        /// </summary>
        /// <param name="obj"></param>
        /// <returns></returns>
        public int compareto(object obj)
        {
            salary staff = obj as salary;
            if (basesalary > staff.basesalary)
            {
                return 1;
            }
            else if (basesalary == staff.basesalary)
            {
                return 0;
            }
            else
            {
                return -1;
            }
        }
    }

再继续假如，现在又要以bouns奖金字段进行排序，那应该怎么处理呢？当然修改salary实体类中继承的接口方法进行处理肯定是没问题了，但是比较麻烦。我们可以采用自定义比较接口icomparer来实现。

    public class bounscomparer:icomparer
    {
        public int compare(object x, object y)
        {
            salary s1 = x as salary;
            salary s2 = y as salary;
            return s1.bouns.compareto(s2.bouns);
        }
    }

然后重新进行排序

                arraylist array = new arraylist();
                array.add(new salary() { name = "aehyok", basesalary = 12000,bouns=500 });
                array.add(new salary() { name = "kris", basesalary = 11200,bouns=400 });
                array.add(new salary() { name = "leo", basesalary = 18000,bouns=300 });
                array.add(new salary() { name = "niki", basesalary = 20000,bouns=700 });
                array.sort(new bounscomparer());
                foreach (salary obj in array)
                {
                    console.writeline(string.format("{0} \tbasesalary:{1}\tbouns{2}", obj.name, obj.basesalary,obj.bouns));
                }
                console.readline();

结果如下所示

注意，刚才实现接口名字叫icomparable,而自定义的比较器接口是icomparer

如果我们稍有经验，会发现如下函数中的问题

        public int compare(object x, object y)
        {
            salary s1 = x as salary;
            salary s2 = y as salary;
            return s1.bouns.compareto(s2.bouns);
        }

这个函数中进行了转型处理，这是会影响性能的。如果集合中有成千上万个复杂的实体对象，那么进行排序时耗费的时间是巨大的。所以泛型登场，很好的解决了这个问题。

因此以上代码中的arraylist，可以替换为list<t>,对应的我们就应该实现icomparable<t>和icomparer<t>。

实现的代码如下:  

1、实体类实现接口icomparable<t>  2、自定义比较器实现接口icomparer<t> 3、进行排序的调用

    public class salary:icomparable<salary>
    {
        /// <summary>
        /// 姓名
        /// </summary>
        public string name { get; set; }

        /// <summary>
        /// 基本工资
        /// </summary>
        public int basesalary { get; set; }

        /// <summary>
        /// 奖金
        /// </summary>
        public int bouns { get; set; }

        /// <summary>
        /// 实现icomparable接口
        /// </summary>
        /// <param name="obj"></param>
        /// <returns></returns>

        public int compareto(salary other)
        {
            return basesalary.compareto(other.basesalary);
        }
    }

    public class bounscomparer : icomparer<salary>
    {
        public int compare(salary x, salary y)
        {
            return x.bouns.compareto(y.bouns);
        }
    }

                list<salary> array =new list<salary>();
                array.add(new salary() { name = "aehyok", basesalary = 12000,bouns=500 });
                array.add(new salary() { name = "kris", basesalary = 11200,bouns=400 });
                array.add(new salary() { name = "leo", basesalary = 18000,bouns=300 });
                array.add(new salary() { name = "niki", basesalary = 20000,bouns=700 });
                array.sort(new bounscomparer());
                foreach (salary obj in array)
                {
                    console.writeline(string.format("{0} \tbasesalary:{1}\tbouns{2}", obj.name, obj.basesalary,obj.bouns));
                }
                console.readline();

最终结果

建议11、区别对待==和equals

 这里我之前有一篇博文针对==和equals有过专门的介绍，在此就不再进行过多的阐述了

建议12、重写equals时也要重写gethashcode

 下面先来看一个简单的小例子，定义如下实体类：

    public class person
    {
        public string idcode { get;private set; }

        public person(string idcode)
        {
            this.idcode = idcode;
        }

        public override bool equals(object obj)
        {
            return idcode == (obj as person).idcode;
        }
    }

针对上面实体类进行编译

这里会有一个提示暂时先不管

    public class personmoreinfo
    {
        public string something { get; set; }
    }

通过这两个实体类，我们来使用以下dictionary类型，代码如下：

    class program
    {
        static dictionary<person, personmoreinfo> personvalues = new dictionary<person, personmoreinfo>();
        static void main(string[] args)
        {
            addaperson();
            person mike = new person("aehyok");
            console.writeline(personvalues.containskey(mike));
            //console.writeline(mike.gethashcode());
            console.readline();
        }
        static void addaperson()
        {
            person mike = new person("aehyok");
            personmoreinfo mikevalue = new personmoreinfo() {  something="aehyok's info"};
            personvalues.add(mike, mikevalue);
            //console.writeline(mike.gethashcode());
            console.writeline(personvalues.containskey(mike));
        }
    }

结果为true,false。

理论上来说，我们重写了person类中的equals方法，也就是说在addaperson方法中的mike和在main函数中的mike属于”值相等“。从上面的结果可以发现，针对同一个实例，这种结论是正确的，针对不同的实例，这种结果就是有问题的。

基于键值的集合（如上面的dictionary）会根据key值来查找value值。clr内部会优化这种查找，实际上，最终是根据key值的hascode来查找value值。代码运行的时候，crl首先会调用person类型的gethashcode，由于发现person没有实现gethashcode，所以clr最终会调用object的 gethashcode方法。将上面代码中的两行注释代码去掉，运行程序得到输出

 

可以发现，addaperson方法和main方法中的两个mike的hashcode是不同的。这是因为：object为所有的clr类型都提供了gethashcode的默认实现。每new一个对象，clr都会为该对象生成一个固定的整形值，该整形值在对象的生存周期内不会改变，而该对象默认的gethashcode实现就是对该整型值求hashcode。所以，在上面的代码中，两个mike兑现虽然属性值都一致，但是它们默认实现的hashcode不一致，这就导致dictionary中出现异常的行为。

想要修正该问题，就必须重写gethashcode方法。person类的一个简单的重写可以是如下的代码：

        public override int gethashcode()
        {
            return this.idcode.gethashcode();
        }

此时再运行上面的代码，会发现

两者的hashcode是一致的，而dictionary也会找到相应的键值。

gethascode方法存在另外一个问题，就是它永远只返回一个整型，而整型类型的容量显然无法满足字符串的容量

            string str1 = "nb0903100006";
            string str2 = "nb0904140001";
            console.writeline(str1.gethashcode());
            console.writeline(str2.gethashcode());

这两个字符串产生的hascode是一样的。为了减少这种情况，我们稍作修改：

        public override int gethashcode()
        {
            return (system.reflection.methodbase.getcurrentmethod().declaringtype.fullname+"#"+this.idcode).gethashcode();
        }

重写equals方法的同时，也应该实现一个类型安全的接口iequatable<t>,所以person类型的最终代码如下：

    public class person:iequatable<person>
    {
        public string idcode { get;private set; }

        public person(string idcode)
        {
            this.idcode = idcode;
        }

        public override bool equals(object obj)
        {
            return idcode == (obj as person).idcode;
        }

        public override int gethashcode()
        {
            return (system.reflection.methodbase.getcurrentmethod().declaringtype.fullname+"#"+this.idcode).gethashcode();
        }

        public bool equals(person other)
        {
            return idcode == other.idcode;
        }
    }

对于iequatable接口暂时没接触过。第一次使用