C# GroupBy的基本使用教程

起因

今天在公司做一个需求的时候，写的是面条代码，一个方法直接从头写到尾，其中用到了groupby，且groupby的keyselector是多个属性而不是单个属性。

但是公司最近推行clean code，要让代码有可读性。且作为一个有追求的程序员，肯定是不能写面条代码的，要对代码进行拆分。

重构前groupby大概是这样子的：

var groups = data.groupby(m => new { m.propertya, m.propertyb})

个人对于短的linq比较习惯于用方法而不是用关键字的那种写法。

一开始这样写是没问题的，但是重构的时候问题就来了：这个groups是什么类型？

重构以后这个groups是要作为参数进入到别的方法中的，方法签名显然是不能用var做类型推导，必须指定确定的类型。

我们知道groupby出来的东西是个泛型的东西，签名是ienumerable<igrouping<tkey, tsource>>，这个tsource类型是没问题，我没有对source做修改，就是data本身的类型。

但是这个key就有问题了。

我没有指定key的类型，这里应该是匿名类型，于是定义了一个类型承接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});

但是后来我发现这样有问题，groupby指定的key失效了。也就是说，groups的分组数量与data的长度一致，每一个group里面只有一个对象。

分析

发现这个问题后，我仔细思考了一下，大致猜到了问题出在哪里。

groupby这种东西，判断两个对象是不是一个分组，必然用到了相等判断。

虽然我没有看匿名类型反编译生成后的il代码，不知道之前用的是怎么做的key相等判断，但是引用类型的肯定是直接用对象的hashcode做判断。

这样子肯定是不行的，要解决引用类型的相等判断问题。

重现

根据猜测，我写了一个sample程序最小化的重现了这个问题：

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; }
 }
}

这时候输出结果是

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}，结果却变成了

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是堆内存，struct是栈内存。

虽然实际情况不一定会出现内存异常什么的，但是总归是改变了一些东西，存在隐患。

第二种

第一种方式被我自己否决后，于是打开了google搜了一下，在*和msdn以及查看groupby源码之后，得到了groupby的运行原理。

groupby在没有传comparer的时候，会创建一个基于当前tsource类型的默认的comparer。

但不管是默认的comparer还是我们自己传的comparer，都会调用equals和gethashcode两个方法，所以我们需要重载这两个方法。

第二种方法就是我们在类型上重载equals和gethashcode两个方法。

可以实现iequatable<tkey>使用下面的代码，也可以不实现接口，使用重载的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参数，实现一个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();
  }
}

这种相对于第二种方式，最大的区别在于不用侵入实体类添加代码，但是原理是类似的。

总结

本文是在c#开发过程中碰到的一个groupby的分组的key失效的问题。

了解其分组原理后，通过实现equals和gethashcode或者传入自定义的comparer，解决groupby的分组key失效的问题。

好了，以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对的支持。