DRF之请求响应与视图组件

请求响应

　　请求Request

　　　　REST framework 传入视图的request对象不再是Django默认的HttpRequest对象，而是REST framework提供的扩展了HttpRequest类的Request类的对象。

　　　　REST framework 提供了Parser解析器，在接收到请求后会自动根据Content-Type指明的请求数据类型（如JSON、表单等）将请求数据进行parse解析，解析为类字典[QueryDict]对象保存到Request对象中。

　　　　Request对象的数据是自动根据前端发送数据的格式进行解析之后的结果。

　　　　无论前端发送的哪种格式的数据，我们都可以以统一的方式读取数据。

　　　　常用属性：

　　　　　　1.data

　　　　　　　　request.data 返回解析之后的请求体数据。类似于Django中标准的request.POST和 request.FILES属性，但提供如下特性：

        • 包含了解析之后的文件和非文件数据
        • 包含了对POST、PUT、PATCH请求方式解析后的数据
        • 利用了REST framework的parsers解析器，不仅支持表单类型数据，也支持JSON数据

　　　　　　2.query_params

　　　　　　　　request.query_params与Django标准的request.GET相同，只是更换了更正确的名称而已。

　　响应Response

　　　　REST framework提供了一个响应类Response，使用该类构造响应对象时，响应的具体数据内容会被转换（render渲染）成符合前端需求的类型。

　　　　REST framework提供了Renderer 渲染器，用来根据请求头中的Accept（接收数据类型声明）来自动转换响应数据到对应格式。如果前端请求中未进行Accept声明，则会采用默认方式处理响应数据，我们可以通过配置来修改默认响应格式。

　　　　可以在rest_framework.settings查找所有的drf默认配置项

REST_FRAMEWORK = {
    'DEFAULT_RENDERER_CLASSES': (  # 默认响应渲染类
        'rest_framework.renderers.JSONRenderer',  # json渲染器
        'rest_framework.renderers.BrowsableAPIRenderer',  # 浏览API渲染器
    )
}

　　　　构造方式：

Response(data, status=None, template_name=None, headers=None, content_type=None)

　　　　　　data数据不要是render处理之后的数据，只需传递python的内建类型数据即可，REST framework会使用renderer渲染器处理data。

　　　　　　data不能是复杂结构的数据，如Django的模型类对象，对于这样的数据我们可以使用Serializer序列化器序列化处理后（转为了Python字典类型）再传递给data参数。

　　　　　　参数说明：

      • data: 为响应准备的序列化处理后的数据；
      • status: 状态码，默认200；
      • template_name: 模板名称，如果使用HTMLRenderer 时需指明；
      • headers: 用于存放响应头信息的字典；
      • content_type: 响应数据的Content-Type，通常此参数无需传递，REST framework会根据前端所需类型数据来设置该参数。

　　　　常用属性

　　　　　　1.data
　　　　　　　　传给response对象的序列化后，但尚未render处理的数据

　　　　　　2.status_code
　　　　　　　　状态码的数字

　　　　　　3.content
　　　　　　　　经过render处理后的响应数据

 

视图组件

　　2个视图基类

　　　　APIView

　　　　　　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() 或者其他请求方式的方法。

　　　　　　举例：

复制代码
class BookView(APIView):
    def get(self, request):
        book_list = Book.objects.all()
        ser = BookSerializer(instance=book_list, many=True)

        return Response(ser.data)

    def post(self, request):
        ser = BookSerializer(data=request.data)
        if ser.is_valid():
            ser.save()
            return Response({'code': 100, 'msg': '新增成功', 'data': ser.data})
        return Response({'code': 101, 'msg': '新增失败', 'err': ser.errors})
复制代码

 

　　　　GenericAPIView[通用视图类]

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

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

      • 属性：

        • serializer_class 指明视图使用的序列化器

      • 方法：

        • get_serializer_class(self)

          当出现一个视图类中调用多个序列化器时,那么可以通过条件判断在get_serializer_class方法中通过返回不同的序列化器类名就可以让视图方法执行不同的序列化器对象了。

　　　　　　　　　　　　返回序列化器类，默认返回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 当前请求期望返回的数据格式

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

      • 属性：

        • 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 指明过滤控制后端

　　　　为了方便学习上面的GenericAPIView通用视图类，我们新建一个子应用。　　

python manage.py startapp gen

　　　　代码：

复制代码
from rest_framework.generics import GenericAPIView

from students.models import Student
from .serializers import StudentModelSerializer, StudentModel2Serializer
from rest_framework.response import Response

class StudentsGenericAPIView(GenericAPIView):
    # 本次视图类中要操作的数据[必填]
    queryset = Student.objects.all()
    # 本次视图类中要调用的默认序列化器[玄天]
    serializer_class = StudentModelSerializer

    def get(self, request):
        """获取所有学生信息"""
        serializer = self.get_serializer(instance=self.get_queryset(), many=True)

        return Response(serializer.data)

    def post(self,request):

        data = request.data

        serializer = self.get_serializer(data=data)

        serializer.is_valid(raise_exception=True)

        instance = serializer.save()

        serializer = self.get_serializer(instance=instance)

        return Response(serializer.data)


class StudentGenericAPIView(GenericAPIView):
    queryset = Student.objects.all()

    serializer_class = StudentModelSerializer

    def get_serializer_class(self):
        """重写获取序列化器类的方法"""
        if self.request.method == "GET":
            return StudentModel2Serializer
        else:
            return StudentModelSerializer

    # 在使用GenericAPIView视图获取或操作单个数据时,视图方法中的代表主键的参数最好是pk
    def get(self,request,pk):
        """获取一条数据"""
        serializer = self.get_serializer(instance=self.get_object())

        return Response(serializer.data)

    def put(self,request,pk):

        data = request.data

        serializer = self.get_serializer(instance=self.get_object(),data=data)

        serializer.is_valid(raise_exception=True)

        serializer.save()

        serializer = self.get_serializer(instance=self.get_object())

        return Response(serializer.data)
复制代码

　　　　序列化器类：

复制代码
from rest_framework import serializers

from students.models import Student

class StudentModelSerializer(serializers.ModelSerializer):
    class Meta:
        model= Student
        fields = "__all__"


class StudentModel2Serializer(serializers.ModelSerializer):
    class Meta:
        model= Student
        fields = ("name","class_null")
复制代码

 

　　5个视图扩展类

　　　　作用：

　　　　　　提供了几种后端视图（对数据资源进行曾删改查）处理流程的实现，如果需要编写的视图属于这五种，则视图可以通过继承相应的扩展类来复用代码，减少自己编写的代码量。

　　　　　　这五个扩展类需要搭配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):
        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和视图扩展类，实现api接口，代码：

复制代码
"""GenericAPIView结合视图扩展类实现api接口"""
from rest_framework.mixins import ListModelMixin,CreateModelMixin
class Students2GenericAPIView(GenericAPIView,ListModelMixin,CreateModelMixin):
    # 本次视图类中要操作的数据[必填]
    queryset = Student.objects.all()
    # 本次视图类中要调用的默认序列化器[玄天]
    serializer_class = StudentModelSerializer

    def get(self, request):
        """获取多个学生信息"""
        return self.list(request)

    def post(self,request):
        """添加学生信息"""
        return self.create(request)


from rest_framework.mixins import RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin
class Student2GenericAPIView(GenericAPIView,RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin):
    queryset = Student.objects.all()

    serializer_class = StudentModelSerializer

    # 在使用GenericAPIView视图获取或操作单个数据时,视图方法中的代表主键的参数最好是pk
    def get(self,request,pk):
        """获取一条数据"""
        return self.retrieve(request,pk)

    def put(self,request,pk):
        """更新一条数据"""
        return self.update(request,pk)

    def delete(self,request,pk):
        """删除一条数据"""
        return self.destroy(request,pk)
复制代码

　　9个视图子类

　　　　1.CreateAPIView

　　　　　　提供 post 方法

　　　　　　继承自： GenericAPIView、CreateModelMixin

　　　　2.ListAPIView

　　　　　　提供 get 方法

　　　　　　继承自：GenericAPIView、ListModelMixin

　　　　3.RetrieveAPIView

　　　　　　提供 get 方法

　　　　　　继承自: GenericAPIView、RetrieveModelMixin

　　　　4.DestoryAPIView

　　　　　　提供 delete 方法

　　　　　　继承自：GenericAPIView、DestoryModelMixin

　　　　5.UpdateAPIView

　　　　　　提供 put 和 patch 方法

　　　　　　继承自：GenericAPIView、UpdateModelMixin

　　　　6.RetrieveUpdateAPIView

　　　　　　提供 get、put、patch方法

　　　　　　继承自： GenericAPIView、RetrieveModelMixin、UpdateModelMixin

　　　　7.RetrieveDestroyAPIView

　　　　　　提供 get、delete方法

　　　　　　继承自： GenericAPIView、RetrieveModelMixin、DestoryModelMixin

　　　　8.ListCreateAPIView

　　　　　　提供 get、post方法

　　　　　　继承自： GenericAPIView、ListModelMixin、CreateModelMixin

　　　　9.RetrieveUpdateDestoryAPIVie

　　　　　　提供 get、put、patch、delete方法

　　　　　　继承自：GenericAPIView、RetrieveModelMixin、UpdateModelMixin、DestoryModelMixin

from rest_framework.generics import CreateAPIView, ListAPIView, DestroyAPIView, RetrieveAPIView, UpdateAPIView
from rest_framework.generics import ListCreateAPIView, RetrieveUpdateAPIView, RetrieveUpdateDestroyAPIView,RetrieveDestroyAPIView

　　视图集ViewSet

　　　　使用视图集ViewSet，可以将一系列逻辑相关的动作放到一个类中：

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

　　　　ViewSet视图集类不再实现get()、post()等方法，而是实现动作 action 如 list() 、create() 等。

　　　　视图集只在使用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'})
]

　　　　常用视图集父类

　　　　　　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.viewsets import GenericViewSet
from rest_framework.mixins import ListModelMixin,CreateModelMixin,RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin
class Student4ViewSet(GenericViewSet,ListModelMixin,CreateModelMixin,RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

　　　　　　　　url的定义

urlpatterns = [
    path("students7/", views.Student4ViewSet.as_view({"get": "list", "post": "create"})),
    re_path("students7/(?P<pk>\d+)/", views.Student4ViewSet.as_view({"get": "retrieve","put":"update","delete":"destroy"})),

]

　　　　　　3.ModelViewSet

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

　　　　　　4.ReadOnlyModelViewSet

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

　　　　视图集中定义附加action动作

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

　　　　　　举例：

from rest_framework.viewsets import ModelViewSet,ReadOnlyModelViewSet
class StudentModelViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

    def login(self,request):
        """学生登录功能"""
        return Response({"message":"登录成功"})

　　　　　　url的定义：

urlpatterns = [
    path("students8/", views.StudentModelViewSet.as_view({"get": "list", "post": "create"})),
    re_path("students8/(?P<pk>\d+)/",
            views.StudentModelViewSet.as_view({"get": "retrieve", "put": "update", "delete": "destroy"})),

    path("stu/login/",views.StudentModelViewSet.as_view({"get":"login"}))

]

　　　　action属性

　　　　　　在视图集中，我们可以通过action对象属性来获取当前请求视图集时的action动作是哪个。

　　　　　　例如：

复制代码
from rest_framework.viewsets import ModelViewSet
from students.models import Student
from .serializers import StudentModelSerializer
from rest_framework.response import Response
class StudentModelViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

    def get_new_5(self,request):
        """获取最近添加的5个学生信息"""
        # 操作数据库
        print(self.action) # 获取本次请求的视图方法名
        
        
通过路由访问到当前方法中.可以看到本次的action就是请求的方法名
复制代码

　　总结视图类中的继承关系

 

posted @   临江沂水  阅读(43)  评论(0)  编辑  收藏  举报
相关博文：
· DRF之DRF入门规范
· DRF之路由组件
· 四，DRF 视图组件
· DRF 视图
· 6.DRF的视图和路由
阅读排行：
· 开源Multi-agent AI智能体框架aevatar.ai，欢迎大家贡献代码
· Manus重磅发布：全球首款通用AI代理技术深度解析与实战指南
· 被坑几百块钱后，我竟然真的恢复了删除的微信聊天记录！
· 没有Manus邀请码？试试免邀请码的MGX或者开源的OpenManus吧
· 园子的第一款AI主题卫衣上架——"HELLO! HOW CAN I ASSIST YOU TODAY
点击右上角即可分享
微信分享提示