View视图
from rest_framework import mixins
mixins.CreateModelMixin, # 创建数据
mixins.RetrieveModelMixin, # 单个查询数据
mixins.UpdateModelMixin, # 覆盖替换数据
mixins.DestroyModelMixin, # 删除数据
mixins.ListModelMixin, # 列表查询数据
视图的作用
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 GoodsSerializer(serializers.ModelSerializer):
images = GoodImagesSerializer(many=True)
class Meta:
model = Goods
fields = "__all__"
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)
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)
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'})),
]
ModelViewSet
继承自GenericViewSet
,同时包括了ListModelMixin
、RetrieveModelMixin
、CreateModelMixin
、UpdateModelMixin
、DestoryModelMixin
。
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)
访问接口
- 访问商品列表
http://127.0.0.1:8000/goods/ - 访问商品详情
http://127.0.0.1:8000/goods/1
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'})
]
继承自APIView
与ViewSetMixin
,作用也与APIView基本类似,提供了身份认证、权限校验、流量管理等。
ViewSet主要通过继承ViewSetMixin来实现在调用as_view()时传入字典(如{'get':'list'}
)的映射处理工作。
在ViewSet中,没有提供任何动作action方法,需要我们自己实现action方法。