Django框架之drf：6、九个视图子类，视图集，路由系统，认证组件
Django框架之drf
目录
一、9个视图子类
通常在继承五个视图拓展类时，还需要继承GenericView才能够使用，9个视图子类是指由五个视图拓展类和GenericView搭配、组合出来的9个视图子类，在使用的时候，需要用到哪个就继承其中的哪一个
导入模块
from rest_framework.generics import ListAPIView, CreateAPIView, ListCreateAPIView,RetrieveAPIView, UpdateAPIView, DestroyAPIView, RetrieveUpdateAPIView,RetrieveDestroyAPIView,RetrieveUpdateDestroyAPIView
9个视图子类
| 视图子类 | 描述 |
|---|---|
| ListAPIView | 查询所有 |
| CreateAPIView | 新增 |
| ListCreateAPIView | 查询所有+新增 |
| RetrieveAPIView | 查询单个 |
| DestroyAPIView | 删除 |
| UpdateAPIView | 修改 |
| RetrieveDestroyAPIView | 查询单个+删除 |
| RetrieveUpdateAPIView | 查询单个+修改 |
| RetrieveUpdateDestroyAPIView | 查询单个+修改+删除 |
代码用法：
## 路由
urlpatterns = [
path('books/', views.BookView.as_view()),
path('books/<int:pk>/', views.BookView.as_view()),
]
## 视图类
# 查询所有，新增一个
class BookView(ListCreateAPIView):
queryset = Book.objects.all()
serializer_class = BookSerializer
# 新增一个，修改一个，删除一个
class BookDetailView(RetrieveUpdateDestroyAPIView):
queryset = Book.objects.all()
serializer_class = BookSerializer
二、视图集
1、ModelViewSet
ModelViewSet是继承了五个视图拓展类和GenericView的类，在我们使用的时候只需要直接继承ModelViewSet就可以同时拥有五个视图拓展类的功能和GenericView的功能
导入模块
from rest_framework.viewsets import ModelViewSet
代码用法：
在使用ModelViewSet（视图集）的时候，我们只需要编写一个视图类，这个时候原生的url路由接口就无法满足使用要求，因此我们需要在对url的路由进修改，在as_view()的参数内指定请求方式的键值对
# 路由
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
2、ReadOnlyModelView
继承ReadOnlyModelView的视图类只能查询所有和查询单个，属于只读接口
导入模块：
from rest_framework.viewsets import ReadOnlyModelViewSet
代码用法：
# 路由
urlpatterns = [
path('books/', views.BookView.as_view({'get': 'list'})),
path('books/<int:pk>/', views.BookView.as_view({'get': 'retrieve'})),
]
# 视图类
class BookView(ReadOnlyModelViewSet): # 查询所有，查询一个
queryset = Book.objects.all()
serializer_class = BookSerializer
3、ViewSetMixin
上面我们了解到，不管是继承了ModelViewSet或是ReadOnlyModelView，我们就需要url路由的as_view()后方参数指定请求方式，这是为什么呢?
ViewSetMixin源码分析
第一步：
请求来了，路由匹配成功---》get请求，匹配成功books，会执行 views.BookView.as_view({'get': 'list', 'post': 'create'})()------>读as_view【这个as_view是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']
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)
第二步：
路由匹配成功执行views.BookView.as_view({'get': 'list', 'post': 'create'})()----》本质是执行ViewSetMixin----》as_view----》内的view()
def view(request, *args, **kwargs):
#actions 是传入的字典--->{'get': 'list', 'post': 'create'}
self.action_map = actions
# 第一次循环：method：get，action:list
# 第一次循环：method：post，action:create
for method, action in actions.items():
# 反射：去视图类中反射，action对应的方法，action第一次是list，去视图类中反射list方法
# handler就是视图类中的list方法
handler = getattr(self, action)
# 反射修改：把method：get请求方法，handler：list
# 视图类的对象的get方法，变成了list
setattr(self, method, handler)
return self.dispatch(request, *args, **kwargs) #dispatch是APIView的
总结：
-1 只要继承ViewSetMixin的视图类，路由写法就变了(重写了as_veiw)
-2 变成需要需要传入字典映射方法：{'get': 'list', 'post': 'create'}
-只要传入actions，以后访问get就是访问list，访问post，就是访问create
-3 其他执行跟之前一样
-4 以后视图类类中的方法名，可以任意命名，只要在路由中做好映射即可【重要】
4、 from rest_framework.viewsets包下的类
from rest_framework.viewsets中包含以下几个类
- ModelViewSet
- 包含五个视图扩展类+ViewSetMixin+GenericView
- ReadOnlyModelViewSet
- 包含2个视图扩展类（只读）+ViewSetMixin+GenericAPIView
- ViewSetMixin：
- 给as_view()添加了新的功能，路由变成了映射方法
- ViewSet：
- ViewSetMixin+ APIView
- GenericViewSet:
- ViewSetMixin+ GenericAPIView
总结：
-以后，你想继承APIView，但是想变路由写法【视图类中方法名任意命名】，要继承ViewSet
-以后，你想继承GenericAPIView，但是想变路由写法【视图类中方法名任意命名】，要继承GenericViewSet
三、路由系统
1、自动生成路由
drf由于继承ViewSetMixin类，路由的写法就变了，有以下几种情况：
# 第一种：
path('books/', views.BookView.as_view()）
# 第二种：
path('books/', views.BookView.as_view({'get': 'list', 'post': 'create'}))
# 第三种：
自动生成
路由的自动生成：
继承了ViewSetMixin的视图函数类可以使用路由自动生成的方法
使用方法
第一步：# 导入路由类
from rest_framework.routers import SimpleRouter, DefaultRouter
第二步：# 实例化得到对象
router = SimpleRouter() # DefaultRouter可以生成跟路由
'''
DefaultRouter与SimpleRouter的区别是：
-DefaultRouter会多附带一个默认的API根视图，返回一个包含所有列表视图的超链接响应数据
-1、Api Root :访问根,可以看到有那些地址,比如book的,比如publish的
-2、给别的都起了别名,后期一般都用SimpleRouter
'''
第三步：# 注册路径
router.register('send', views.SendView, 'send')
'''
1、第一个参数是路径,不要带 /
2、第二个参数是视图类
3、第三个参数是别名,一般跟路径相同
4、router.register('books', views.BookView, 'books') # 路径和试图类建立关系 有几个视图类就要写几次
'''
第四步：# 在urlpatterns中注册,两种方式
方式一：
urlpatterns += router.urls # 类似于列表相加
方式二： # 使用include在路由内填写
urlpatterns = [
# 使用这种话方法可以在自动生成的路径前自定义路径前缀
path('api/v1/', include(router.urls)
]
总结：
# 自动生成路由：
-本质是自动做映射，能够自动成的前提是，视图类中要有 5个方法的某要给或多个
get--->list
get---->retrieve
put---->update
post---->create
delete---->destory
-ModelViewSet，ReadOnlyModelViewSet，可以自动生成
-9个试图子类+配合ViewSetMixin，才可以自动生成
-GenericAPIView+5个试图扩展类+配合ViewSetMixin，才能自动生成
2、action装饰器
在使用自动生成路由的时候，必须要继承含有5个视图扩展类的类和ViewsSetMixin才可以自动生成路由，但是很多时候我们并不需要这五个试图扩展类，例如写发送短信的功能的时候并不涉及数据库，所以用不到5个视图扩展类，这个时候我们可以通过使用action装饰器，来进行自动生成路由
导入模块:
from rest_framework.decorators import action
代码用法：
## 路由层
from django.urls import path, include
from app01 import views
# 第一步：导入模块
from rest_framework.routers import SimpleRouter
# 第二步：实例化对象
router = SimpleRouter()
# 第三步：注册路由
router.register('send', views.SendView, 'send')
# 第四步：使用include方式生成路径
urlpatterns = [
path('', include(router.urls))
]
## 视图层
class SendView(ViewSet):
@action(methods=['GET'], detail=False, url_path='send', url_name='send')
def send_sms(self, request):
# self.action可以拿到该请求方式的路径
print(self.action)
phone = request.query_params.get('phone')
print('发送成功,%s')
return Response({'code': 100, 'msg': '发送成功'})
@action(methods=['GET'], detail=True)
def login(self, request,pk): # get
return Response('登录成功')
@action(methods=['GET'], detail=True)
def register(self, request): # get
return Response('注册成功')
总结：
# action基本参数和属性
-基本参数：
methods # 必填参数，列表内填写请求方式，可写多种
detail # 必填参数，True可以生成带id的路径，False为正常路径
url_path # 可以不填，默认函数名为路径，指定后按指定的名称为路径
url_name # 可以不填 ，别名
- 属性：
self.action # 可以拿到当前当前函数的名称
补充
# 补充：
-1 不同请求方式可以使用不同序列化类
-2 不同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):
phone = request.query_params.get('phone')
print('发送成功,%s' % phone)
return Response({'code': 100, 'msg': '发送成功'})
4、认证组件
介绍：
认证组件：用于存储用户登录状态，访问某个接口，需要登陆后才能访问
拓展：
- uuid模块：
- 介绍：用于生成一个随机的字符串
- 导入模块：import uuid
- 生成随机字符串：token = str(uuid.uuid4()）
1、登录接口
#### 表模型
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': '用户名或密码错误'})
