如何制作 Django 模型 "commentable"、"likeable" 和 "rateable"

Question

我正在为一个项目使用 Django 2.0.8 和 Python 3.5。我的项目中有不同的模型，我希望允许对其中一些模型进行评论 - 对象（例如博文）和对博文的评论都很讨人喜欢。

我正在使用 threaded comments django app 来提供评论功能。

假设我有一个模型 Foo（见下文）：

from django.db import models
from django.conf import settings

class Foo(models.Model):
    owner = models.ForeignKey(settings.AUTH_USER_MODEL, blank=False, null=False, default=1, on_delete = models.PROTECT)
    # ...


class Likeable():
    pass

class Rateable():
    pass

我如何使用 mixins（或与此相关的任何其他机制）来制作对象 Foo "commentable"（即可以评论的对象），"likeable"（即对象可以评论）和 "rateable"（即可以评价的对象？）- 请记住，对对象的评论可能既被喜欢又被评价。

Answer 1

根据文档，django-contrib-comments 应用程序使用了 GenericForeignKey，这意味着它自己的模型可以创建与项目中任何其他模型的关系。

一个简单的解决方案是复制现有的功能，基于相同的概念创建您自己的 Like/Rate 应用程序（即将 Like/Rate 模型存储在该应用程序的模型中）。

我认为您可以从分叉 https://github.com/django/django-contrib-comments 代码库开始。

（我假设您已经搜索过但未能找到已经存在的应用程序）。

Answer 2

根据 django documentation ，您可以使用 内容类型框架 实现此目的。 ContentType 是一个通用模型，它允许您使用它们的 app_label、model_name 和 pk 跟踪包含在 INSTALLED_APPS 中的所有模型。它的工作方式很简单：

您的通用 `Comment` 型号

from django.db import models
from django.contrib.contenttypes.fields import GenericForeignKey
from django.contrib.contenttypes.models import ContentType
from django.conf import settings


class Comment(models.Model):
    # Generic relation fields
    content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE)
    object_id = models.PositiveIntegerField()
    content_object = GenericForeignKey('content_type', 'object_id')
    # Model specific fields
    author = models.ForeignKey(
        settings.AUTH_USER_MODEL,
        on_delete=models.CASCADE
    )
    comment = models.TextField()
    created = models.DatetimeField(auto_now_add=True)
    # ...

您的可重用通用关系模型。最好的方法是使用抽象模型类或混合。例如，使用抽象模型：

from django.db import models
from django.contrib.contenttypes.fields import GenericRelation


class Commentable(models.Model):
    comments = GenericRelation(Comment)

    class Meta:
        abstract = True

您的`Commentable`模特：

from django.db import models


class Foo(Commentable, Likeable, ...):
    # your stuff

使用方法：

# Add a new comment to Foo
foo = new Foo()
foo.save()
foo.comments.create(author=author, comment="Your comment")

# Retrieve all comments from an specific user no matter the base model
comments = Comment.objects.filter(author=author)

编辑正如@ozren1983 所说，每种方法都有其缺点，但这是标准方法。

主要优点有：

您可以在一个查询中检索在所有 commentable 模型中做出的所有评论（例如）。使用对每个模型进行评论等 table 的方法，您需要为每个模型连接一个查询。例如，如果您有很多模型，或者如果您想要合并结果并对其进行排序，这可能会出现问题并且有点挑战。
每个功能（评论、点赞）只有一个 table 意味着只有一次数据库迁移以防发生变化。如果您的数据库很大，这可能是关键。

主要缺点是缺乏对数据库中这种通用关系的完整性检查。但是如果你打算使用 django ORMstrictly，什么都不应该被破坏。

奖励： 许多项目使用的另一种方法是从称为 Item 或 Thread 的特定模型继承模型（一对一关系）。然后，您可以将所有评论、喜欢等功能添加到该模型中。这称为多table 继承。一个例子：

from django.db import models


class Thread(models.Model):
    pass

class Comment(models.Model):
    # Relation with thread
    thread = models.ForeignKey(
        Thread,
        on_delete=models.CASCADE,
        related_name="comments"
    )
    # Model specific fields
    author = models.ForeignKey(
        settings.AUTH_USER_MODEL,
        on_delete=models.CASCADE
    )
    comment = models.TextField()
    created = models.DatetimeField(auto_now_add=True)
    # ...

class Foo(Thread):
    pass

与使用通用关系不同，此方法的主要优势在于，通过这种方式，您可以进行数据库完整性检查。

主要缺点是您的数据库结构可能会变得复杂。

Answer 3

根据我在 Two scoops of Django 中的经验和建议，我建议不要使用 GenericForeignKey 和 GenericRelation。这种方法的两大缺点是：

慢查询
数据损坏的危险

相反，我会使用以下方法。假设您有 3 个模型：

class User(models.Model):
    username = models.CharField(max_length=255)

class Author(models.Model):
    name = models.CharField(max_length=255)

class Post(models.Model):
    title = models.CharField(max_length=255)
    author = models.ForeignKey(Author)

添加抽象 Like 模型，并将其用作将实现喜欢功能的其他模型的基础 class。

class Like(models.Model):
    user = models.ForeignKey(User)
    date_created = models.DateTimeField(auto_now_add=True)

    class Meta:
        abstract = True

class AuthorLike(Like):
    author = models.ForeignKey(Author)

class PostLike(Like):
    post = models.ForeignKey(Post)

类似地，添加抽象Rating模型并将其用作基础class:

class Rating(models.Model):
    user = models.ForeignKey(User)
    rate = models.PositiveSmallIntegerField()
    date_created = models.DateTimeField(auto_now_add=True)

    class Meta:
        abstract = True

class AuthorRating(Rating):
    author = models.ForeignKey(Author)

class PostRating(Rating):
    post = models.ForeignKey(Post)

您可以使用相同的方法对您正在使用的评论模型进行点赞和评分：

from threadedcomments.models import ThreadedComment

class ThreadedCommentRating(Rating):
    threadedcomment = models.ForeignKey(ThreadedComment)

class ThreadedCommentLike(Like):
    threadedcomment = models.ForeignKey(ThreadedComment)

如何制作 Django 模型 "commentable"、"likeable" 和 "rateable"

How to make a django model "commentable", "likeable" and "rateable"

python

django

mixins

您的通用 `Comment` 型号

您的可重用通用关系模型。最好的方法是使用抽象模型类或混合。例如，使用抽象模型：

您的`Commentable`模特：

使用方法：

如何制作 Django 模型 "commentable"、"likeable" 和 "rateable"

How to make a django model "commentable", "likeable" and "rateable"

python

django

mixins

您的通用 Comment 型号

您的可重用通用关系模型。最好的方法是使用抽象模型 类 或混合。例如，使用抽象模型：

您的Commentable模特：

使用方法：

您的通用 `Comment` 型号

您的可重用通用关系模型。最好的方法是使用抽象模型类或混合。例如，使用抽象模型：

您的`Commentable`模特：