五、Django REST framwork 的视图

最新推荐文章于 2022-01-04 14:43:40 发布

光明小学王小雨

最新推荐文章于 2022-01-04 14:43:40 发布

阅读量386

点赞数 2

分类专栏： rest_framework Django

本文链接：https://blog.csdn.net/qq_41475058/article/details/112244290

版权

Django 同时被 2 个专栏收录

46 篇文章 9 订阅

订阅专栏

rest_framework

12 篇文章 10 订阅

订阅专栏

Django REST framwork 提供的视图的主要作用：

控制序列化器的执行（检验、保存、转换数据）
控制数据库查询的执行

一、两个基类

1、APIView

rest_framework.views.APIView是REST framework提供的所有视图的基类，继承自Django的View父类。

APIView与View的不同之处在于：

 - 传入到视图方法中的是REST framework的Request对象，而不是Django的HttpRequeset对象；
 - 视图方法可以返回REST framework的Response对象，视图会为响应数据设置（render）符合前端要求的格式；
 - 任何APIException异常都会被捕获到，并且处理成合适的响应信息；
 - 在进行dispatch()分发前，会对请求进行身份认证、权限检查、流量控制。

支持定义的属性：

 - authentication_classes 列表或元组，身份认证类
 - permissoin_classes 列表或元组，权限检查类
 - throttle_classes 列表或元组，流量控制类
 - 在APIView中仍以常规的类视图定义方法来实现get() 、post() 或者其他请求方式的方法。

示例

在serializers.py中定义一个序列化器，这里使用前面讲的模型序列化器

from rest_framework import serializers
from .models import BookInfo

class BookInfoModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = BookInfo
        fields = '__all__'  # []
        # exclude =
        # read_only_fields = []
        # extra_kwargs = {'bread': {'min_value': 0, }}

views.py中定义继承APIView的视图

from rest_framework.views import APIView
from rest_framework.response import Response
from .serializers import BookInfoModelSerializer

"""以下是继承APIView的视图"""
class BookListAPIView(APIView):
    """列表视图"""

    def get(self, request):
        """查询所有"""
        qs = BookInfo.objects.all()
        serializer = BookInfoModelSerializer(instance=qs, many=True)
        # print(serializer.data)
        # response = Response(serializer.data)
        # print(response.data)  # 响应对象未渲染处理的数据
        # # print(response.content)  # 处理后要响应给前端的数据
        # return response
        return Response(serializer.data)

    def post(self, request):
        """新增"""
        # 获取前端传入的请求体数据
        data = request.data
        # 创建序列化器进行反序列化
        serializer = BookInfoModelSerializer(data=data)
        # 调用序列化器的is_valid方法进行校验
        serializer.is_valid(raise_exception=True)
        # 调用序列化器的save方法进行执行create方法
        serializer.save()
        # 响应
        return Response(serializer.data, status=status.HTTP_201_CREATED)


class BookDetailAPIView(APIView):
    """详情视图"""

    def get(self, request, pk):
        # 查询pk指定的模型对象
        try:
            book = BookInfo.objects.get(id=pk)
        except BookInfo.DoesNotExist:
            return Response(status=status.HTTP_404_NOT_FOUND)
        # 创建序列化器进行序列化
        serializer = BookInfoModelSerializer(instance=book)
        # 响应
        return Response(serializer.data)

    def put(self, request, pk):
        # 查询pk所指定的模型对象

        try:
            book = BookInfo.objects.get(id=pk)
        except BookInfo.DoesNotExist:
            return Response(status=status.HTTP_404_NOT_FOUND)
        # 获取前端传入的请求体数据
        # 创建序列化器进行反序列化
        serializer = BookInfoModelSerializer(instance=book, data=request.data)
        # 校验
        serializer.is_valid(raise_exception=True)
        # save--->update
        serializer.save()
        # 响应
        return Response(serializer.data)

    def delete(self, request, pk):
        # 查询pk所指定的模型对象
        try:
            book = BookInfo.objects.get(id=pk)
        except BookInfo.DoesNotExist:
            return Response(status=status.HTTP_404_NOT_FOUND)

        book.delete()
        return Response(status=status.HTTP_204_NO_CONTENT)

urls.py中设置路由

from django.urls import path,re_path
from . import views

urlpatterns = [
    # 列表视图的路由APIView
    re_path(r'^books/$', views.BookListAPIView.as_view()),
    # 详情视图的路由APIView
    re_path(r'^books/(?P<pk>\d+)/$', views.BookDetailAPIView.as_view()),
]

2、GenericAPIView

rest_framework.generics.GenericAPIView继承自APIVIew，主要增加了操作序列化器和数据库查询的方法，作用是为下面Mixin扩展类的执行提供方法支持。通常在使用时，可搭配一个或多个Mixin扩展类。

1）提供的关于序列化器使用的属性与方法

属性：serializer_class 指明视图使用的序列化器
方法：get_serializer_class(self)
返回序列化器类，默认返回serializer_class，可以重写，例如：

def get_serializer_class(self):
    if self.request.user.is_staff:
        return FullAccountSerializer
    return BasicAccountSerializer

方法：get_serializer(self, args, *kwargs)
返回序列化器对象，主要用来提供给Mixin扩展类使用，如果我们在视图中想要获取序列化器对象，也可以直接调用此方法。

注意：该方法在提供序列化器对象的时候，会向序列化器对象的context属性补充三个数据：request、format、view，这三个数据对象可以在定义序列化器时使用。

request 当前视图的请求对象

view 当前请求的类视图对象

format 当前请求期望返回的数据格式

2）提供的关于数据库查询的属性与方法

属性：queryset 指明使用的数据查询集
方法：get_queryset(self)

返回视图使用的查询集，主要用来提供给Mixin扩展类使用，是列表视图与详情视图获取数据的基础，默认返回queryset属性，可以重写，例如：

def get_queryset(self):
    user = self.request.user
    return user.accounts.all()

方法：get_object(self)

返回详情视图所需的模型类数据对象，主要用来提供给Mixin扩展类使用。

在试图中可以调用该方法获取详情信息的模型类对象。

若详情访问的模型类对象不存在，会返回404。

该方法会默认使用APIView提供的check_object_permissions方法检查当前对象是否有权限被访问。

举例：

# url(r'^books/(?P<pk>\d+)/$', views.BookDetailView.as_view()),
class BookDetailView(GenericAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer

    def get(self, request, pk):
        book = self.get_object() # get_object()方法根据pk参数查找queryset中的数据对象
        serializer = self.get_serializer(book)
        return Response(serializer.data)

其他可以设置的属性

pagination_class 指明分页控制类
filter_backends 指明过滤控制后端

示例

路由和序列化器和上面差不多，这里写下视图

from rest_framework.generics import GenericAPIView, ListAPIView, CreateAPIView, ListCreateAPIView, \
    RetrieveUpdateDestroyAPIView
from rest_framework.mixins import ListModelMixin, CreateModelMixin, RetrieveModelMixin, UpdateModelMixin, \
    DestroyModelMixin
"""以下是继承GenericAPIView的视图"""


class BookListGenericView(GenericAPIView):
    """列表视图"""
    # 指定序列化器类
    serializer_class = BookInfoModelSerializer
    # 指定查询集'数据来源'
    queryset = BookInfo.objects.all()

    def get(self, request):
        qs = self.get_queryset()
        serializer = self.get_serializer(qs, many=True)
        return Response(serializer.data)


class BookDetailGenericView(GenericAPIView):
    """详情视图"""
    # 指定序列化器类
    serializer_class = BookInfoModelSerializer
    # 指定查询集'数据来源'
    queryset = BookInfo.objects.all()

    def get(self, request, pk):
        book = self.get_object()  # queryset.get(self.kwargs)
        serializer = self.get_serializer(book)
        return Response(serializer.data)

    def put(self, request, pk):
        book = self.get_object()
        serializer = self.get_serializer(book, request.data)
        serializer.is_valid(raise_exception=True)
        serializer.save()
        return Response(serializer.data)

二、五个扩展类

作用：

提供了几种后端视图（对数据资源进行曾删改查）处理流程的实现，如果需要编写的视图属于这五种，则视图可以通过继承相应的扩展类来复用代码，减少自己编写的代码量。
这五个扩展类需要搭配GenericAPIView父类，因为五个扩展类的实现需要调用GenericAPIView提供的序列化器与数据库查询的方法。

1、ListModelMixin

列表视图扩展类，提供list(request, *args, **kwargs)方法快速实现列表视图，返回200状态码。

该Mixin的list方法会对数据进行过滤和分页。

源代码：

class ListModelMixin(object):
    """
    List a queryset.
    """
    def list(self, request, *args, **kwargs):
        # 过滤
        queryset = self.filter_queryset(self.get_queryset())
        # 分页
        page = self.paginate_queryset(queryset)
        if page is not None:
            serializer = self.get_serializer(page, many=True)
            return self.get_paginated_response(serializer.data)
        # 序列化
        serializer = self.get_serializer(queryset, many=True)
        return Response(serializer.data)

举例：

from rest_framework.mixins import ListModelMixin

class BookListView(ListModelMixin, GenericAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer

    def get(self, request):
        #下面注释的这三行，看上面的源码，在ListModelMixin类的list方法中一起实现了，所以只需要一个list方法
        #qs = self.get_queryset()
        #serializer = self.get_serializer(qs, many=True)
        #return Response(serializer.data)
        return self.list(request)

2、CreateModelMixin

创建视图扩展类，提供create(request, *args, **kwargs)方法快速实现创建资源的视图，成功返回201状态码。

如果序列化器对前端发送的数据验证失败，返回400错误。

源代码：

class CreateModelMixin(object):
    """
    Create a model instance.
    """
    def create(self, request, *args, **kwargs):
        # 获取序列化器
        serializer = self.get_serializer(data=request.data)
        # 验证
        serializer.is_valid(raise_exception=True)
        # 保存
        self.perform_create(serializer)
        headers = self.get_success_headers(serializer.data)
        return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)

    def perform_create(self, serializer):
        serializer.save()

    def get_success_headers(self, data):
        try:
            return {'Location': str(data[api_settings.URL_FIELD_NAME])}
        except (TypeError, KeyError):
            return {}

3、RetrieveModelMixin

详情视图扩展类，提供retrieve(request, *args, **kwargs)方法，可以快速实现返回一个存在的数据对象。

如果存在，返回200，否则返回404。

源代码：

class RetrieveModelMixin(object):
    """
    Retrieve a model instance.
    """
    def retrieve(self, request, *args, **kwargs):
        # 获取对象，会检查对象的权限
        instance = self.get_object()
        # 序列化
        serializer = self.get_serializer(instance)
        return Response(serializer.data)

举例：

class BookDetailView(RetrieveModelMixin, GenericAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer

    def get(self, request, pk):
        return self.retrieve(request)

4、UpdateModelMixin

更新视图扩展类，提供update(request, *args, **kwargs)方法，可以快速实现更新一个存在的数据对象。

同时也提供partial_update(request, *args, **kwargs)方法，可以实现局部更新。

成功返回200，序列化器校验数据失败时，返回400错误。

源代码：

class UpdateModelMixin(object):
    """
    Update a model instance.
    """
    def update(self, request, *args, **kwargs):
        partial = kwargs.pop('partial', False)
        instance = self.get_object()
        serializer = self.get_serializer(instance, data=request.data, partial=partial)
        serializer.is_valid(raise_exception=True)
        self.perform_update(serializer)

        if getattr(instance, '_prefetched_objects_cache', None):
            # If 'prefetch_related' has been applied to a queryset, we need to
            # forcibly invalidate the prefetch cache on the instance.
            instance._prefetched_objects_cache = {}

        return Response(serializer.data)

    def perform_update(self, serializer):
        serializer.save()

    def partial_update(self, request, *args, **kwargs):
        kwargs['partial'] = True
        return self.update(request, *args, **kwargs)

5、DestroyModelMixin

删除视图扩展类，提供destroy(request, *args, **kwargs)方法，可以快速实现删除一个存在的数据对象。

成功返回204，不存在返回404。

源代码：

class DestroyModelMixin(object):
    """
    Destroy a model instance.
    """
    def destroy(self, request, *args, **kwargs):
        instance = self.get_object()
        self.perform_destroy(instance)
        return Response(status=status.HTTP_204_NO_CONTENT)

    def perform_destroy(self, instance):
        instance.delete()

GenericAPIView和mixin的混合使用视图示例

"""以下是GenericAPIView和mixin的混合使用视图"""
class BookListGenericView(CreateModelMixin, ListModelMixin, GenericAPIView):
    """列表视图"""
    # 指定序列化器类
    serializer_class = BookInfoModelSerializer
    # 指定查询集'数据来源'
    queryset = BookInfo.objects.all()

    def get(self, request):
        return self.list(request)

    def post(self, request):
        return self.create(request)



class BookDetailGenericView(UpdateModelMixin, RetrieveModelMixin, GenericAPIView):
    """详情视图"""
    # 指定序列化器类
    serializer_class = BookInfoModelSerializer
    # 指定查询集'数据来源'
    queryset = BookInfo.objects.all()

    def get(self, request, pk):
        return self.retrieve(request, pk)

    def put(self, request, pk):
        return self.update(request, pk)

三、几个可用子类视图

1、 CreateAPIView

提供 post 方法

继承自： GenericAPIView、CreateModelMixin

class CreateAPIView(mixins.CreateModelMixin,
 GenericAPIView):
 """
 Concrete view for creating a model instance.
 """
 def post(self, request, *args, **kwargs):
     return self.create(request, *args, **kwargs)

2、ListAPIView

提供 get 方法

继承自：GenericAPIView、ListModelMixin

class ListAPIView(mixins.ListModelMixin,
 GenericAPIView):
 """
 Concrete view for listing a queryset.
 """
 def get(self, request, *args, **kwargs):
     return self.list(request, *args, **kwargs)

3、RetrieveAPIView

提供 get 方法

继承自: GenericAPIView、RetrieveModelMixin

class RetrieveAPIView(mixins.RetrieveModelMixin,
 GenericAPIView):
 """
 Concrete view for retrieving a model instance.
 """
 def get(self, request, *args, **kwargs):
     return self.retrieve(request, *args, **kwargs)

4、DestoryAPIView

提供 delete 方法

继承自：GenericAPIView、DestoryModelMixin

class DestroyAPIView(mixins.DestroyModelMixin,
 GenericAPIView):
 """
 Concrete view for deleting a model instance.
 """
 def delete(self, request, *args, **kwargs):
     return self.destroy(request, *args, **kwargs)

5、UpdateAPIView

提供 put 和 patch 方法

继承自：GenericAPIView、UpdateModelMixin

class UpdateAPIView(mixins.UpdateModelMixin,
 GenericAPIView):
 """
 Concrete view for updating a model instance.
 """
 def put(self, request, *args, **kwargs):
     return self.update(request, *args, **kwargs)
 def patch(self, request, *args, **kwargs):
     return self.partial_update(request, *args, **kwargs)

6、RetrieveUpdateAPIView

提供 get、put、patch方法

继承自： GenericAPIView、RetrieveModelMixin、UpdateModelMixin

class RetrieveUpdateAPIView(mixins.RetrieveModelMixin,
 mixins.UpdateModelMixin,
 GenericAPIView):
 """
 Concrete view for retrieving, updating a model instance.
 """
 def get(self, request, *args, **kwargs):
     return self.retrieve(request, *args, **kwargs)
 def put(self, request, *args, **kwargs):
     return self.update(request, *args, **kwargs)
 def patch(self, request, *args, **kwargs):
     return self.partial_update(request, *args, **kwargs)

7、RetrieveUpdateDestoryAPIView

提供 get、put、patch、delete方法

继承自：GenericAPIView、RetrieveModelMixin、UpdateModelMixin、DestoryModelMixin

GenericAPIView和Mixin合成的子类视图示例


"""以下是GenericAPIView和Mixin合成的子类视图"""
class BookListGenericView(ListCreateAPIView):
    """列表视图"""
    # 指定序列化器类
    serializer_class = BookInfoModelSerializer
    # 指定查询集'数据来源'
    queryset = BookInfo.objects.all()


class BookDetailGenericView(RetrieveUpdateDestroyAPIView):
    """详情视图"""
    # 指定序列化器类
    serializer_class = BookInfoModelSerializer
    # 指定查询集'数据来源'
    queryset = BookInfo.objects.all()

四、ViewSet 视图集

1、简介和示例

上面精简后也需要定义两个视图类，一个处理List列表，一个处理Detail具体的单对象个请求。两个视图都有一个get方法，如果写到一个类中会重复。

所以这里引进了ViewSet视图集，使用视图集ViewSet，可以将一系列逻辑相关的动作放到一个类中：ViewSet视图集类不再实现get()、post()等方法，而是实现动作 action 如 list()、create() 等。

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

视图集只在使用as_view()方法的时候，才会将action动作与具体请求方式对应上。如：

class BookInfoViewSet(viewsets.ViewSet):

    def list(self, request):
        books = BookInfo.objects.all()
        serializer = BookInfoSerializer(books, many=True)
        return Response(serializer.data)

    def retrieve(self, request, pk=None):
        try:
            books = BookInfo.objects.get(id=pk)
        except BookInfo.DoesNotExist:
            return Response(status=status.HTTP_404_NOT_FOUND)
        serializer = BookInfoSerializer(books)
        return Response(serializer.data)

在设置路由时，我们可以如下操作

urlpatterns = [
    url(r'^books/$', BookInfoViewSet.as_view({'get':'list'}),
    url(r'^books/(?P<pk>\d+)/$', BookInfoViewSet.as_view({'get': 'retrieve'})
]

2、常用视图集父类

1） ViewSet

继承自APIView与ViewSetMixin，作用也与APIView基本类似，提供了身份认证、权限校验、流量管理等。

ViewSet主要通过继承ViewSetMixin来实现在调用as_view()时传入字典（如{‘get’:‘list’}）的映射处理工作。

在ViewSet中，没有提供任何动作action方法，需要我们自己实现action方法。

2）GenericViewSet

使用ViewSet通常并不方便，因为list、retrieve、create、update、destory等方法都需要自己编写，而这些方法与前面讲过的Mixin扩展类提供的方法同名，所以我们可以通过继承Mixin扩展类来复用这些方法而无需自己编写。但是Mixin扩展类依赖与GenericAPIView，所以还需要继承GenericAPIView。

GenericViewSet就帮助我们完成了这样的继承工作，继承自GenericAPIView与ViewSetMixin，在实现了调用as_view()时传入字典（如{‘get’:‘list’}）的映射处理工作的同时，还提供了GenericAPIView提供的基础方法，可以直接搭配Mixin扩展类使用。

举例：

from rest_framework import mixins
from rest_framework.viewsets import GenericViewSet
from rest_framework.decorators import action

class BookInfoViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer

url的定义

urlpatterns = [
    url(r'^books/$', views.BookInfoViewSet.as_view({'get': 'list'})),
    url(r'^books/(?P<pk>\d+)/$', views.BookInfoViewSet.as_view({'get': 'retrieve'})),
]

3）ModelViewSet

继承自GenericViewSet，同时包括了ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestoryModelMixin。

4）ReadOnlyModelViewSet

继承自GenericViewSet，同时包括了ListModelMixin、RetrieveModelMixin。

3、视图集中定义附加action动作

在视图集中，除了上述默认的方法动作外，还可以添加自定义动作。

使用action装饰器

举例：

from rest_framework import mixins
from rest_framework.viewsets import ModelViewSet
from rest_framework.decorators import action

class BookViewSet(ModelViewSet):
    """视图集"""
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoModelSerializer

    # def list(self, request):
    #     qs = self.get_queryset()
    #     serializer = self.get_serializer(qs, many=True)
    #     return Response(serializer.data)

    # 查询最后一本书  books/latest/  get:latest
    # @action(methods=[指定下面的行为接收什么请求], detail=是不是详情视图如果是不详情视图就是 books/latest)
    @action(methods=['get'], detail=False)
    def latest(self, request):
        """
        返回最新的图书信息
        """
        book = BookInfo.objects.latest('id')  # 获取最后一本书
        serializer = self.get_serializer(book)
        return Response(serializer.data)

    # books/pk/read/ detail=True表示是详情视图，所以路由为books/pk/read/
    @action(methods=['put'], detail=True)
    def read(self, request, pk):
        """
        修改图书的阅读量数据
        """
        book = self.get_object()
        book.bread = request.data.get('bread')
        book.save()
        serializer = self.get_serializer(book)
        return Response(serializer.data)

路由，这里使用自己写路径的方法，后面会使用自动生成路由的方法。

urlpatterns = [
    # ViewSet视图集指定路由
    # 列表视图的路由GenericAPIView
     url(r'^books/$', views.BookViewSet.as_view({'get': 'list', 'post': 'create'})),
    # # 详情视图的路由GenericAPIView
     url(r'^books/(?P<pk>\d+)/$', views.BookViewSet.as_view({'get': 'retrieve', 'put': 'update', 'delete': 'destroy'})),

    # 如果在增删改查之外额外增加的行为 应该单独定义路由
    # 如果此行为不需要pk 那么它就是列表视图 但是列表视图默认只有list, create
     url(r'^books/latest/$', views.BookViewSet.as_view({'get': 'latest'})),
     url(r'^books/(?P<pk>\d+)/read/$', views.BookViewSet.as_view({'put': 'read'})),
]

4、路由的定义

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

REST framework提供了两个router

SimpleRouter
DefaultRouter

使用方法

1）创建router对象，并注册视图集，例如

from rest_framework import routers

router = routers.SimpleRouter()
router.register(r'books', BookInfoViewSet, base_name='book')

prefix 该视图集的路由前缀
viewset 视图集
base_name 路由名称的前缀

如上述代码会形成的路由如下：

^books/$    name: book-list
^books/{pk}/$   name: book-detail

2）添加路由数据

可以有两种方式：

urlpatterns = [
    ...
]
urlpatterns += router.urls

或

urlpatterns = [
    ...
    url(r'^', include(router.urls))
]

视图集中附加action的声明

在视图集中，如果想要让Router自动帮助我们为自定义的动作生成路由信息，需要使用rest_framework.decorators.action装饰器。

以action装饰器装饰的方法名会作为action动作名，与list、retrieve等同。

action装饰器可以接收两个参数：

methods: 声明该action对应的请求方式，列表传递
detail: 声明该action的路径是否与单一资源对应，及是否是xxx/<pk>/action方法名/
 - True 表示路径格式是xxx/<pk>/action方法名/
 - False 表示路径格式是xxx/action方法名/

举例：

from rest_framework import mixins
from rest_framework.viewsets import GenericViewSet
from rest_framework.decorators import action

class BookInfoViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer

    # detail为False 表示路径名格式应该为 books/latest/
    @action(methods=['get'], detail=False)
    def latest(self, request):
        """
        返回最新的图书信息
        """
        ...

    # detail为True，表示路径名格式应该为 books/{pk}/read/
    @action(methods=['put'], detail=True)
    def read(self, request, pk):
        """
        修改图书的阅读量数据
        """
        ...

由路由器自动为此视图集自定义action方法形成的路由会是如下内容：

^books/latest/$    name: book-latest
^books/{pk}/read/$  name: book-read

路由router形成URL的方式

1） SimpleRouter

在这里插入图片描述
2）DefaultRouter

DefaultRouter与SimpleRouter的区别是，DefaultRouter会多附带一个默认的API根视图，返回一个包含所有列表视图的超链接响应数据。

光明小学王小雨

关注

2
点赞
踩
3

收藏

觉得还不错? 一键收藏
1
评论
复制链接

分享到 QQ

分享到新浪微博

扫一扫

专栏目录