เหตุใดจึงสำคัญที่ต้องแทนที่ GetHashCode เมื่อเมธอด Equals ถูกเขียนทับ

รับคลาสต่อไปนี้

public class Foo
{
    public int FooId { get; set; }
    public string FooName { get; set; }

    public override bool Equals(object obj)
    {
        Foo fooItem = obj as Foo;

        if (fooItem == null) 
        {
           return false;
        }

        return fooItem.FooId == this.FooId;
    }

    public override int GetHashCode()
    {
        // Which is preferred?

        return base.GetHashCode();

        //return this.FooId.GetHashCode();
    }
}

ฉันได้เขียนทับEqualsวิธีเพราะFooเป็นตัวแทนของแถวสำหรับFooตาราง s ซึ่งเป็นวิธีที่ต้องการสำหรับการเอาชนะGetHashCode?

ทำไมมันจึงเป็นสิ่งสำคัญที่จะแทนที่GetHashCode?

ใช่มันเป็นสิ่งสำคัญหากรายการของคุณจะถูกใช้เป็นคีย์ในพจนานุกรมหรือHashSet<T>อื่น ๆ - เนื่องจากมีการใช้ (ในกรณีที่ไม่มีการกำหนดเองIEqualityComparer<T>) เพื่อจัดกลุ่มรายการเป็นที่เก็บข้อมูล หากรหัสแฮชสำหรับสองรายการไม่ตรงกันอาจไม่มีการพิจารณาว่าเท่าเทียมกัน ( เท่ากับจะไม่ถูกเรียก)

กระบวนการGetHashCode ()วิธีควรสะท้อนEqualsตรรกะ กฎคือ:

• หากสองสิ่งเท่ากัน ( Equals(...) == true) จากนั้นพวกเขาจะต้องส่งกลับค่าเดียวกันสำหรับGetHashCode()
• หากGetHashCode()เท่ากันก็ไม่จำเป็นสำหรับพวกเขาที่จะเหมือนกัน; นี่คือการชนกันและEqualsจะถูกเรียกให้ดูว่ามันเป็นความเท่าเทียมกันจริงหรือไม่

ในกรณีนี้ดูเหมือนว่า " return FooId;" เป็นการGetHashCode()ใช้งานที่เหมาะสม หากคุณกำลังทดสอบคุณสมบัติหลายรายการเป็นเรื่องปกติที่จะรวมเข้าด้วยกันโดยใช้รหัสเช่นด้านล่างเพื่อลดการชนในแนวทแยง (เช่นเพื่อให้new Foo(3,5)มีรหัสแฮชที่แตกต่างกันไปnew Foo(5,3)):

unchecked // only needed if you're compiling with arithmetic checks enabled
{ // (the default compiler behaviour is *disabled*, so most folks won't need this)
    int hash = 13;
    hash = (hash * 7) + field1.GetHashCode();
    hash = (hash * 7) + field2.GetHashCode();
    ...
    return hash;
}

โอ้ - เพื่อความสะดวกของคุณอาจยังพิจารณาให้==และ!=ผู้ประกอบการเมื่อเอาชนะและEqualsGetHashCode

การสาธิตของสิ่งที่เกิดขึ้นเมื่อคุณได้รับผิดนี้อยู่ที่นี่

จริงๆแล้วมันยากมากที่จะใช้GetHashCode()อย่างถูกต้องเพราะนอกจากกฎที่ Marc ได้กล่าวมาแล้วรหัสแฮชไม่ควรเปลี่ยนแปลงในช่วงอายุการใช้งานของวัตถุ ดังนั้นฟิลด์ที่ใช้ในการคำนวณรหัสแฮชต้องไม่เปลี่ยนรูป

ในที่สุดฉันก็พบวิธีแก้ปัญหานี้เมื่อฉันทำงานกับ NHibernate แนวทางของฉันคือการคำนวณรหัสแฮชจาก ID ของวัตถุ ID สามารถตั้งค่าได้แม้ว่า Constructor ดังนั้นหากคุณต้องการเปลี่ยน ID ซึ่งไม่น่าเป็นไปได้มากคุณต้องสร้างออบเจ็กต์ใหม่ที่มี ID ใหม่และดังนั้นจึงเป็นรหัสแฮชใหม่ วิธีการนี้ทำงานได้ดีที่สุดกับ GUIDs เนื่องจากคุณสามารถกำหนดตัวสร้างแบบไร้พารามิเตอร์ซึ่งจะสร้าง ID แบบสุ่ม

โดยเอาชนะเท่ากับคุณโดยทั่วไปว่าคุณเป็นคนที่รู้วิธีเปรียบเทียบสองประเภทที่กำหนดดังนั้นคุณน่าจะเป็นตัวเลือกที่ดีที่สุดในการให้รหัสแฮชที่ดีที่สุด

นี่คือตัวอย่างของวิธีที่ ReSharper เขียนฟังก์ชัน GetHashCode () ให้คุณ:

public override int GetHashCode()
{
    unchecked
    {
        var result = 0;
        result = (result * 397) ^ m_someVar1;
        result = (result * 397) ^ m_someVar2;
        result = (result * 397) ^ m_someVar3;
        result = (result * 397) ^ m_someVar4;
        return result;
    }
}

อย่างที่คุณเห็นมันแค่พยายามคาดเดารหัสแฮชที่ดีโดยยึดตามฟิลด์ทั้งหมดในคลาส แต่เนื่องจากคุณรู้ว่าโดเมนหรือช่วงค่าของวัตถุคุณยังคงสามารถให้รหัสที่ดีกว่าได้

โปรดอย่าลืมตรวจสอบพารามิเตอร์ obj กับเมื่อเอาชนะnull Equals()และยังเปรียบเทียบประเภท

public override bool Equals(object obj)
{
    Foo fooItem = obj as Foo;

    if (fooItem == null)
    {
       return false;
    }

    return fooItem.FooId == this.FooId;
}

เหตุผลของเรื่องนี้คือต้องกลับผิดพลาดในการเปรียบเทียบกับEquals nullดูhttp://msdn.microsoft.com/en-us/library/bsc2ak47.aspx

เกี่ยวกับ:

public override int GetHashCode()
{
    return string.Format("{0}_{1}_{2}", prop1, prop2, prop3).GetHashCode();
}

สมมติว่าประสิทธิภาพไม่ใช่ปัญหา :)

เรามีสองปัญหาที่ต้องรับมือ

1. คุณไม่สามารถให้เหตุผลได้GetHashCode()หากฟิลด์ใด ๆ ในวัตถุสามารถเปลี่ยนแปลงได้ GetHashCode()ก็มักจะวัตถุจะไม่ถูกนำมาใช้ในคอลเลกชันที่ขึ้นอยู่กับ ดังนั้นค่าใช้จ่ายในการติดตั้งGetHashCode()จึงไม่คุ้มค่าหรือเป็นไปไม่ได้

2. หากมีคนวางวัตถุของคุณในคอลเล็กชันที่เรียก GetHashCode()และคุณได้แทนที่Equals()โดยไม่ GetHashCode()ทำตัวให้ถูกวิธีบุคคลนั้นอาจใช้เวลาหลายวันในการติดตามปัญหา

ดังนั้นโดยค่าเริ่มต้นฉันทำ

public class Foo
{
    public int FooId { get; set; }
    public string FooName { get; set; }

    public override bool Equals(object obj)
    {
        Foo fooItem = obj as Foo;

        if (fooItem == null)
        {
           return false;
        }

        return fooItem.FooId == this.FooId;
    }

    public override int GetHashCode()
    {
        // Some comment to explain if there is a real problem with providing GetHashCode() 
        // or if I just don't see a need for it for the given class
        throw new Exception("Sorry I don't know what GetHashCode should do for this class");
    }
}

เป็นเพราะกรอบต้องการวัตถุที่สองที่เหมือนกันต้องมี hashcode เดียวกัน หากคุณแทนที่เมธอด equals เพื่อทำการเปรียบเทียบพิเศษของสองวัตถุและทั้งสองวัตถุนั้นถือว่าเหมือนกันด้วยวิธีการดังนั้นรหัสแฮชของวัตถุทั้งสองนั้นจะต้องเหมือนกัน (พจนานุกรมและแฮชเทเบิลใช้หลักการนี้)

เพียงเพิ่มคำตอบข้างบน:

หากคุณไม่ได้แทนที่เท่ากับแล้วพฤติกรรมเริ่มต้นคือการอ้างอิงของวัตถุที่มีการเปรียบเทียบ เช่นเดียวกับ hashcode - โดยทั่วไปการเริ่มต้นจะอิงตามที่อยู่หน่วยความจำของการอ้างอิง เนื่องจากคุณได้ลบล้าง Equals หมายความว่าพฤติกรรมที่ถูกต้องคือการเปรียบเทียบสิ่งที่คุณใช้กับ Equals ไม่ใช่การอ้างอิงดังนั้นคุณควรทำเช่นเดียวกันกับ hashcode

ลูกค้าในชั้นเรียนของคุณจะคาดหวังว่าแฮชโค้ดจะมีตรรกะที่คล้ายกันกับวิธีเท่ากับเช่นวิธี linq ที่ใช้ IEqualityComparer ก่อนเปรียบเทียบแฮชโค้ดและถ้าพวกเขาเท่ากันพวกเขาจะเปรียบเทียบวิธี Equals () ซึ่งอาจมีราคาแพงกว่า ในการรันหากเราไม่ได้ใช้ hashcode วัตถุที่เท่ากันอาจจะมี hashcodes ที่แตกต่างกัน (เพราะมันมีที่อยู่หน่วยความจำที่แตกต่างกัน) และจะถูกพิจารณาอย่างผิด ๆ ว่าไม่เท่ากับ (เท่ากับ ()

นอกจากนี้ยกเว้นปัญหาที่คุณอาจไม่สามารถค้นหาวัตถุของคุณหากคุณใช้มันในพจนานุกรม (เพราะมันถูกแทรกโดยหนึ่ง hashcode และเมื่อคุณมองหามัน hashcode เริ่มต้นอาจจะแตกต่างกันและอีกครั้งเท่ากับ () จะไม่ถูกเรียกเช่น Marc Gravell อธิบายในคำตอบของเขาคุณยังแนะนำการละเมิดพจนานุกรมหรือแนวคิด hashset ซึ่งไม่ควรอนุญาตให้ใช้รหัสที่เหมือนกัน - คุณได้ประกาศแล้วว่าวัตถุเหล่านั้นจะเหมือนกันเมื่อคุณเอาชนะเท่ากับคุณ ไม่ต้องการให้ทั้งคู่เป็นคีย์ที่แตกต่างกันในโครงสร้างข้อมูลซึ่งสมมติว่ามีคีย์เฉพาะ แต่เนื่องจากมีแฮชโค้ดที่ต่างกันคีย์ "เดียวกัน" จะถูกแทรกเป็นคีย์ที่ต่างกัน

รหัสแฮชใช้สำหรับคอลเลกชันที่ใช้แฮชเช่น Dictionary, Hashtable, HashSet เป็นต้นวัตถุประสงค์ของรหัสนี้คือการจัดเรียงวัตถุที่ต้องการล่วงหน้าอย่างรวดเร็วโดยการใส่ลงในกลุ่มเฉพาะ (bucket) การเรียงลำดับล่วงหน้านี้ช่วยอย่างมากในการค้นหาวัตถุนี้เมื่อคุณต้องการเรียกคืนจากแฮชคอลเลกชันเนื่องจากรหัสจะต้องค้นหาวัตถุของคุณในที่เก็บข้อมูลชุดเดียวแทนที่จะอยู่ในที่เก็บทั้งหมด การกระจายรหัสแฮชที่ดีขึ้น ในสถานการณ์ที่เหมาะสมที่แต่ละวัตถุมีรหัสแฮชที่ไม่ซ้ำกันการค้นหาเป็นการดำเนินการ O (1) ในกรณีส่วนใหญ่มันเข้าใกล้ O (1)

มันไม่จำเป็นว่าสำคัญ ขึ้นอยู่กับขนาดของคอลเลกชันและข้อกำหนดด้านประสิทธิภาพของคุณและคลาสของคุณจะถูกใช้ในห้องสมุดที่คุณอาจไม่ทราบข้อกำหนดด้านประสิทธิภาพหรือไม่ ฉันรู้ว่าขนาดคอลเล็กชั่นของฉันไม่ใหญ่มากและเวลาของฉันมีค่ามากกว่าประสิทธิภาพสองสามไมโครวินาทีโดยการสร้างรหัสแฮชที่สมบูรณ์แบบ ดังนั้น (เพื่อกำจัดคำเตือนที่น่ารำคาญโดยคอมไพเลอร์) ฉันใช้:

   public override int GetHashCode()
   {
      return base.GetHashCode();
   }

(แน่นอนฉันสามารถใช้ #pragma เพื่อปิดคำเตือนได้ แต่ฉันชอบวิธีนี้)

เมื่อคุณอยู่ในตำแหน่งที่คุณไม่จำเป็นต้องมีประสิทธิภาพกว่าทุกประเด็นที่กล่าวถึงโดยคนอื่น ๆ ที่นี่ใช้ของหลักสูตร สิ่งสำคัญที่สุด - ไม่เช่นนั้นคุณจะได้รับผลที่ผิดเมื่อดึงรายการจากชุดแฮชหรือพจนานุกรม: รหัสแฮชจะต้องไม่เปลี่ยนแปลงตามอายุการใช้งานของวัตถุ (แม่นยำยิ่งขึ้นในช่วงเวลาที่ต้องการรหัสแฮชเช่นในขณะที่ถูก คีย์ในพจนานุกรม): ตัวอย่างเช่นต่อไปนี้ผิดเนื่องจากค่าเป็นแบบพับลิกและสามารถเปลี่ยนเป็นคลาสภายนอกได้ในช่วงเวลาชีวิตของอินสแตนซ์ดังนั้นคุณต้องไม่ใช้เป็นพื้นฐานสำหรับรหัสแฮช:

   class A
   {
      public int Value;

      public override int GetHashCode()
      {
         return Value.GetHashCode(); //WRONG! Value is not constant during the instance's life time
      }
   }    

ในทางกลับกันหากไม่สามารถเปลี่ยนค่าได้มันก็สามารถใช้งานได้:

   class A
   {
      public readonly int Value;

      public override int GetHashCode()
      {
         return Value.GetHashCode(); //OK  Value is read-only and can't be changed during the instance's life time
      }
   }

คุณควรรับประกันเสมอว่าหากวัตถุสองชิ้นมีค่าเท่ากันตามที่กำหนดโดย Equals () วัตถุเหล่านั้นควรส่งคืนรหัสแฮชเดียวกัน ในฐานะที่เป็นความคิดเห็นอื่น ๆ ของรัฐในทางทฤษฎีสิ่งนี้ไม่จำเป็นถ้าวัตถุจะไม่ถูกนำมาใช้ในภาชนะที่ใช้กัญชาเช่น HashSet หรือพจนานุกรม ฉันจะแนะนำให้คุณทำตามกฎนี้เสมอ เหตุผลก็คือเพราะมันง่ายเกินไปสำหรับคนที่จะเปลี่ยนคอลเลกชันจากประเภทหนึ่งไปยังอีกประเภทหนึ่งโดยมีเจตนาที่ดีในการปรับปรุงประสิทธิภาพหรือเพียงแค่ถ่ายทอดความหมายของรหัสในวิธีที่ดีกว่า

ตัวอย่างเช่นสมมติว่าเราเก็บวัตถุบางอย่างในรายการ บางครั้งในภายหลังมีคนรู้ตัวว่า HashSet เป็นทางเลือกที่ดีกว่าเนื่องจากมีลักษณะการค้นหาที่ดีกว่า นี่คือเมื่อเราสามารถมีปัญหา รายการภายในจะใช้ตัวเปรียบเทียบความเท่าเทียมกันเริ่มต้นสำหรับประเภทซึ่งหมายถึงเท่ากับในกรณีของคุณในขณะที่ HashSet ใช้ GetHashCode () หากทั้งสองทำงานแตกต่างกันโปรแกรมของคุณก็จะเหมือนกัน และจำไว้ว่าปัญหาดังกล่าวไม่ใช่วิธีที่ง่ายที่สุดในการแก้ไขปัญหา

ฉันได้สรุปพฤติกรรมนี้กับข้อผิดพลาด GetHashCode () อื่น ๆ ในบล็อกโพสต์ที่คุณสามารถค้นหาตัวอย่างและคำอธิบายเพิ่มเติมได้

ตาม.NET 4.7วิธีที่ต้องการในการเอาชนะGetHashCode()แสดงไว้ด้านล่าง หากกำหนดเป้าหมายเวอร์ชัน. NET ที่เก่ากว่าให้รวมแพ็คเกจSystem.ValueTuple nuget

// C# 7.0+
public override int GetHashCode() => (FooId, FooName).GetHashCode();

ในแง่ของประสิทธิภาพวิธีนี้จะมีประสิทธิภาพสูงกว่าการใช้รหัสแฮชคอมโพสิตส่วนใหญ่ ValueTupleเป็นstructดังนั้นจะไม่มีขยะใด ๆ และอัลกอริทึมพื้นฐานคือให้เร็วที่สุดเท่าที่จะได้รับ

ฉันเข้าใจว่า GetHashCode ดั้งเดิม () ส่งคืนที่อยู่หน่วยความจำของวัตถุดังนั้นจึงจำเป็นที่จะต้องแทนที่หากคุณต้องการเปรียบเทียบสองวัตถุที่แตกต่างกัน

แก้ไข: ไม่ถูกต้องวิธีการ GetHashCode () เดิมไม่สามารถรับประกันความเท่าเทียมกันของ 2 ค่า แม้ว่าวัตถุที่เท่ากันจะส่งคืนรหัสแฮชเดียวกัน

การใช้ภาพสะท้อนด้านล่างนี้เป็นตัวเลือกที่ดีกว่าเมื่อพิจารณาคุณสมบัติสาธารณะเช่นเดียวกับที่คุณไม่ต้องกังวลเกี่ยวกับการเพิ่ม / ลบคุณสมบัติ (แม้ว่าจะไม่ใช่สถานการณ์ทั่วไป) ฉันพบว่ามันทำงานได้ดีขึ้นด้วย (เปรียบเทียบเวลาโดยใช้ Diagonistics stop watch)

    public int getHashCode()
    {
        PropertyInfo[] theProperties = this.GetType().GetProperties();
        int hash = 31;
        foreach (PropertyInfo info in theProperties)
        {
            if (info != null)
            {
                var value = info.GetValue(this,null);
                if(value != null)
                unchecked
                {
                    hash = 29 * hash ^ value.GetHashCode();
                }
            }
        }
        return hash;  
    }