1. 类视图
写视图的步骤:
1. 数据库查询, 2. 构建序列化器, 进行序列化操作, 返回数据
一. 两大基类
>1 APIView (以常规的方法实现get post put delet 等)
继承与VIew, 可以帮助我们处理request和response
可以捕获异常处理, 处理成适合的响应信息
进行第三patch()分发前, 对用户进行身份验证, 权限验证, 流量控制
支持的定义属性:
authentication_classes 列表或元祖，身份认证类
permissoin_classes 列表或元祖，权限检查类
throttle_classes 列表或元祖，流量控制类
举例：
<wiz_code_mirror>
返回书籍的列表信息
from rest_framework.views import APIView
from rest_framework.response import Response
# url(r'^books/$', views.BookListView.as_view()),
class BookListView(APIView):
def get(self, request):
# 数据库查询
books = BookInfo.objects.all()
# 构建序列化器, 进行序列化操作
serializer = BookInfoSerializer(books, many=True)
return Response(serializer.data)
>2 GenericsAPIView 继承于 APIView
支持定义的属性：
列表视图与详情视图通用：
queryset 列表视图的查询集 查询单一, 所有
serializer_class 视图使用的序列化器 指明序列化器
列表视图使用：
pagination_class 分页控制类
filter_backends 过滤控制后端
详情页视图使用：
lookup_field 查询单一数据库对象时使用的条件字段，默认为'pk'
lookup_url_kwarg 查询单一数据时URL中的参数关键字名称，默认与look_field相同
提供的方法：
列表视图与详情视图通用：
get_queryset(self)
返回视图使用的查询集，是列表视图与详情视图获取数据的基础，默认返回queryset属性，可以重写，例如：
<wiz_code_mirror>
def get_queryset(self):
user = self.request.user
return user.accounts.all()
get_serializer_class(self) # 构建序列化对象
返回序列化器类，默认返回serializer_class，可以重写，例如：
<wiz_code_mirror>
def get_serializer_class(self):
if self.request.user.is_staff:
return FullAccountSerializer
return BasicAccountSerializer
get_serializer(self, args, *kwargs)
返回序列化器对象，被其他视图或扩展类使用，如果我们在视图中想要获取序列化器对象，可以直接调用此方法。
注意，在提供序列化器对象的时候，REST framework会向对象的context属性补充三个数据：request(当前请求对象是谁)、format、view，这三个数据对象可以在定义序列化器时使用。
详情视图使用：
get_object(self)
返回详情视图所需的模型类数据对象，默认使用lookup_field参数来过滤queryset。 在试图中可以调用该方法获取详情信息的模型类对象。
若详情访问的模型类对象不存在，会返回404。
该方法会默认使用APIView提供的check_object_permissions方法检查当前对象是否有权限被访问。
举例：
<wiz_code_mirror>
# 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() # 获取单一的查询
serializer = self.get_serializer(book)
return Response(serializer.data)
二. 五个扩展类
>1. ListModelMixin
查询所有数据的扩展类, 该视图提供 list(request, *args, **kwargs) 实现列表视图, 返回200
list方法对数据进行过滤和分页. -------> 查询出过滤分页后所有的数据
源代码:
<wiz_code_mirror>
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)
demo
<wiz_code_mirror>
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错误
源代码
<wiz_code_mirror>
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
源代码:
<wiz_code_mirror>
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)
举例:
<wiz_code_mirror>
class BookDetailView(RetrieveModelMixin, GenericAPIView):
queryset = BookInfo.objects.all() # 查询所有的对象集
serializer_class = BookInfoSerializer # 指定序列化器
def get(self, request, pk):
return self.retrieve(request)
>4UpdateModelMixin
更新视图扩展类, 提供update(request, *args, *kwargs), 更新一个存在的对象
同时也提供partial_update(request, *args, **kwargs)方法，可以实现局部更新。
成功返回200，序列化器校验数据失败时，返回400错误。
源代码:
<wiz_code_mirror>
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):
#如果'prefetch_related'已经应用到一个queryset，我们需要
#强制使实例上的预取缓存失效。
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
源代码:
<wiz_code_mirror>
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()
3. 几个可用子类视图
1） CreateAPIView
提供 post 方法
继承自： GenericAPIView、CreateModelMixin
2）ListAPIView
提供 get 方法
继承自：GenericAPIView、ListModelMixin
33
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
三. 视图集 ViewSet
使用视图集ViewSet，可以将一系列逻辑相关的动作放到一个类中：
list() 提供一组数据
retrieve() 提供单个数据
create() 创建数据
update() 保存数据
destory() 删除数据
ViewSet视图集类不再实现get()、post()等方法，而是实现动作 action 如 list() 、create() 等。
视图集只在使用as_view()方法的时候，才会将action动作与具体请求方式对应上
例子:
<wiz_code_mirror>
class BookInfoViewSet(viewsets.ViewSet):
def list(self, request):
...
def retrieve(self, request, pk=None):
...
在设置路由时，我们可以如下操作
<wiz_code_mirror>
urlpatterns = [
url(r'^books/$', BookInfoViewSet.as_view({'get':'list'}),
url(r'^books/(?P<pk>\d+)/$', BookInfoViewSet.as_view({'get': 'retrieve'}),
]
action属性
在视图集中, 我们可以通过action对象属性来获取当前请求视图集的action的动作是谁
例如;
<wiz_code_mirror>
def get_serializer_class(self):
if self.action == 'create':
return OrderCommitSerializer
else:
return OrderDataSerializer
常用的视图集父类
1.ViewSet
继承自APIView，作用也与APIView基本类似，提供了身份认证、权限校验、流量管理等。
在ViewSet中，没有提供任何动作action方法，需要我们自己实现action方法。
2.GenericViewSet
继承自
GenericAPIView，作用也与GenericAPIVIew类似，提供了get_object、get_queryset等方法便于列表视图与详情信息视图的开发。
3.ModelViewSet
继承自GenericAPIVIew，同时包括了ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestoryModelMixin。
4.ReadOnlyModelViewSet
继承自GenericAPIVIew，同时包括了ListModelMixin、RetrieveModelMixin。
视图集中定义附加action动作
添加自定义动作需要使用rest_framework.decorators.action装饰器。
以action装饰器装饰的方法名会作为action动作名，与list、retrieve等同。
action装饰器可以接收两个参数：
methods: 该action支持的请求方式，列表传递
detail: 表示是action中要处理的是否是视图资源的对象（即是否通过url路径获取主键）
True 表示使用通过URL获取的主键对应的数据对象
False 表示不使用URL获取主键
例子:
<wiz_code_mirror>
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对象
def latest(self, request):
"""
返回最新的图书信息
"""
book = BookInfo.objects.latest('id')
serializer = self.get_serializer(book)
return Response(serializer.data)
# detail为True，表示要处理具体与pk主键对应的BookInfo对象
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)
url的定义
urlpatterns = [
url(r'^books/$', views.BookInfoViewSet.as_view({'get': 'list'})),
url(r'^books/latest/$', views.BookInfoViewSet.as_view({'get': 'latest'})),
url(r'^books/(?P<pk>\d+)/$', views.BookInfoViewSet.as_view({'get': 'retrieve'})),
url(r'^books/(?P<pk>\d+)/read/$', views.BookInfoViewSet.as_view({'put': 'read'})),
]
四. 路由的选择器Routers
对于视图集ViewSet, 除了我们自己指明请求方式与动作action之间的对应关系外, 也可以使用Routers来帮助我们实现路由信息
Rest Framework 提供了两个 router
---SimpleRouter
---DefaultRouter
两者之间的区别:
DefaultRouter会多附带一个默认的API根视图，返回一个包含所有列表视图的超链接响应数据。
使用步骤:
>1.创建router对象, 并注册视图集, 例如
<wiz_code_mirror>
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 路由名称的前缀
如上述代码会形成的路由如下：
<wiz_code_mirror>
^books/$ name: book-list
^books/{pk}/$ name: book-detail
>2. 添加路由数据
<wiz_code_mirror>
urlpatterns = [
.........
]
urlpatterns += router.urls
或者
<wiz_code_mirror>
urlpatterns = [
.....
url(r'^', include(router.urls))
]
1. 视图集中包含附加action的
<wiz_code_mirror>
class BookInfoViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet):
queryset = BookInfo.objects.all()
serializer_class = BookInfoSerializer
def latest(self, request):
...
def read(self, request, pk):
...
此视图集会形成的路由：
^books/latest/$ name: book-latest
^books/{pk}/read/$ name: book-read