Django REST Framework(十三)视图集-GenericViewSet

Django REST Framework 中,`ModelViewSet` 和 `ReadOnlyModelViewSet` 提供了快速实现常见视图操作的便捷方法。它们分别继承自 `GenericViewSet` 并组合了多个 Mixin 类,使得视图的编写变得更加简单。

ModelViewSet

ModelViewSet` 继承自 `GenericViewSet`,同时包括了以下 Mixin 类:

  • `ListModelMixin`:提供 `list` 方法,用于获取对象列表。

  • `RetrieveModelMixin`:提供 `retrieve` 方法,用于获取单个对象。

  • `CreateModelMixin`:提供 `create` 方法,用于创建新对象。

  • `UpdateModelMixin`:提供 `update` 方法,用于更新对象。

  • `DestroyModelMixin`:提供 `destroy` 方法,用于删除对象。

这样,`ModelViewSet` 提供了完整的 CRUD(创建、读取、更新、删除)操作。```python

python 复制代码
from rest_framework.viewsets import ModelViewSet
from .models import Book
from .serializers import BookSerializer

class BookView(ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer

ReadOnlyModelViewSet

`ReadOnlyModelViewSet` 继承自 `GenericViewSet`,同时包括了以下 Mixin 类:

  • `ListModelMixin`:提供 `list` 方法,用于获取对象列表。

  • `RetrieveModelMixin`:提供 `retrieve` 方法,用于获取单个对象。

这样,`ReadOnlyModelViewSet` 仅提供读取操作(列表和详细信息),而不提供创建、更新和删除操作。

python 复制代码
from rest_framework.viewsets import ReadOnlyModelViewSet
from .models import Book
from .serializers import BookSerializer

class BookReadOnlyView(ReadOnlyModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer

视图和 URL 配置

视图

对于 `ModelViewSet`:

python 复制代码
from rest_framework.viewsets import ModelViewSet
from .models import Book
from .serializers import BookSerializer

class BookView(ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer

对于 `ReadOnlyModelViewSet`:

python 复制代码
from rest_framework.viewsets import ReadOnlyModelViewSet
from .models import Book
from .serializers import BookSerializer

class BookReadOnlyView(ReadOnlyModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer

URLs:

使用 `ModelViewSet` 配置 URL:

python 复制代码
from django.urls import path, include
from rest_framework.routers import DefaultRouter
from .views import BookView

router = DefaultRouter()
router.register(r'books', BookView)

urlpatterns = [
    path('', include(router.urls)),
]

使用 `ReadOnlyModelViewSet` 配置 URL:

python 复制代码
from django.urls import path, include
from rest_framework.routers import DefaultRouter
from .views import BookReadOnlyView

router = DefaultRouter()
router.register(r'books', BookReadOnlyView)

urlpatterns = [
    path('', include(router.urls)),
]

详细解释

  1. ModelViewSet :通过组合多个 Mixin 类,提供了完整的 CRUD 功能。继承 `ModelViewSet` 的视图类只需定义 `queryset` 和 `serializer_class`。

  2. ReadOnlyModelViewSet :仅提供读取功能,适用于只需要查看数据而不需要修改数据的场景。继承 `ReadOnlyModelViewSet` 的视图类也只需定义 `queryset` 和 `serializer_class`。

  3. queryset 属性定义了视图集将使用的查询集。在上述示例中,`BookView` 和 `BookReadOnlyView` 将使用 `Book` 模型的所有对象。

  4. serializer_class 属性定义了视图集将使用的序列化器类。在上述示例中,`BookView` 和 `BookReadOnlyView` 将使用 `BookSerializer`。

  5. DefaultRouter:Django REST Framework 提供的一个简单路由器,自动为视图集生成 URL 路由。

通过上述配置,使用 `ModelViewSet` 和 `ReadOnlyModelViewSet` 可以大大简化视图的编写过程,避免重复代码,并提高代码的可维护性和可读性。

相关推荐
步行cgn1 分钟前
MyBatis 多参数绑定错误:Parameter 'name' not found 详解与解决方案
后端
步行cgn5 分钟前
MyBatis 对单个简单类型参数的默认处理详解
后端
吃饱了得干活6 分钟前
Java并发安全:看这一篇就懂了!
java·后端·面试
早点睡9756 分钟前
向量检索原理入门:从 ANN 到 HNSW
后端·面试
Augustzero8 分钟前
为什么高性能调度器都在“偷任务”?从无锁队列看懂工作窃取
c++·后端
Leo28211 分钟前
异步任务链路如何不断链:基于 OpenTelemetry 的 Trace 设计
后端
技术长镜头14 分钟前
别再死记 Record、Gap、Next-Key:沿一条 SQL 看懂 InnoDB 锁
后端·mysql
晚安code15 分钟前
Java四大函数式接口一篇讲透:配上Stream流式计算处理集合
后端
我要两颗404西柚21 分钟前
2【python】:常用关键字,函数,方法
python
COOLMO研究AI24 分钟前
Python 如何给 AI API 实现断路器模式:防止雪崩与保护本地服务
人工智能·python·php