标签：drf6 get self actions 视图 路由 view
今日内容概要
今日内容详细
9个视图子类
from rest_framework.generics import CreateAPIView, ListAPIView, UpdateAPIView, RetrieveAPIView, ListCreateAPIView, DestroyAPIView, RetrieveUpdateAPIView, RetrieveUpdateDestroyAPIView, RetrieveDestroyAPIView
CreateAPIView 封装了post方法
ListAPIView 封装了get方法 查询多个
RetrieveAPIView 封装了get方法 查询单个
UpdateAPIView 封装了put和patch方法
DestroyAPIView 封装了delete方法
ListCreateAPIView 封装了get和post方法
RetrieveUpdateAPIView 封装了get/put/patch方法
RetrieveUpdateDestroyAPIView 封装了get/put/patch/delete方法
RetrieveDestroyAPIView 封装了get和delete方法
这9个视图子类不需要额外继承GenericAPIView 只需要继承其中的几个或某个就行
用法
class 视图类名(要继承的视图子类):
queryset = queryset对象
serializer_class = 序列化类
视图集
from rest_framework.viewsets import ModelViewSet
通过ModelViewSet编写5个接口
视图类
class BookView(ModelViewSet):
queryset = Book.objects.all()
serializer_class = BookSerializer
路由
urlpatterns = [
path('books/', views.BookView.as_view({'get':'list', 'post': 'create'})),
patch('books/<int:pk>/', views.BookView.as_view({'get':'retrieve','put':'update','delete':'destroy'}))
]
路由中的写法通过给as_view传字典的形式来区分请求方式与对应动作 k是请求方式 v是动作
视图集类不再实现get()、post()等方法，而是实现动作 action 如 list() 、create() 只在使用as_view()方法的时候，才会将action动作与具体请求方式对应上。如：
list 提供一组数据
retrieve 提供单个数据
create 创建数据
update 保存数据
destroy 删除数据
如何实现的呢 查看源码
查看源码发现ModelViewSet继承了5个视图扩展类和GenericViewSet--->查看GenericViewSet--->继承了ViewSetMixin和GenericAPIView---->查看ViewSetMixin--->重写了as_view
@classonlymethod
def as_view(cls, actions=None, **initkwargs):
# actions是传入的字典
# 如果没有传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'})`")
# 也重写了view方法
def view(request, *args, **kwargs):
self = cls(**initkwargs)
if 'get' in actions and 'head' not in actions:
actions['head'] = actions['get']
self.action_map = actions
for method, action in actions.items():
handler = getattr(self, action)
setattr(self, method, handler)
return self.dispatch(request, *args, **kwargs)
# 去除了csrf校验
return csrf_exempt(view)
当路由匹配成功执行view
def view(request, *args, **kwargs):
#actions 是传入的字典--->{'get': 'list', 'post': 'create'}
self.action_map = actions
# 循环获取请求方式与动作
for method, action in actions.items():
# 反射：去视图类中反射，对应的方法 第一次是list，去视图类中反射list方法
# handler就是视图类中的list方法
handler = getattr(self, action)
# 通过反射 给对象添加get方法但调用的其实是list方法
setattr(self, method, handler)
return self.dispatch(request, *args, **kwargs) #dispatch是APIView的
总结
1.只要继承了ViewSetMixin的视图类 路由写法就变了 因为重写了as_view方法
2.变成传入字典映射的方法 {'get': 'list','post':'create'}
3.执行方式和之前一样
4.以后视图类中的方法名可以任意命名 只要在路由中做好映射即可
所有的视图集
ModelViewSet 5个视图扩展类+ViewSetMixin+GenericAPIView
ReadOnlyModelViewSet 2个只读的视图扩展类+ViewSetMixin+GenericAPIView
ViewSetMixin 重写了as_view 只要继承了它 那么以后路由写法都变成了映射方法
ViewSet ViewSetMixin+APIView
GenericViewSet ViewSetMixin+GenericAPIView
视图层大总结
1.两个视图基类
APIView和GenericAPIView
2.有5个视图扩展类 不是视图类 必须配合GenericAPIView使用
3.有9个视图子类 是视图类 可以直接继承使用
4.视图集
基于视图集举个例子
class SendView(ViewSet):
def send(self, request):
return Response('发送成功')
路由写法
path('send/', views.SendView.as_view({'get': 'send'})),
路由组件
当视图类继承了ModelViewSet后路由的写法就变了
所以原生django+drf后的路由写法就会有三种情况
path('books/', views.BookView.as_view())
path('books/', views.BookView.as_view({'get':'list'}))
自动生成 通过路由组件实现
from rest_framework import routers
drf提供了两个路由类 分别是
SimpleRouter
DefaultRouter
DefaultRouter与SimpleRouter的区别是，DefaultRouter会多附带一个默认的API根视图，返回一个包含所有列表视图的超链接响应数据
使用方法
1.导入路由类
2.实例化得到对象(有两个 一般使用SimpleRouter)
router = routers.SimpleRouter()
3.注册 router.register('前缀', 视图类, '别名')
4.在urlpatterns中注册 两种方式
方式一: urlpatterns +=router.urls
方式二: path('前缀/', include(router.urls)) # 一般这种方法使用的比较多
底层实现 本质是自动做映射 能够自动生成的前提是视图类中要有5个方法的某个或者多个
get---》list
get---》retrieve
put---》update
post---》create
delete---》destroy
ModelViewSet，ReadOnlyModelViewSet可以自动生成
9个视图子类配合ViewSetMixin才可以自动生成
GenericAPIView+5个视图扩展类配合ViewSetMixin才可以自动生成
action装饰器
在视图类的方法上添加该装饰器 可以自动生成路由
是个有参装饰器 其中参数有
methods 指定请求方法 以列表形式传入 不传默认get
detail 只能传True与False 是否带id的路径
url_path 生成send后路径的名字 默认以方法名命名
url_name 别名 反向解析使用
使用步骤
class SendView(ViewSet):
@action(methods=['get'], detail=False)
def send(self, request):
return Response('发送成功')
补充:
不同的请求方式使用不同的序列化类 以及使用action装饰器如何实现
class 视图类名(GenericViewSet):
queryset = queryset对象
serializer_class = 序列化类
# 重写GenericAPIView下的get_serializer方法
def get_serializer(self, *args, **kwargs):
# 该方法可以获取到被装饰的方法名
if self.action == 条件:
return 某个序列化类
else:
return 某个序列化类
认证组件
用于在访问某个接口时需要登录才能够访问
先写一个登录接口
#### 表模型
class User(models.Model):
username = models.CharField(max_length=32)
password = models.CharField(max_length=32)
class UserToken(models.Model): # 跟User是一对一
token = models.CharField(max_length=32)
user = models.OneToOneField(to='User', on_delete=models.CASCADE, null=True)
# user :反向，表名小写，所有有user字段
### 路由
router.register('user', views.UserView, 'user') # /api/v1/user/login post 请求
# 视图类
#### 登录接口 自动生成路由+由于登录功能，不用序列化，继承ViewSet
from .models import User, UserToken
import uuid
class UserView(ViewSet):
@action(methods=['POST'], detail=False)
def login(self, request):
username = request.data.get('username')
password = request.data.get('password')
user = User.objects.filter(username=username, password=password).first()
if user:
# 用户存在，登录成功
# 生成一个随机字符串--uuid
token = str(uuid.uuid4()) # 生成一个永不重复的随机字符串
# 在userToken表中存储一下：1 从来没有登录过，插入一条， 2 登录过，修改记录
# 如果有就修改，如果没有就新增 (if 自己写)
# kwargs 传入的东西查找，能找到，使用defaults的更新，否则新增一条
UserToken.objects.update_or_create(user=user, defaults={'token': token})
return Response({'code': '100', 'msg': '登录成功', 'token': token})
else:
return Response({'code': '101', 'msg': '用户名或密码错误'})
标签：drf6,
get,
self,
actions,
视图,
路由,
view
From： https://www.cnblogs.com/lzjjjj/p/17096722.html