Django DRF - REST 视图APIView、GenericAPIView-CFANZ编程社区

前言

REST framework 提供了众多的通用视图基类与扩展类，以简化视图的编写。

一. APIView（一级视图）

rest_framework.views.APIView

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

Django DRF - REST 视图APIView、GenericAPIView_数据

APIView与View的不同之处在于：

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

支持定义的属性：

authentication_classes列表或元祖，身份认证类
permissoin_classes列表或元祖，权限检查类
throttle_classes列表或元祖，流量控制类

在APIView中仍以常规的类视图定义方法来实现get() 、post() 或者其他请求方式的方法。

举例：

class BookListAPIView(APIView):

    def get(self,request):

        # request.GET
        # request.query_params
        #params = request.query_params
        # 1.查询数据
        books = BookInfo.objects.all()
        # 2.创建序列化器，并传递查询结果集（设置many=True）
        serializer = BookInfoModelSerializer(books, many=True)
        # 3.返回响应 serializer.data 就是字典列表
        return Response(serializer.data)

    def post(self,request):

        # request.POST, request.body
        #data = request.data

        # 1.接收参数
        book_dict = request.data
        # 2.创建序列化器，并传递参数
        serializer = BookInfoModelSerializer(data=book_dict)
        # 3.验证数据，并根据验证结果进行判断
        if serializer.is_valid():
            # 4.数据验证没有问题，调用序列化器的save方法。来触发序列化器的create方法
            # create方法会调用模型来保存到数据库中
            serializer.save()
            # 5. 返回响应 serializer.data 就是字典数据
            return Response(serializer.data)
        else:
            # 返回错误信息
            return Response({'msg':'保存失败'})

对比

Django DRF - REST 视图APIView、GenericAPIView_数据_02

二. GenericAPIView（二级视图）

rest_framework.generics.GenericAPIView

Django DRF - REST 视图APIView、GenericAPIView_django_03

继承自APIVIew，增加了对于列表视图和详情视图可能用到的通用支持方法。通常使用时，可搭配一个或多个Mixin扩展类。

使用GenericAPIView类一般需要实现queryset属性或者重写get_queryset方法
支持定义的属性：

列表视图与详情视图通用：

queryset列表视图的查询集
serializer_class视图使用的序列化器

详情页视图使用：

lookup_field查询单一数据库对象时使用的条件字段，默认为’pk’
lookup_url_kwarg查询单一数据时URL中的参数关键字名称，默认与look_field相同
提供的方法：
列表视图与详情视图通用：
get_queryset(self)

返回视图使用的查询集，是列表视图与详情视图获取数据的基础，默认返回queryset属性，可以重写，例如：

def get_queryset(self):
    return BookInfo.objects.all()

get_serializer_class(self)
返回序列化器类，默认返回serializer_class，可以重写，例如：

def get_serializer_class(self):
    return BookInfoModelSerializer

get_serializer(self,_args, __kwargs)
返回序列化器对象，被其他视图或扩展类使用，如果我们在视图中想要获取序列化器对象，可以直接调用此方法。

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

详情视图使用：

get_object(self)返回详情视图所需的模型类数据对象，默认使用lookup_field参数来过滤queryset。
在试图中可以调用该方法获取详情信息的模型类对象。若详情访问的模型类对象不存在，会返回404。

列表视图方法和属性举例

from rest_framework.generics import GenericAPIView
from book.models import BookInfo
from book.serializers import BookInfoModelSerializer

class BookListGenericView(GenericAPIView):

    # 设置查询结果集属性
    queryset = BookInfo.objects.all()

    # 设置序列化器属性
    serializer_class = BookInfoModelSerializer

    def get(self,request):
        # 1.查询数据
        books = self.get_queryset()
        # 2.创建序列化器，并传递查询结果集（设置many=True）
        serializer = self.get_serializer(books, many=True)
        # 3.返回响应 serializer.data 就是字典列表
        return Response(serializer.data)

    def post(self,request):
        # 1.接收参数
        book_dict = request.data
        # 2.创建序列化器，并传递参数
        serializer = self.get_serializer(data=book_dict)
        # 3.验证数据，并根据验证结果进行判断
        if serializer.is_valid():
            # 4.数据验证没有问题，调用序列化器的save方法。来触发序列化器的create方法
            # create方法会调用模型来保存到数据库中
            serializer.save()
            # 5. 返回响应 serializer.data 就是字典数据
            return Response(serializer.data)
        else:
            # 返回错误信息
            return Response({'msg': '保存失败'})

我们还可以通过以下方法来实现

class BookListGenericView(GenericAPIView):

    # 设置查询结果集属性
    # queryset = BookInfo.objects.all()
    #重写查询结果集方法
    def get_queryset(self):
        return BookInfo.objects.all()

    # 设置序列化器属性
    # serializer_class = BookInfoModelSerializer
    # 重写返回序列化器方法
    def get_serializer_class(self):
        return BookInfoModelSerializer

三.子类视图（三级视图）

几个可用子类视图

1） CreateAPIView

from rest_framework.generics import 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

from rest_framework.generics import 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）RetireveAPIView

from rest_framework.generics import RetrieveAPIView

提供 get 方法

继承自: GenericAPIView、RetrieveModelMixin

4）DestoryAPIView

from rest_framework.generics import DestroyAPIView

提供 delete 方法

继承自：GenericAPIView、DestoryModelMixin

5）UpdateAPIView

from rest_framework.generics import UpdateAPIView

提供 put 和 patch 方法

继承自：GenericAPIView、UpdateModelMixin

6）RetrieveUpdateAPIView

from rest_framework.generics import RetrieveUpdateAPIView

提供 get、put、patch方法

继承自：

GenericAPIView、RetrieveModelMixin、UpdateModelMixin

7）RetrieveUpdateDestoryAPIView

from rest_framework.generics import RetrieveUpdateDestroyAPIView

提供 get、put、patch、delete方法

继承自：GenericAPIView、RetrieveModelMixin、UpdateModelMixin、DestoryModelMixin

以上就是Django DRF框架视图介绍，希望对你有所帮助。
更多的需求请查看官方文档：https://www.django-rest-framework.org/api-guide/generic-views/#concrete-view-classe