视图层
两个视图基类
APIView
GenericAPIView
5个视图扩展类
from rest_framework.mixins import CreateModelMinin, UpdateModelMixin, DestroyModelMixin, RetrieveModelMixin, ListModelMixin
ListModelMixin 查询所有 list方法
RetrieveModelMixin 查单条 retrieve方法
CreateModelMinin 新增 create方法
UpdateModelMixin 修改 update方法
DestroyModelMixin 删除 destroy方法
用法:
这五个视图扩展类没有继承APIView及其子类,不能单独使用,必须配合GeneriacAPIView一起使用
由于五个接口已经被封装好了,那么我们只需要将接口与请求对应上即可
class BookView(GenericAPIView, ListModelMixin, CreateModelMixin):
queryset = Book.objects.all()
serializer_class = BookSerializer
def get(self, request):
return self.list(request)
def post(self, request):
return self.create(request)
class BookDetailView(GenericAPIView, RetrieveModelMixin, UpdateModelMixin, DestroyModelMixin):
queryset = Book.objects.all()
serializer_class = BookSerializer
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.destroy(request, *args, **kwargs)
9个视图子类
from rest_framework.generics import
ListAPIView, CreateAPIView, DestroyAPIView, RetrieveAPIView, UpdateAPIView, ListCreateAPIView, RetrieveDestroyAPIView, RetrieveUpdateAPIView, RetrieveUpdateDestroyAPIView
视图子类就是GenericAPIView + 五个视图扩展类,所以这九个视图子类可以直接继承,不需要再额外继承GenericAPIView
ListAPIView 查询所有
CreateAPIView 新增
ListCreateAPIView 查询所有,新增一个
RetrieveAPIView 查单个
UpdateAPIView 修改
DestroyAPIView 删除
RetrieveDestroyAPIView
RetrieveUpdateAPIView
RetrieveUpdateDestroyAPIView
用法:
需要哪个接口就继承哪个
class BookView(ListCreateAPIView): # 查询所有,新增一个
queryset = Book.objects.all()
serializer_class = BookSerializer
# 新增一个,修改一个,删除一个
class BookDetailView(RetrieveUpdateDestroyAPIView):
queryset = Book.objects.all()
serializer_class = BookSerializer
视图集
from rest_framework.viewsets import
ModelViewSet 五个接口都有 五个视图扩展类 + GenericAPIView
ReadOnlyModelViewSet 两个只读接口 RetrieveModelMixin + ListModelMixin + GenericViewSet
ViewSetMixin 没有继承,但是重写了as_view方法,以后只要继承了它,路由写法就变成了映射方法
ViewSet ViewSetMixin + APIView
GenericViewSet ViewSetMinin + GenericAPIView
由于ModelViewSet、ReadOnlyModelViewSet、ViewSet、GenericViewSet都继承了ViewSetMixin,所以在使用视图集是路由需要变,path('books/', views.BookView.as_view({'get': 'list', 'post': 'create'}))
get是前端发送的请求,list是视图类中的方法
举例:
# 路由
urlpatterns = [
path('books/', views.BookView.as_view({'get': 'list', 'post': 'create'})),
path('books/<int:pk>/', views.BookView.as_view({'get': 'retrieve', 'put': 'update', 'delete': 'destroy'})),
]
# 视图类
class BookView(ModelViewSet): # 查询所有,新增一个
queryset = Book.objects.all()
serializer_class = BookSerializer
重点:
以后,你想继承APIView,但是想变路由写法【视图类中方法名任意命名】,要继承ViewSet
以后,你想继承GenericAPIView,但是想变路由写法【视图类中方法名任意命名】,要继承GenericViewSet
ViewSetMinin源码分析
path('books/', views.BookView.as_view({'get': 'list', 'post': 'create'}))
以上面这个路由为例,路由来了以后执行as_view(),然后从视图类中查找,找不到就往上找父类,一级一级往上找,直到找到为止,这个我们在ViewSetMixin中找到了
ViewSetMixin中as_view的源码
@classonlymethod
def as_view(cls, actions=None, **initkwargs):
# 如果没有传actions,直接抛异常,其实就是路由写法变了后,as_view中不传字典,直接报错
if not actions:
raise TypeError("The `actions` argument must be provided when "
"calling `.as_view()` on a ViewSet. For example "
"`.as_view({'get': 'list'})`")
# ...其他代码不用看
def view(request, *args, **kwargs):
self = cls(**initkwargs)
if 'get' in actions and 'head' not in actions:
actions['head'] = actions['get']
# actions是传入的字典,{'get': 'list', 'post': 'create'}
self.action_map = actions
# method, action分别赋值actions中字典的键与值
for method, action in actions.items():
# 反射,去视图类中反射,获取action对应的方法,即获取actions中字典的值对应的方法
handler = getattr(self, action)
# 反射,将method对应的方法修改为handler的方法
# 也就是将视图类对象的get方法修改为list方法
setattr(self, method, handler)
return self.dispatch(request, *args, **kwargs) # 这个dispatch还是APIView的
# 去除了csrf校验
return csrf_exempt(view)
执行as_view()本质上还是执行as_view里面的view()
总结:
1.只要继承了ViewSetMixin的视图类,路由写法就变为传入字典映射方法{'get': 'list', 'post': 'create'}
传入actions,以后访问get就是访问list,访问post就是访问create
2.其他的和之前一样
3.以后只要继承了ViewSetMixin的视图类,视图类中的方法可以任意命名,只需要在路由中做好映射即可
rest_framework一览图
路由系统
自动生成路由
由于继承了ViewSetMinin之后,路由写法变成了传入字典映射的方式,比较麻烦,所以我们可以让路由自动生成
drf提供了两个路由类,继承了ModelViewSet后,路由可以自动生成
使用方法:
1.导入路由类
from rest_framework.routers import SimpleRouter, DefaultRouter
2.实例化得到对象
router = SimpleRouter()
3.注册
router.register('books', views.BookView, 'books')
第一个参数是路径不用带/,第二个参数是视图类,第三个参数是别名,一般与路径相同
4.在urlpatterns中注册(两种方式)
方式一
urlpatterns += router.urls
方式二
from django.urls import include
path('/api/v1/', include(router.urls))
action 装饰器
action 写在视图类的方法上,可以自动生成路由
使用方法
class SendView(ViewSet):
# method指定请求方法,可以传多个
# detail只能传True和False,True是不带id的路径(send/send_msg),False是带id的路径(send/2/send_msg)
@action(methods=['POST'], detail=False)
def send_msg(self, request):
pass
以后可以针对不同的请求方式使用不同的序列化类,针对不同的action使用不同的序列化类
class SendView(GenericViewSet):
queryset = None
serializer_class = '序列化类'
def get_serializer(self, *args, **kwargs):
if self.action=='lqz':
return '某个序列化类'
else:
return '另一个序列化列'
@action(methods=['GET'], detail=True)
def send_sms(self, request,pk):
print(pk)
# 手机号,从哪去,假设get请求,携带了参数
phone = request.query_params.get('phone')
print('发送成功,%s' % phone)
return Response({'code': 100, 'msg': '发送成功'})
@action(methods=['GET'], detail=True)
def lqz(self,request): # get
# 序列化类
pass
@action(methods=['GET'], detail=True)
def login(self,request): # get
# 序列化类
pass
标签:get,系统,self,request,视图,路由,view
From: https://www.cnblogs.com/zyg111/p/17096590.html