在前端开发中,我们经常需要从多个表中查询数据以实现特定的功能。而 Django REST framework 是一种流行的框架,可以无缝地将 Django 和 RESTful API 结合起来。
本文将介绍如何使用 Django REST framework 实现多表关联查询。我们将通过一个示例项目来演示如何从数据库中查询数据,以及如何使用 Django REST framework 将数据返回给前端。
示例项目介绍
我们将创建一个博客应用程序,包括四个模型:
Author
:作者Blog
:博客文章Tag
:标签Comment
:评论
每篇博客文章都有一个作者,可能有多个标签,也可能有多个评论。我们将使用 Django 的内置 ORM 来管理这些数据,并使用 Django REST framework 来公开它们,以便前端应用程序可以查询和操作这些数据。
数据库模型
首先,我们需要定义数据库模型。在 models.py
文件中,我们将创建四个模型:
-- -------------------- ---- ------- ---- --------- ------ ------ ----- --------------------- ---- - -------------------------------- ----- - ------------------- --- -------------- ------ --------- ----- ------------------ ---- - ------------------------------- --- -------------- ------ --------- ----- ------------------- ----- - -------------------------------- ------- - ------------------ -------- - --------------------------------------- ------ - ------------------------- ------------------------- --------------------- ---- - --------------------------- --------------------- --- -------------- ------ ---------- ----- ---------------------- ---- - -------------------------------- ----- - ------------------- ------- - ------------------ -------- - --------------------------------------- ---- - ----------------------- ------------------------- ------------------------ --- -------------- ------ ------------
Author
、Tag
、Blog
和 Comment
都是用 models.Model
表示的 Django 模型,每个模型都有若干字段。模型之间的关系可以用 ForeignKey(多对一关系)、ManyToManyField(多对多关系)或 OneToOneField(一对一关系)来表示。
Blog
模型是最复杂的模型。每篇博客文章都有一个标题、正文和发布时间。此外,它还有一个 ForeignKey
到 Author
模型,表示文章的作者。每篇文章可能有多个标签,因此我们使用 ManyToManyField
来表示这种关系。最后,我们还定义了一对多关系,每篇文章可以有多个评论。
序列化器
Django REST framework 的核心是序列化器。序列化器将模型实例转换为 JSON 等格式,以便跨越网络传输。
在 serializers.py
文件中,我们将定义四个序列化器:
-- -------------------- ---- ------- ---- -------------- ------ ----------- ---- ------- ------ ------- ---- ----- ------- ----- ---------------------------------------------- ----- ----- ----- - ------ ------ - --------- ----- ------------------------------------------- ----- ----- ----- - --- ------ - --------- ----- -------------------------------------------- ------ - ------------------ ---- - ------------------------ ----- ----- ----- - ---- ------ - --------- ----- ----------------------------------------------- ----- ----- ----- - ------- ------ - ---------
AuthorSerializer
、TagSerializer
和 CommentSerializer
都非常简单,只是将模型的所有字段序列化为 JSON 对象。
BlogSerializer
更加复杂。我们不仅需要序列化博客文章的所有字段,还需要在 JSON 中包含博客作者和标签的信息。为此,我们使用 AuthorSerializer
和 TagSerializer
来序列化作者和标签,然后将它们作为 author
和 tags
字段嵌入到 BlogSerializer
中。
视图
现在我们可以将 Django 模型序列化为 JSON,但如何将 JSON 返回给前端?这就是 Django REST framework 视图的作用。
在 views.py
文件中,我们将定义四个视图:
-- -------------------- ---- ------- ---- -------------- ------ -------- ---- ------- ------ ------- ---- ----- ------- ---- ------------ ------ ----------------- -------------- --------------- ----------------- ----- --------------------------------------- -------- - -------------------- ---------------- - ---------------- ----- ---------------------------------------------------- -------- - -------------------- ---------------- - ---------------- ----- ------------------------------------ -------- - ----------------- ---------------- - ------------- ----- ------------------------------------------------- -------- - ----------------- ---------------- - ------------- ----- ------------------------------------- -------- - ------------------ ---------------- - -------------- ----- -------------------------------------------------- -------- - ------------------ ---------------- - -------------- ----- ---------------------------------------- -------- - --------------------- ---------------- - ----------------- ----- ----------------------------------------------------- -------- - --------------------- ---------------- - -----------------
AuthorList
、TagList
、BlogList
和 CommentList
视图是查询所有模型实例的列表视图。AuthorDetail
、TagDetail
、BlogDetail
和 CommentDetail
视图是查询特定模型实例的详细视图。
在视图中,我们指定了查询集和序列化器,并指定在增删改查操作中使用哪个 HTTP 方法。例如,我们使用 GET 方法在列表视图中检索数据。使用 POST 方法在创建新对象时使用。
多表关联查询
现在所有元素已在其各自的数据库中设置和呈现, 对于博客列表视图中,我们需要返回的是从多个模型中获取的联合信息。
我们可以使用 Django REST Framework 序列化器中的嵌套序列化器功能, 来处理不同表格之间的关系, 以构建相应的JSON对象。
我们将在下面的BlogList
和BlogDetail
视图中接受 GET 请求时使用多表联接序列化程序创建JSON对象。 该操作只需要创建一个名为 BlogListSerializer
的新序列化程序,它将继承默认 BlogSerializer
并使用作者和标签嵌套序列化器来补充详细信息。
class BlogListSerializer(BlogSerializer): author = serializers.StringRelatedField() tags = TagSerializer(many=True) class Meta: model = Blog fields = ['id', 'title', 'author', 'tags']
BlogListSerializer
将博客文章的 id
、title
、author
和 tags
字段包含在 JSON 对象中。为了显示作者和标签的完整信息,我们使用 StringRelatedField
和 TagSerializer
嵌套序列化器。
现在我们可以更新 BlogList
视图,以便在 GET 请求中使用 BlogListSerializer
。修改后的 views.py
如下所示:
class BlogList(generics.ListCreateAPIView): queryset = Blog.objects.all() serializer_class = BlogListSerializer
如果运行此应用程序, 那么当请求博客列表时, 我们会看到以下JSON对象返回
-- -------------------- ---- ------- - - ----- -- -------- --- ----- ------ --------- ----- ----- ------- - - ----- -- ------- -------- -- - ----- -- ------- ---- ------------ - - -- - ----- -- -------- --- ------ ------ --------- ----- ------- ------- - - ----- -- ------- ---- ------------ -- - ----- -- ------- -------- - - - -
JSON对象中, 作者姓的详细信息和标签都包含在博客对象中。
对于博客详细视图,我们将使用 BlogSerializer
。新 views.py
如下所示:
class BlogDetail(generics.RetrieveUpdateDestroyAPIView): queryset = Blog.objects.all() serializer_class = BlogSerializer
结论
在本文中,我们使用 Django REST framework 开发了一个博客应用程序,演示了如何在 Django 中定义模型,并使用序列化器将 Django 模型转换为 JSON。我们还演示了如何使用 Django REST framework 视图在 RESTful API 上公开这些数据。
我们还在博客列表视图和博客详细视图中演示了如何使用嵌套序列化器来实现多表关联查询,以查询并返回有关博客作者和标签的详细信息。
正如我们在本文中看到的,Django REST framework 为 Django 开发人员提供了极大的灵活性,使得我们能够快速而轻松地构建功能强大的 RESTful API。
如果您对此感兴趣,那么我们鼓励您深入研究 Django REST framework 并尝试自己构建一些自己的项目!
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/670b9a7266ef9cf37faa732b