起因

今天在公司做一個需求的時候，寫的是面條代碼，一個方法直接從頭寫到尾，其中用到了GroupBy，且GroupBy的KeySelector是多個屬性而不是單個屬性。

但是公司最近推行Clean Code，要讓代碼有可讀性。且作為一個有追求的程序員，肯定是不能寫面條代碼的，要對代碼進(jìn)行拆分。

重構(gòu)前GroupBy大概是這樣子的：

var groups = data.GroupBy(m => new { m.PropertyA, m.PropertyB})

個人對于短的Linq比較習(xí)慣于用方法而不是用關(guān)鍵字的那種寫法。

一開始這樣寫是沒問題的，但是重構(gòu)的時候問題就來了：這個groups是什么類型？

重構(gòu)以后這個groups是要作為參數(shù)進(jìn)入到別的方法中的，方法簽名顯然是不能用var做類型推導(dǎo)，必須指定確定的類型。

我們知道GroupBy出來的東西是個泛型的東西，簽名是IEnumerable<IGrouping<TKey, TSource>>，這個TSource類型是沒問題，我沒有對Source做修改，就是data本身的類型。

但是這個Key就有問題了。

我沒有指定Key的類型，這里應(yīng)該是匿名類型，于是定義了一個類型承接Key，代碼變成了：

class EntityKey
{
 public int PropertyA { get set; }
 public string PropertyB { get set; }
}

......

var groups = data.GroupBy(m => new EntityKey { PropertyA = m.PropertyA, PropertyB = m.PropertyB});

但是后來我發(fā)現(xiàn)這樣有問題，GroupBy指定的Key失效了。也就是說，groups的分組數(shù)量與data的長度一致，每一個group里面只有一個對象。

分析

發(fā)現(xiàn)這個問題后，我仔細(xì)思考了一下，大致猜到了問題出在哪里。

GroupBy這種東西，判斷兩個對象是不是一個分組，必然用到了相等判斷。

雖然我沒有看匿名類型反編譯生成后的IL代碼，不知道之前用的是怎么做的Key相等判斷，但是引用類型的肯定是直接用對象的HashCode做判斷。

這樣子肯定是不行的，要解決引用類型的相等判斷問題。

重現(xiàn)

根據(jù)猜測，我寫了一個Sample程序最小化的重現(xiàn)了這個問題：

class Program
{
 static void Main(string[] args)
 {
  var list = new List<Student>();
  list.Add(new Student(1, "Cat", 10, "University1"));
  list.Add(new Student(2, "Dog", 10, "University1"));
  list.Add(new Student(3, "Pig", 10, "University2"));
  list.Add(new Student(4, "Fish", 12, "University1"));

  var groups = list.GroupBy(m => new {m.Age, m.Class});
  
  foreach (var group in groups)
  {
   Console.WriteLine("Age:{0},Class:{1}", group.Key.Age, group.Key.Class);
   foreach (var student in group)
   {
    Console.WriteLine(student);
   }
  }
 }

 class Student
 {
  public int Id { get; set; }
  public string Name { get; set; }
  public int Age { get; set; }
  public string Class { get; set; }

  public Student(int id, string name, int age, string @class)
  {
   Id = id;
   Name = name;
   Age = age;
   Class = @class;
  }

  public override string ToString()
  {
   return $"Id={Id},Name={Name},Age={Age},Class={Class}";
  }
 }

 class StudentKey
 {
  public int Age { get; set; }
  public string Class { get; set; }
 }
}

這時候輸出結(jié)果是

Age:10,Class:University1
Id=1,Name=Cat,Age=10,Class=University1
Id=2,Name=Dog,Age=10,Class=University1
Age:10,Class:University2
Id=3,Name=Pig,Age=10,Class=University2
Age:12,Class:University1
Id=4,Name=Fish,Age=12,Class=University1

將new {m.Age, m.Class}替換為new StudentKey {Age = m.Age, Class = m.Class}，結(jié)果卻變成了

Age:10,Class:University1
Id=1,Name=Cat,Age=10,Class=University1
Age:10,Class:University1
Id=2,Name=Dog,Age=10,Class=University1
Age:10,Class:University2
Id=3,Name=Pig,Age=10,Class=University2
Age:12,Class:University1
Id=4,Name=Fish,Age=12,Class=University1

Id=1和Id=2變成了兩組。

解決問題

解決問題方式有幾種。

第一種

最簡單，就是直接將StudentKey從class變成struct。

但是這樣有個問題，class是堆內(nèi)存，struct是棧內(nèi)存。

雖然實際情況不一定會出現(xiàn)內(nèi)存異常什么的，但是總歸是改變了一些東西，存在隱患。

第二種

第一種方式被我自己否決后，于是打開了Google搜了一下，在StackOverflow和MSDN以及查看GroupBy源碼之后，得到了GroupBy的運行原理。

GroupBy在沒有傳comparer的時候，會創(chuàng)建一個基于當(dāng)前TSource類型的默認(rèn)的comparer。

但不管是默認(rèn)的comparer還是我們自己傳的comparer，都會調(diào)用Equals和GetHashCode兩個方法，所以我們需要重載這兩個方法。

第二種方法就是我們在類型上重載Equals和GetHashCode兩個方法。

可以實現(xiàn)IEquatable<TKey>使用下面的代碼，也可以不實現(xiàn)接口，使用重載的Equals方法。

但是不論如何，一定要重載GetHashCode。

修改后StudentKey如下

class StudentKey : IEquatable<StudentKey>
{
  public int Age { get; set; }
  public string Class { get; set; }

  public override int GetHashCode()
  {
    return Age.GetHashCode() ^ Class.GetHashCode();
  }
  
//      public override bool Equals(object obj)
//      {
//        var model = obj as StudentKey;
//        if (model == null)
//        {
//          return false;
//        }
//
//        return model.Age == Age && model.Class == Class;
//      }

  public bool Equals(StudentKey other)
  {
    return Age == other.Age && Class == other.Class;
  }
}

第三種

第三種就是傳一個comparer給GroupBy參數(shù)，實現(xiàn)一個IEqualityComparer<TKey>。

代碼如下：

list.GroupBy(m => new StudentKey {Age = m.Age, Class = m.Class}, new StudentKeyComparer());

......

class StudentKeyComparer: IEqualityComparer<StudentKey>
{
  public bool Equals(StudentKey x, StudentKey y)
  {
    return x.Age == y.Age && x.Class == y.Class;
  }

  public int GetHashCode(StudentKey obj)
  {
    return obj.Age.GetHashCode() ^ obj.Age.GetHashCode();
  }
}

這種相對于第二種方式，最大的區(qū)別在于不用侵入實體類添加代碼，但是原理是類似的。

總結(jié)

本文是在c#開發(fā)過程中碰到的一個GroupBy的分組的Key失效的問題。

了解其分組原理后，通過實現(xiàn)Equals和GetHashCode或者傳入自定義的comparer，解決GroupBy的分組Key失效的問題。

好了，以上就是這篇文章的全部內(nèi)容了，希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，如果有疑問大家可以留言交流，謝謝大家對我們的支持。