Django REST framework视图集与路由详解：深入理解ViewSet、ModelViewSet与路由映射器

2024-06-17 07:36
文章标签 详解 django 路由 深入 理解 framework 图集 rest viewset 映射器 modelviewset

本文主要是介绍Django REST framework视图集与路由详解：深入理解ViewSet、ModelViewSet与路由映射器，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

在这里插入图片描述

系列文章目录

  • Django入门全攻略：从零搭建你的第一个Web项目
  • Django ORM入门指南：从概念到实践，掌握模型创建、迁移与视图操作
  • Django ORM实战：模型字段与元选项配置，以及链式过滤与QF查询详解
  • Django ORM深度游：探索多对一、一对一与多对多数据关系的奥秘与实践
  • 跨域问题与Django解决方案：深入解析跨域原理、请求处理与CSRF防护
  • Django视图层探索：GET/POST请求处理、参数传递与响应方式详解
  • Django路由与会话深度探索：静态、动态路由分发，以及Cookie与Session的奥秘
  • Django API开发实战：前后端分离、Restful风格与DRF序列化器详解
  • Django REST framework序列化器详解：普通序列化器与模型序列化器的选择与运用
  • Django REST framework关联序列化器详解：掌握复杂关系的序列化与反序列化艺术
  • Django REST framework中GenericAPIView与混入扩展类详解
  • Django REST framework视图集与路由详解：深入理解ViewSet、ModelViewSet与路由映射器
  • 还在写0.0…

文章目录

  • 系列文章目录
  • 前言
  • 一、ViewSet
    • 1. 视图集是什么
    • 2. action 是什么
    • 3. 视图集功能实现及路由映射
  • 二、ModelViewSet
    • 1. 混入类的视图集概念
    • 2. ModelViewSet视图集功能及路由映射
    • 3. 视图集自定义功能及路由映射
  • 三、DRF路由映射
    • 1. DefaultRouter路由生成
    • 2. SimpleRouter路由生成
    • 3. 两种路由生成方式区别及根路由是什么

前言

    在Django REST framework（DRF）的世界里，ViewSet和ModelViewSet是两大基石，它们为开发者提供了简洁、高效的方式来构建API视图。与此同时，DefaultRouter和SimpleRouter作为路由映射的利器，为API提供了清晰的访问路径。

    本文将带你深入了解ViewSet和ModelViewSet的概念、功能及用法，并解析DefaultRouter与SimpleRouter的区别。

一、ViewSet

1. 视图集是什么

在DRF中，ViewSet 是一种将多个视图逻辑整合到一个类中的方式。它不再像传统的Django视图那样使用 get(), post(), put(), delete() 等方法来处理HTTP请求，而是定义一系列Action动作（如 list(), retrieve(), create(), update(), destroy() 等）来处理不同的HTTP请求。

视图集 简单来说就是一群视图逻辑操作的功能合集，并可采用 路由映射 的方式进行功能选择，编写的内置逻辑方法不再是使用请求命名，而是使用功能来进行命名。

2. action 是什么

视图集类不再实现 get 、post 等方法，而是实现动作 action 如 list 、create 等，视图集 只在使用 as_view 方法的时候，才会将 action 动作与具体请求方式对应上

例如，下面编写的最基本的视图集：

# views.py
from django.contrib.auth.models import User
from myapps.serializers import UserSerializer
from rest_framework import viewsets
from rest_framework.response import Response
class UserViewSet(viewsets.ViewSet):"""A simple ViewSet for listing or retrieving users."""def list(self, request):queryset = User.objects.all()serializer = UserSerializer(queryset, many=True)return Response(serializer.data)def retrieve(self, request, pk=None):queryset = User.objects.all()user = get_object_or_404(queryset, pk=pk)serializer = UserSerializer(user)return Response(serializer.data)

3. 视图集功能实现及路由映射

视图集的路由映射不是之前的直接 as_view，还要采取对应请求进行映射

# urls.py
path('userlist/', UserViewSet.as_view({'get': 'list'})),
path('userdetail/', UserViewSet.as_view({'get': 'retrieve'})

ViewSet视图集类不再实现get、post等方法，而是实现动作 action 如 list、createl 等。使用视图集ViewSet，可以将一系列逻朝相关的动作放到一个类中:

  • list() 提供一组数据
  • retrieve() 提供单个数据
  • create() 创建数据
  • update() 保存数据
  • destory() 删除数据

二、ModelViewSet

1. 混入类的视图集概念

在 ModelViewSet 类中继承了 GenericAPIView和各种混入类，在包括用于各种动作实现方式中，各种混入类的行为混合，包含了 .list、.retrieve、.create、.update、.partial_update、和 .destroy 等方法，继承了 ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestroyModelMixin，需要至少提供 queryset 和 serializer_class 属性

2. ModelViewSet视图集功能及路由映射

from rest_framework.viewsets import ModelViewSet
class BookModelViewSet(ModelViewSet):queryset = Book.objects.all()lookup_field = 'pk'lookup_url_kwarg = 'pk'serializer_class = BookSer

这样具备全部混入类的视图类，只要提供对应数据属性即可完成功能

路由设置：

path('modelviewset/',BookModelViewSet.as_view({'get':'list','post':'create'}
)),
path('modelviewset/<int:pk>/',BookModelViewSet.as_view({'get':'retrieve','put':'update','delete':'destroy'}
)),

3. 视图集自定义功能及路由映射

视图集自定义功能：

from rest_framework.decorators import action视图集中，通过自定义请求方式，定义方法：
@action(methods=['get'],detail=True)
def getList(self,request,pk):...return ...以action装饰器装饰的方法名会作为action动作名，与list、retrieve等同。action装饰器可以接收两个参数：
methods: 声明该action对应的请求方式，列表传递
detail:声明该action的路径是否与单一资源对应xxx/<pk>/action方法名/True 表示路径格式是`xxx/<pk>/action方法名/`
False 表示路径格式是`xxx/action方法名/

视图集中附加action的声明

  • 在视图集中，如果想要让Router自动生成我们自定义动作的路由信息，需要使用rest_framework.decorators.action装饰器
  • 以action装饰器装饰的方法名会作为action动作名，与list、retrieve等同
  • action装饰器可以接收三个参数：
    • methods: 声明该action对应的请求方式，列表
    • detail: 声明该action的路径是否与单一资源对应，True：单个数据操作，False：多个数据操作
    • url_path：声明该action的路由尾缀
# views.py
class StudentsModelView(ModelViewSet):queryset = Students.objectsserializer_class = StudentSerializers@action(methods=['get'], detail=False, url_path='login')def login(self, request):"""登录"""return Response({'message': '成功！！'})

路由文件如下：

from rest_framework.routers import DefaultRouterfrom . import views# 实例化路由类
router = DefaultRouter()# 注册视图集
router.register('students', views.StudentsModelView)# 将生成的路由集添加到urlpatterns中
urlpatterns = []
urlpatterns += router.urls

访问方式如下：
http://127.0.0.1:8000/app/students/login/

三、DRF路由映射

对于视图集ViewSet，我们除了可以自己 手动指明请求方式与动作action之间的对应关系 外，还可以 使用drf所提供的路由功能Routers 来帮助我们快速实现路由信息，更加的方便快捷

Routers主要分如下两种：

  • DefaultRouter
  • SimpleRouter

1. DefaultRouter路由生成

在Django REST framework（DRF）中，DefaultRouter 是 routers 模块提供的一个类，它用于自动为你的应用中的视图集（ViewSets）生成URL模式。使用 DefaultRouter 可以极大地简化URL配置的复杂性，特别是当你的应用包含多个与资源相关的视图集时。

DefaultRouter 为每个视图集自动生成以下URL模式：

  • 列表视图（list view）：返回资源对象列表
  • 详情视图（detail view）：返回单个资源对象
  • 创建视图（create view）：创建新的资源对象
  • 更新视图（update view）：更新现有的资源对象
  • 删除视图（delete view）：删除资源对象

比如我们编写一个视图集，具备有全部功能，采用ModelViewSet

#views.py
class BookModelViewSet(ModelViewSet):serializer_class = BookSerializerqueryset = Book.objects.all()
  • 注册路由
#urls.py
from rest_framework import routers
# 1.实例化路由对象
router = routers.DefaultRouter() 
# 2.注册生成路由
router.register('book', BookModelViewSet)
# 3.添加路由
urlpatterns += router.urls
  • 此时生成的路由
app/ ^actions/$ [name='studentmodel-list']
app/ ^actions\.(?P<format>[a-z0-9]+)/?$ [name='studentmodel-list']
app/ ^actions/(?P<id>[^/.]+)/$ [name='studentmodel-detail']
app/ ^actions/(?P<id>[^/.]+)\.(?P<format>[a-z0-9]+)/?$ [name='studentmodel-detail']
app/ [name='api-root']
app/ <drf_format_suffix:format> [name='api-root']
  • 我们看到中间还多了一些路由，是带有format正则匹配的，这些是用来获取纯粹json格式数据
app/ ^actions\.(?P<format>[a-z0-9]+)/?$ [name='studentmodel-list']app/ ^actions/(?P<id>[^/.]+)\.(?P<format>[a-z0-9]+)/?$ [name='studentmodel-detail']app/ <drf_format_suffix:format> [name='api-root']
  • 比如直接通过浏览器访问接口地址，默认会返回DRF所提供的页面，但是此时数据被解析成了text/html格式，如果希望得到纯粹的json格式，那么可以利用上面DefaultRouter路由生成的新路由，直接访问如下连接，看到的就是直接的json格式返回，而不是html标签格式
http://127.0.0.1:8000/app/actions.json
#app/ ^actions\.(?P<format>[a-z0-9]+)/?$ [name='studentmodel-list']
  • 注意，除了使用urlpatterns进行路由拼接，还可使用include进行路由分发也是可以的
path('', include(router.urls)),

2. SimpleRouter路由生成

在Django REST framework（DRF）中，SimpleRouter 是 routers 模块提供的一个类，用于为视图集生成路由URL,它是一个简单的路由，为视图集生成标准的URL模式，且不会添加额外的API根视图等，与 DefaultRouter 相比，它更加简洁，只关注于基本的URL生成功能。

  • 注册路由
from rest_framework import routers
# 1.实例化路由对象
router = routers.SimpleRouter()
# 2.注册生成路由
router.register('actions', IndexActinosView, basename='actions')
# 3.添加路由
urlpatterns += router.urls
  • 创建好的路由如下所示，虽然你只看到两条路由
    但其实每一条路由后面都映射了可以保留的请求方式及action的映射
app/ ^actions/$ [name='studentmodel-list']
#包含：获取列表get，创建一条信息post
app/ ^actions/(?P<id>[^/.]+)/$ [name='studentmodel-detail']
#包含：获取一条信息get，更新一条信息put，删除一条信息delete
  • 路由对象register方法参数介绍
# 1.实例化路由对象
router = routers.SimpleRouter()
# 2.注册生成路由
router.register('路由命名', 视图集, basename='路由名称前缀')

3. 两种路由生成方式区别及根路由是什么

  • SimpleRouter：最基本的路由映射方式，只会将视图集具备的混入类功能进行路由的生成
  • DefaultRouter：对比与SimpleRouter更加高级，包含有drf根页面的路由，不只是视图集所包含的视图部分
  • 根路由是一个特殊的路由，用于处理对网站根目录的请求，并通常列出所有可用的API端点。

根路由定义：
根路由 通常是一个特殊的路由，它位于路由系统的最顶层，用于处理对网站根目录（如/）的请求。在Django REST framework中，使用DefaultRouter时，会自动生成一个根路由，该路由会列出所有可用的API端点。这使得开发者能够方便地查看和理解API的结构。

在这里插入图片描述

这篇关于Django REST framework视图集与路由详解：深入理解ViewSet、ModelViewSet与路由映射器的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1068830。

相关文章

MySQL中的分组和多表连接详解

MySQL中的分组和多表连接详解

《MySQL中的分组和多表连接详解》：本文主要介绍MySQL中的分组和多表连接的相关操作,本文通过实例代码给大家介绍的非常详细,感兴趣的朋友一起看看吧... 目录mysql中的分组和多表连接一、MySQL的分组（group javascriptby ）二、多表连接（表连接会产生大量的数据垃圾）MySQL中的
阅读更多...
Java 实用工具类Spring 的 AnnotationUtils详解

Java 实用工具类Spring 的 AnnotationUtils详解

《Java实用工具类Spring的AnnotationUtils详解》Spring框架提供了一个强大的注解工具类org.springframework.core.annotation.Annot... 目录前言一、AnnotationUtils 的常用方法二、常见应用场景三、与 JDK 原生注解 API 的
阅读更多...
redis中使用lua脚本的原理与基本使用详解

redis中使用lua脚本的原理与基本使用详解

《redis中使用lua脚本的原理与基本使用详解》在Redis中使用Lua脚本可以实现原子性操作、减少网络开销以及提高执行效率,下面小编就来和大家详细介绍一下在redis中使用lua脚本的原理... 目录Redis 执行 Lua 脚本的原理基本使用方法使用EVAL命令执行 Lua 脚本使用EVALSHA命令
阅读更多...
SpringBoot3.4配置校验新特性的用法详解

SpringBoot3.4配置校验新特性的用法详解

《SpringBoot3.4配置校验新特性的用法详解》SpringBoot3.4对配置校验支持进行了全面升级,这篇文章为大家详细介绍了一下它们的具体使用,文中的示例代码讲解详细,感兴趣的小伙伴可以参考... 目录基本用法示例定义配置类配置 application.yml注入使用嵌套对象与集合元素深度校验开发
阅读更多...
Python中的Walrus运算符分析示例详解

Python中的Walrus运算符分析示例详解

《Python中的Walrus运算符分析示例详解》Python中的Walrus运算符（:=）是Python3.8引入的一个新特性,允许在表达式中同时赋值和返回值,它的核心作用是减少重复计算,提升代码简... 目录1. 在循环中避免重复计算2. 在条件判断中同时赋值变量3. 在列表推导式或字典推导式中简化逻辑
阅读更多...
Java Stream流使用案例深入详解

Java Stream流使用案例深入详解

《JavaStream流使用案例深入详解》：本文主要介绍JavaStream流使用案例详解,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录前言1. Lambda1.1 语法1.2 没参数只有一条语句或者多条语句1.3 一个参数只有一条语句或者多
阅读更多...
SpringBoot整合mybatisPlus实现批量插入并获取ID详解

SpringBoot整合mybatisPlus实现批量插入并获取ID详解

《SpringBoot整合mybatisPlus实现批量插入并获取ID详解》这篇文章主要为大家详细介绍了SpringBoot如何整合mybatisPlus实现批量插入并获取ID,文中的示例代码讲解详细... 目录【1】saveBATch(一万条数据总耗时：2478ms)【2】集合方式foreach(一万条数
阅读更多...
Python装饰器之类装饰器详解

Python装饰器之类装饰器详解

《Python装饰器之类装饰器详解》本文将详细介绍Python中类装饰器的概念、使用方法以及应用场景,并通过一个综合详细的例子展示如何使用类装饰器,希望对大家有所帮助,如有错误或未考虑完全的地方,望不... 目录1. 引言2. 装饰器的基本概念2.1. 函数装饰器复习2.2 类装饰器的定义和使用3. 类装饰
阅读更多...
MySQL 中的 JSON 查询案例详解

MySQL 中的 JSON 查询案例详解

《MySQL中的JSON查询案例详解》：本文主要介绍MySQL的JSON查询的相关知识,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录mysql 的 jsON 路径格式基本结构路径组件详解特殊语法元素实际示例简单路径复杂路径简写操作符注意MySQL 的 J
阅读更多...
Python ZIP文件操作技巧详解

Python ZIP文件操作技巧详解

《PythonZIP文件操作技巧详解》在数据处理和系统开发中,ZIP文件操作是开发者必须掌握的核心技能,Python标准库提供的zipfile模块以简洁的API和跨平台特性,成为处理ZIP文件的首选... 目录一、ZIP文件操作基础三板斧1.1 创建压缩包1.2 解压操作1.3 文件遍历与信息获取二、进阶技
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2