Django REST framework - 视图组件
视图继承关系
视图
REST framework 提供了众多的通用视图基类与扩展类，以简化视图的编写。
2个视图基类
APIView
APIView 是REST framework提供的所有视图的基类，继承自Django的View父类。
from rest_framework.views import APIView
APIView与View的不同之处在于：
传入到视图方法中的是REST framework的Request对象，而不是Django的HttpRequeset对象；
视图方法可以返回REST framework的Response对象，视图会为响应数据设置（render）符合前端要求的格式；
任何APIException异常都会被捕获到，并且处理成合适的响应信息；
在进行dispatch()分发前，会对请求进行身份认证、权限检查、流量控制。
支持定义的类属性
authentication_classes 列表或元祖，身份认证类
permissoin_classes 列表或元祖，权限检查类
throttle_classes 列表或元祖，流量控制类
在APIView中仍以常规的类视图定义方法来实现get() 、post() 或者其他请求方式的方法
GenericAPIView
继承自APIVIew，主要增加了操作序列化器和数据库查询的方法，作用是为下面Mixin扩展类的执行提供方法支持。通常在使用时，可搭配一个或多个Mixin扩展类。
from rest_framework.generics import GenericAPIView
GenericAPIView(APIView):做了一些封装
-属性：
queryset # 要序列化的数据
serializer_class # 指明视图使用的序列化器
-方法：
get_queryset：获取qs数据(返回视图使用的查询集，主要用来提供给Mixin扩展类使用，
是列表视图与详情视图获取数据的基础，默认返回queryset属性)
get_object：获取一条数据的对象(返回详情视图所需的模型类数据对象，主要用来
提供给Mixin扩展类使用。在试图中可以调用该方法获取详情信息的模型类对象)
get_serializer：以后使用它来实例化得到ser对象(返回序列化器对象，主要用来
提供给Mixin扩展类使用，如果我们在视图中想要获取序列化器对象，也可以直接调用此方法)
get_serializer_class：获取序列化类，注意跟上面区分
5个视图扩展类
1 查所有：ListModelMixin
列表视图扩展类，提供list(request, *args, **kwargs)方法快速实现列表视图，返回200状态码。
该Mixin的list方法会对数据进行过滤和分页。
2 查一个：RetrieveModelMixin
创建视图扩展类，提供create(request, *args, **kwargs)方法快速实现创建资源的视图，成功返回201状态码。
如果序列化器对前端发送的数据验证失败，返回400错误。
3 增一个：CreateModelMixin
详情视图扩展类，提供retrieve(request, *args, **kwargs)方法，可以快速实现返回一个存在的数据对象。
如果存在，返回200， 否则返回404
4 改一个：UpdateModelMixin
更新视图扩展类，提供update(request, *args, **kwargs)方法，可以快速实现更新一个存在的数据对象。
同时也提供partial_update(request, *args, **kwargs)方法，可以实现局部更新。
成功返回200，序列化器校验数据失败时，返回400错误。
5 删一个：DestroyModelMixin
删除视图扩展类，提供destroy(request, *args, **kwargs)方法，可以快速实现删除一个存在的数据对象
成功返回204，不存在返回404。
9个视图子类
# 9个子类视图(rest_framework.generics)
1 ListAPIView （查所有）
2 RetrieveAPIView （查一个）
3 DestroyAPIView（删一个）
4 UpdateAPIView （改一个）
5 CreateAPIView （增一个）
6 ListCreateAPIView (查所有+增一个)
7 RetrieveDestroyAPIView (查一个+删一个)
8 RetrieveUpdateAPIView (查一个+改一个)
9 RetrieveUpdateDestroyAPIView (查一个+删一个+改一个)
CreateAPIView:继承CreateModelMixin,GenericAPIView，有post方法，新增数据
DestroyAPIView：继承DestroyModelMixin,GenericAPIView，有delete方法，删除数据
ListAPIView：继承ListModelMixin,GenericAPIView,有get方法获取所有
UpdateAPIView：继承UpdateModelMixin,GenericAPIView，有put和patch方法，修改数据
RetrieveAPIView：继承RetrieveModelMixin,GenericAPIView，有get方法，获取一条
ListCreateAPIView：继承ListModelMixin,CreateModelMixin,GenericAPIView，有get获取所有，post方法新增
RetrieveDestroyAPIView：继承RetrieveModelMixin,DestroyModelMixin,GenericAPIView，有get方法获取一条，delete方法删除
RetrieveUpdateAPIView：继承RetrieveModelMixin,UpdateModelMixin,GenericAPIView，有get获取一条，put，patch修改
RetrieveUpdateDestroyAPIView：继承RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin,GenericAPIView，有get获取一条，put，patch修改，delete删除
视图集
ViewSetMixin：重写了as_view
ViewSet： 继承ViewSetMixin和APIView
GenericViewSet：继承ViewSetMixin, generics.GenericAPIView
ModelViewSet：继承mixins.CreateModelMixin,mixins.RetrieveModelMixin,mixins.UpdateModelMixin,mixins.DestroyModelMixin,mixins.ListModelMixin,GenericViewSet
ReadOnlyModelViewSet：继承mixins.RetrieveModelMixin,mixins.ListModelMixin,GenericViewSet
GenericAPIView基类（初级方法）
视图
# 只需要修改定义方法的数据和类
class PublishViews(GenericAPIView):
queryset = models.Publish.objects.all() # 序列化的数据
serializer_class = serializer.PublishModelSerializer # 序列化的类
def get(self, request, *args, **kwargs):
response = {'status': 200, 'msg': '查询'}
try:
qs = self.get_queryset()
ser = self.get_serializer(instance=qs, many=True) # many全部
# return Response(ser.data)
# book.data字典加入到data列表里
response['data'] = ser.data
except Exception as e:
# 返回错误信息
response['msg'] = str(e)
return Response(response)
# 增加
def post(self, request, *args, **kwargs):
response = {'status': 200, 'msg': '新增'}
try:
ser = self.get_serializer(data=request.data)
if ser.is_valid():
ser.save()
response['data'] = ser.data
else:
response['msg'] = ser.errors
except Exception as e:
response['msg'] = str(e)
return Response(response)
class PublishViewsId(GenericAPIView):
queryset = models.Publish.objects.all() # 序列化的数据
serializer_class = serializer.PublishModelSerializer # 序列化的类
# 查询一个
def get(self, request, *args, **kwargs):
response = {'status': 200, 'msg': '成功'}
try:
# 取出id
obj = self.get_object()
# 序列化
ser = self.get_serializer(instance=obj)
# book.data字典加入到data列表里
response['data'] = ser.data
except Exception as e:
# 返回错误信息
response['msg'] = str(e)
return Response(response)
# 修改数据
def put(self, request, *args, **kwargs):
response = {'status': 200, 'msg': '成功'}
try:
# 取出id
obj = self.get_object()
# 拿到id号反序列化
ser = self.get_serializer(instance=obj, data=request.data)
# 校验
if ser.is_valid():
ser.save()
response['data'] = ser.data
else:
response['msg'] = ser.errors
except Exception as e:
# 返回错误信息
response['msg'] = str(e)
return Response(response)
# 删除
def delete(self, request, *args, **kwargs):
# 查询到id号
res = self.get_object().delete()
# 判断第一个删除
if res[0] > 0:
return Response('')
else:
return Response('删除的不存在')
序列化类
from rest_framework import serializers
from restful import models
# 继承ModelSerializer类
class PublishModelSerializer(serializers.ModelSerializer):
class Meta:
model = models.Publish
# __all__ 查询所有
fields = '__all__'
路由
from restful import views
urlpatterns = [
path('publish/<int:pk>/', views.PublishViewsId.as_view()),
path('publish/', views.PublishViews.as_view()),
]
settings配置app（注意记得配置数据库也可以用自带sqllite3)
INSTALLED_APPS = [
'rest_framework'
]
models 表模型(注意迁移)
from django.db import models
class Book(models.Model):
nid = models.AutoField(primary_key=True)
name = models.CharField(max_length=32)
price = models.DecimalField(max_digits=5, decimal_places=2)
publish_date = models.DateField()
publish = models.ForeignKey(to='Publish', to_field='nid', on_delete=models.CASCADE)
authors = models.ManyToManyField(to='Author')
def __str__(self):
return self.name
class Author(models.Model):
nid = models.AutoField(primary_key=True)
name = models.CharField(max_length=32)
age = models.IntegerField()
author_detail = models.OneToOneField(to='AuthorDatail', to_field='nid', unique=True, on_delete=models.CASCADE)
def __str__(self):
return self.name
class AuthorDatail(models.Model):
nid = models.AutoField(primary_key=True)
telephone = models.BigIntegerField()
birthday = models.DateField()
addr = models.CharField(max_length=64)
def __str__(self):
return self.addr
class Publish(models.Model):
nid = models.AutoField(primary_key=True)
name = models.CharField(max_length=32)
city = models.CharField(max_length=32)
email = models.EmailField()
def __str__(self):
return self.name
admin配置(注意创建用户 createsuperuser)
from django.contrib import admin
from restful import models
admin.site.register(models.Book)
admin.site.register(models.Author)
admin.site.register(models.AuthorDatail)
admin.site.register(models.Publish)
GenericAPIView视图扩展类（中级方法，其它序列化类路由配置同上）
视图层
from restful import models
from restful import serializer
from rest_framework.generics import GenericAPIView
from rest_framework.mixins import ListModelMixin,CreateModelMixin,UpdateModelMixin,DestroyModelMixin,RetrieveModelMixin
class PublishViews(GenericAPIView, ListModelMixin, CreateModelMixin):
queryset = models.Publish.objects.all() # 序列化的数据
serializer_class = serializer.PublishModelSerializer # 序列化的类
def get(self, request, *args, **kwargs):
return self.list(request, *args, **kwargs)
def post(self, request, *args, **kwargs):
return self.create(request, *args, **kwargs)
class PublishViewsId(GenericAPIView, RetrieveModelMixin, DestroyModelMixin, UpdateModelMixin):
queryset = models.Publish.objects.all() # 序列化的数据
serializer_class = serializer.PublishModelSerializer # 序列化的类
def get(self, request, *args, **kwargs):
return self.retrieve(request, *args, **kwargs)
def put(self, request, *args, **kwargs):
return self.update(request, *args, **kwargs)
def delete(self, request, *args, **kwargs):
return self.delete(request, *args, **kwargs)
GenericAPIView视图子类类（高级方法，其它序列化类路由配置同上）
视图层
from rest_framework.generics import ListAPIView,CreateAPIView,RetrieveAPIView,UpdateAPIView,DestroyAPIView,
from rest_framework.generics import ListCreateAPIView,RetrieveUpdateAPIView,RetrieveDestroyAPIView,RetrieveUpdateDestroyAPIView
from restful import models
from restful import serializer
class PublishViews(ListCreateAPIView):
queryset = models.Publish.objects.all() # 序列化的数据
serializer_class = serializer.PublishModelSerializer # 序列化的类
class PublishViewsId(RetrieveUpdateDestroyAPIView):
queryset = models.Publish.objects.all() # 序列化的数据
serializer_class = serializer.PublishModelSerializer # 序列化的类
GenericAPIView视图集类 （超级方法，序列化类表模型配置同上）
视图层
from rest_framework.viewsets import ModelViewSet, ReadOnlyModelViewSet
from rest_framework.viewsets import ViewSet, GenericViewSet, ViewSetMixin
# ModelViewSet五个接口都有
# ReadOnlyModelViewSet 只有读的两个接口
class PublishViews(ModelViewSet):
queryset = models.Publish.objects.all() # 序列化的数据
serializer_class = serializer.PublishModelSerializer # 序列化的类
路由层
from restful import views
urlpatterns = [
path('publish/', views.PublishViews.as_view({'get':'list', 'post':'create'})),
path('publish/<int:pk>/', views.PublishViews.as_view({'get':'retrieve', 'put':'update', 'delete':'destroy'})),
]
总结
1 序列化器源码
-many参数控制，在__new__中控制了对象的生成
-局部和全局钩子源码：is_valid--》找self.方法一定要从根上找
-source参数是如何执行的：‘publish.name’,'方法'
2 视图：
-2个视图基类
-5个视图扩展类
-9个视图子类
-视图集
-ViewSetMixin
-ViewSet, GenericViewSet
-ModelViewSet, ReadOnlyModelViewSet
3 视图类的继承原则
-如果不涉及数据库操作：继承APIView
-如果想让路由可以映射：继承ViewSetMixin
-如果不涉及数据库操作，又要让路由可以映射：继承ViewSet
-比如发邮件接口，发短信接口
-如果涉及到数据库操作：继承GenericAPIView
-如果想让路由可以映射：继承ViewSetMixin
-如果涉及数据库操作，又要让路由可以映射：继承GenericViewSet
-如果涉及数据库操作，又要让路由可以映射，还要能新增：继承GenericViewSet+CreateModelMixin或者继承ViewSetMixin+CreateAPIView
-如果只涉及到数据库操作和新增：继承CreateAPIView
-路由有映射，数据库操作，3个接口（查一个，删一个改一个）
4 ViewSetMixin：路由的写法就特殊了
5 类实例化，先执行了元类的__call__:调用了这个类的__new__,生成一个空对象，调用了类的__init__,完成了对象的初始化
6 对象()---->会触发类的 __call__
7 类()----->会触发类的类（元类）的__call__
浙公网安备 33010602011771号