为查询集注释排名字段的正确方法

Posted 2023-02-23

【中文标题】为查询集注释排名字段的正确方法

【英文标题】：Proper way to annotate a rank field for a queryset

【发布时间】：2019-03-15 02:21:59

【问题描述】：

假设模型如下：

class Person(models.Model):
  name = models.CharField(max_length=20)

class Session(models.Model):
  start_time = models.TimeField(auto_now_add=True)
  end_time = models.TimeField(blank=True, null=True)
  person = models.ForeignKey(Person)

class GameSession(models.Model):
  game_type = models.CharField(max_length=2)
  score = models.PositiveIntegerField(default=0, blank=True)
  session = models.ForeignKey(Session)

我想要一个查询集函数来返回每个人的总得分，这是他所有游戏得分和他在所有会话中花费的所有时间以及一个人相对于所有人的排名。如下所示：

class DenseRank(Func):
  function = 'DENSE_RANK'
  template = '%(function)s() Over(Order by %(expressions)s desc)'

class PersonQuerySet(models.query.QuerySet):
  def total_scores(self):
    return self.annotate(total_score=some_fcn_for_calculate).annotate(rank=DenseRank('total_score'))

我可以找到一种计算总分的方法，但密集排名不是我想要的，因为它只是根据当前查询集中的人计算排名，但我想计算一个人相对于所有人的排名。

我使用 django 1.11 和 postgres 10.5，请建议我找到查询集中每个人的排名的正确方法，因为我希望能够在计算 total_score 和排名之前或之后添加另一个过滤器。

【参考方案1】：

遗憾的是，这是不可能的操作，因为（对我而言）postgresql WHERE 操作（过滤/排除）会在聚合函数对其起作用之前缩小行。

我找到的唯一解决方案是使用单独的查询集简单地计算所有 Person 的排名，然后用这些结果注释您的查询集。

This answer（参见改进的方法）解释了如何“用字典中外部准备的数据注释查询集”。

这是我为您的模型所做的实现：

class PersonQuerySet(models.QuerySet):
    def total_scores(self):
        # compute the global ranking
        ranks = (Person.objects
                 .annotate(total_score=models.Sum('session__gamesession__score'))
                 .annotate(rank=models.Window(expression=DenseRank(),
                                              order_by=models.F('total_score').decs()))
                 .values('pk', 'rank'))
        # extract and put ranks in a dict
        rank_dict = dict((e['pk'], e['rank']) for e in ranks)

        # create `WHEN` conditions for mapping filtered Persons to their Rank
        whens = [models.When(pk=pk, then=rank) for pk, rank in rank_dict.items()]
        # build the query
        return (self.annotate(rank=models.Case(*whens, default=0,
                                               output_field=models.IntegerField()))
                .annotate(total_score=models.Sum('session__gamesession__score')))

我使用 Django 2.1.3 和 Postgresql 10.5 对其进行了测试，因此代码可能会稍有更改。 欢迎分享与 Django 1.11 兼容的版本！