zoukankan      html  css  js  c++  java
  • Django REST framework 中的视图

    1.Request

    REST framework传入视图的request对象不再是Django默认的Httprequest对象,而是DRF提供的扩展类的Request类的对象

    常用属性

    request.data-------》获取请求报文体体重的数据,字典

    request.query_params-------------》查询字符串,字典

    2.Response

    rest_framework.response.Response

    REST framework提供了Render渲染器,用来根据请求头中的Accept(接收数据类型声明)来自动转换响应数据到对应格式,若前端未使用Accept声明,可以通过配置来修改默认响应格式

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

    常用属性

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

    response.status_code  ------>状态码的数字

    response.content      --------》经过render处理后的响应数据

    状态码:

    信息告知  ---1xxx

    成功      ---2xxx

    重定向    ---3xxxx

    客户端错误   ---4xxxx

    服务端错误   ---5xxxx

    3.视图

    (1)APiView:继承自Django的View父类

    rest_framework.views.APIView

    APIVIew与View的不同之处在于:

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

    支持定义的属性

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

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

    class BooksView(View):
        def get(self, request):
                ........
        
        def post(self, request):
                .........

    (2)GenericAPIView:继承自APIView,增加了对于列表视图和详情视图可能用到的通用支持方法,使用时,通常会搭配一个或多个Mixin扩展类

    支持定义的属性:
    • 列表视图与详情视图通用:
      • queryset 列表视图的查询集
      • serializer_class 视图使用的序列化器
    • 列表视图使用:
      • pagination_class 分页控制类
      • filter_backends 过滤控制后端
    • 详情页视图使用:
      • lookup_field 查询单一数据库对象时使用的条件字段,默认为'pk'
      • lookup_url_kwarg 查询单一数据时URL中的参数关键字名称,默认与look_field相同

    提供的方法:

      get_queryset(self):返回视图使用的查询集,默认返回queryset属性,可以重写

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

      get_serializer_class(self):返回序列化器类,默认返回Serializer_class,可以重写

      get_serializer(self, args, *kwargs):返回序列化器对象

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

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

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

    4. 五个扩展类

    ListModelMixin ( 查询多个)

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

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

    CreateModelMixin(创建)

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

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

    RetrieveModelMixin(查询一个)

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

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

    UpdateModelMixin(修改)

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

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

    DestroyModelMixin(删除)

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

    成功返回204,不存在返回404

    5. 几个可用子类视图:

    1) CreateAPIView

    提供 post 方法

    继承自: GenericAPIView、CreateModelMixin

    2)ListAPIView

    提供 get 方法

    继承自:GenericAPIView、ListModelMixin

    3)RetireveAPIView

    提供 get 方法

    继承自: GenericAPIView、RetrieveModelMixin

    4)DestoryAPIView

    提供 delete 方法

    继承自:GenericAPIView、DestoryModelMixin

    5)UpdateAPIView

    提供 put 和 patch 方法

    继承自:GenericAPIView、UpdateModelMixin

    6)RetrieveUpdateAPIView

    提供 get、put、patch方法

    继承自: GenericAPIView、RetrieveModelMixin、UpdateModelMixin

    7)RetrieveUpdateDestoryAPIView

    提供 get、put、patch、delete方法

    继承自:GenericAPIView、RetrieveModelMixin、UpdateModelMixin、DestoryModelMixin

    6. 视图集ViewSet

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

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

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

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

      

    class BookInfoViewSet(viewsets.ViewSet):
    
        def list(self, request):
            ...
    
        def retrieve(self, request, pk=None):
            ...

    在设置路由时,

    from django.conf.urls import url
    from . import views
    
    urlpatterns = [
        # url('^heros/$',views.HerosView.as_view()),
        # url(r'^hero/(?P<pk>d+)/$',views.HeroView.as_view()),
    ]

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

    def get_serializer_class(self):
        if self.action == 'create':
            return OrderCommitSerializer
        else:
            return OrderDataSerializer

    7. 常用视图集父类

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

    GenericViewSet: 继承自GenericAPIView,作用也与GenericAPIVIew类似,提供了get_object、get_queryset等方法便于列表视图与详情信息视图的开发。

    ModelViewSet:继承自GenericAPIVIew,同时包括了ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestoryModelMixin。

    ReadOnlyModelViewSet:继承自GenericAPIVIew,同时包括了ListModelMixin、RetrieveModelMixin。

    8. 视图集中定义附加action动作

    在视图集中,可以自定义动作

    添加自定义动作需要使用rest_framework.decorators.action装饰器

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

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

    • methods: 该action支持的请求方式,列表传递
    • detail: 表示是action中要处理的是否是视图资源的对象(即是否通过url路径获取主键)
      • True 表示使用通过URL获取的主键对应的数据对象
      • False 表示不使用URL获取主键
    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 表示不需要处理具体的BookInfo对象
        @action(methods=['get'], detail=False)
        def latest(self, request):
            book = BookInfo.objects.latest('id')
            serializer = self.get_serializer(book)
            return Response(serializer.data)
    
        # detail为True,表示要处理具体与pk主键对应的BookInfo对象
        @action(methods=['put'], detail=True)
        def read(self, request, pk):
            book = self.get_object()
            book.bread = request.data.get('read')
            book.save()
            serializer = self.get_serializer(book)
            return Response(serializer.data)

    视图集的继承关系图

     9.路由router

    REST framework提供了两个router

    • SimpleRouter
    • DefaultRouter

    (1)使用方法 

    创建对象,并注册视图集

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

    register(prefix, viewset, base_name)

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

    (2)添加理由数据

    # 方法一
    urlpatterns = [
        ...
    ]
    urlpatterns += router.urls
    
    # 方法二
    urlpatterns = [
        ...
        url(r'^', include(router.urls))
    ]
  • 相关阅读:
    mysql用户密码修改
    Java List java.lang.UnsupportedOperationException
    python __dict__
    pytest.fixture
    Python __metaclass__ 解释
    Python __new__()方法,为对象分配内存 返回对象的引用
    git 常用操作
    boto3 dynamodb 一些简单操作
    conda, pip, virtualenv 区别
    list去重后不改变排序
  • 原文地址:https://www.cnblogs.com/xiaolu915/p/10534580.html
Copyright © 2011-2022 走看看