欢迎来到尧图网

客户服务 关于我们

您的位置:首页 > 健康 > 养生 > Django REST Framework(十三)视图集-GenericViewSet

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

2024/10/24 6:34:09 来源:https://blog.csdn.net/yjjpp2301/article/details/140600570  浏览:    关键词: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

from rest_framework.viewsets import ModelViewSet
from .models import Book
from .serializers import BookSerializerclass BookView(ModelViewSet):queryset = Book.objects.all()serializer_class = BookSerializer

ReadOnlyModelViewSet


`ReadOnlyModelViewSet` 继承自 `GenericViewSet`,同时包括了以下 Mixin 类:
- `ListModelMixin`:提供 `list` 方法,用于获取对象列表。
- `RetrieveModelMixin`:提供 `retrieve` 方法,用于获取单个对象。

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

from rest_framework.viewsets import ReadOnlyModelViewSet
from .models import Book
from .serializers import BookSerializerclass BookReadOnlyView(ReadOnlyModelViewSet):queryset = Book.objects.all()serializer_class = BookSerializer

视图和 URL 配置

视图

对于 `ModelViewSet`:

from rest_framework.viewsets import ModelViewSet
from .models import Book
from .serializers import BookSerializerclass BookView(ModelViewSet):queryset = Book.objects.all()serializer_class = BookSerializer

对于 `ReadOnlyModelViewSet`:

from rest_framework.viewsets import ReadOnlyModelViewSet
from .models import Book
from .serializers import BookSerializerclass BookReadOnlyView(ReadOnlyModelViewSet):queryset = Book.objects.all()serializer_class = BookSerializer

URLs:

使用 `ModelViewSet` 配置 URL:

from django.urls import path, include
from rest_framework.routers import DefaultRouter
from .views import BookViewrouter = DefaultRouter()
router.register(r'books', BookView)urlpatterns = [path('', include(router.urls)),
]

使用 `ReadOnlyModelViewSet` 配置 URL:

from django.urls import path, include
from rest_framework.routers import DefaultRouter
from .views import BookReadOnlyViewrouter = 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` 可以大大简化视图的编写过程,避免重复代码,并提高代码的可维护性和可读性。

版权声明:

本网仅为发布的内容提供存储空间,不对发表、转载的内容提供任何形式的保证。凡本网注明“来源:XXX网络”的作品,均转载自其它媒体,著作权归作者所有,商业转载请联系作者获得授权,非商业转载请注明出处。

我们尊重并感谢每一位作者,均已注明文章来源和作者。如因作品内容、版权或其它问题,请及时与我们联系,联系邮箱:809451989@qq.com,投稿邮箱:809451989@qq.com