drf中的各种view，viewset详解

drf中的各种view，viewset

Django REST framework里有各种各样的view，其中的继承关系需要梳理，得好好捋一捋这关系。

视图的作用

Django用“视图”这个概念封装处理用户请求并返回响应的逻辑。

视图是一个可调用对象，它不仅可以是基于函数，也可以是基于类的。

相比较与函数，基于类的视图有一些区别和优势：

• 组织与特定HTTP方法相关的代码（GET，POST等） 可以通过单独的方法而不是条件分支来解决。
• 面向对象的技术例如Mixin（多继承、混用）可以将代码分解成可重用的组件。

视图函数：

def my_view(request):
    if request.method == 'GET':
        # 
        return HttpResponse('result')

视图类：

class MyView(View):
    def get(self, request):
        # 
        return HttpResponse('result')

View

Django中的View

是所有基于类的view的父类，它负责将视图连接到URL、HTTP 方法调度(GET,POST等)和其它简单的功能。

APIView

APIView是drf中所有view的父类，本身继承于Django的VIew，只有简单的调度方法和健壮检查。

和View的不同

• 请求和返回使用的drf的Request Response而不是django的HttpRequest HttpResponse。
• 请求传入时进行身份验证，并在传给处理方法前进行权限检验。
• 任何APIException都会被捕捉并放入合适的想要中。

使用

response返回的内容需是序列化的json。

先创建在goods包下新建serializer.py

某字段结果可能有多条时，记得加many=True！否则无法正确显示。

class MyView(View):
    def get(self, request):
        # 
        return HttpResponse('result')

<span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Meta</span>:</span>
    model = Goods
    fields = <span class="hljs-string">"__all__"</span>
</code></pre>

views

因为会有多条商品信息，所以这里也要记得加many=True！否则会报错。

class GoodsListView(APIView):
    # 重写get方法 进行get访问时会进行的处理
    def get(self, request):
        goods = Goods.objects.all()[:10]
        goods_list = GoodsSerializer(goods, many=True)
        return Response(goods_list.data) 

在url下配置view的访问，别忘了这是基于类的视图，所以要加上as_view()方法。

url(r'^GoodsListView/', GoodsListView.as_view()),

GenericAPIView

GenericAPIView继承于APIView，为标准list和detail详情提供了常用行为，每个GenericAPIView都会和一个或多个mixin联合使用。

属性

• 基础设置
  • queryset 需要返回的结果集
  • serializer_class 用于序列化的serializer
  • lookup_field 查找单个model实例时的字段，默认为pk(主键)
  • lookup_url_kwarg
• 分页
  • pagination_class
• 过滤
  • filter_backend

使用

先在views里设置个分页

class StandardResultsSetPagination(PageNumberPagination):
    page_size = 10
    page_size_query_param = 'page_size' # GoodsListView/?p=2&page_size=3
    page_query_param = 'p' # GoodsListView/?p=2
    max_page_size = 100

class GoodsListView(GenericAPIView, ListModelMixin):
    """
    商品列表
    """
    queryset = Goods.objects.all()
    # 序列化
    serializer_class = GoodsSerializer
    # 分页
    pagination_class = StandardResultsSetPagination
    # 过滤 /排序、搜索
    filter_backends = (filters.DjangoFilterBackend, SearchFilter, OrderingFilter)
    ordering_fields = ('add_time', )
    search_fields = ('name', 'goods_desc')

    def get(self, request, *args, **kwargs):
        return self.list(request, *args, **kwargs)

ListAPIView

除了继承GenericAPIView加ListModelMixin，重写了下get方法，没干别的事。

源码

class ListAPIView(mixins.ListModelMixin,
                  GenericAPIView):
    """
    Concrete view for listing a queryset.
    """
    def get(self, request, *args, **kwargs):
        return self.list(request, *args, **kwargs)
<a name="_label4_1"></a><h3 id="autoid-5-1-0">使用</h3>

class StandardResultsSetPagination(PageNumberPagination):
    page_size = 10
    page_size_query_param = 'page_size' # GoodsListView/?p=2&page_size=3
    page_query_param = 'p' # GoodsListView/?p=2
    max_page_size = 100

作用就是少写继承，不用重写get...

类似有：

class CreateAPIView(mixins.CreateModelMixin,
                    GenericAPIView)

class RetrieveAPIView(mixins.RetrieveModelMixin,
                      GenericAPIView)

class RetrieveUpdateAPIView(mixins.RetrieveModelMixin,
                            mixins.UpdateModelMixin,
                            GenericAPIView)

等等常用到的行为都被封装了。

GenericViewSet

继承于GenericAPIView，并提供默认的get_object，get_queryset方法和其他通用视图基本行为，但默认情况下不包含任何操作。为了使用GenericViewSet类，您将覆盖该类并混合所需的mixin类，或者显式定义动作实现。

源码

class GenericViewSet(ViewSetMixin, generics.GenericAPIView):
    pass

只是比GenericAPIView多了ViewSetMixin。

在ViewSetMixin里重写了as_view方法，可以更方便的绑定actions。

使用

class GoodsListViewSet(GenericViewSet, ListModelMixin):
    """
    商品列表
    """
    queryset = Goods.objects.all()
    # 序列化
    serializer_class = GoodsSerializer
    # 分页
    pagination_class = StandardResultsSetPagination

urls配置

将get请求 绑定到list() action

goods_list = GoodsListViewSet.as_view({
     
    'get': 'list'
})
urlpatterns = [
    ....
    url(<span class="hljs-string">r'^goodsList/'</span>, goods_list),]

使用router

VIewSet常常和router使用，router可以自动将常用的 get绑定list，post绑定create这些操作完成。

urls中设置如下，上面的那两个设置就不需要了。

from rest_framework.routers import DefaultRouter
router = DefaultRouter()
router.register(‘goodsList’, GoodsListViewSet)

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

ReadOnlyModelViewSet

继承于GenericViewSet，混用RetrieveModelMixin，ListModelMixin。这样我们就既可以用它来访问列表，也可以用来访问详情。

源码

class ReadOnlyModelViewSet(mixins.RetrieveModelMixin,
                           mixins.ListModelMixin,
                           GenericViewSet):
    """
    A viewset that provides default `list()` and `retrieve()` actions.
    """
    pass

使用

class GoodsViewSet(viewsets.ReadOnlyModelViewSet):
    """
    商品列表
    商品详情
    """
    queryset = Goods.objects.all()
    # 序列化
    serializer_class = GoodsSerializer
    # 分页
    pagination_class = StandardResultsSetPagination

绑定router

router.register(‘goods’, GoodsViewSet)