drf从入门到精通---day06(9个视图子类,视图集,路由系统,认证组件)
今日内容
- 昨日回顾
- 9个视图子类
- 视图集
- 路由系统
- 认证组件
上节回顾
# 1 前后端开发模式:分离与混合两种
对于前后端分离的开发模式来说:
只要用的是http 通信, 后端都是web后端
前端无论是 pc桌面开发、web开发、app、还是小程序 这些通通都可以通过http来调用后端
所以后端写一套,就可以通用!!!
# 2 api接口
# 3 接口测试工具
# 4 restful规范 10条
# 5 drf介绍,快速使用
# 6 cbv 执行流程
as_view到view到dispatch
# 7 APIView执行流程
1 去除了所有的csrf
2 包装了新的request,以后在视图类中用的request是新的request 原生的在:新的requets._request里面
3 在执行视图类的方法之前,执行了3大认证
4 如果在3大认证或视图函数方法执行过程中出了错,会有异常捕获----》全局异常捕获
# 8 Request对象源码
-1 新的request用起来,跟之前一模一样,因为新的取不到,会取老的。
-2 request.data 无论什么编码,什么请求方式,只要是body中的数据,就从这里取,取出来就是字典
-3 request.query_params 就是原来的request._request.GET
-4 上传的文件从request.FILES
# 9 序列化和反序列化
# 10 序列化组件---展现形式写一个类继承,并在视图类里面实例化得到对象
功能:做序列化、做反序列化、数据校验
-常用字段和字段参数
-做序列化
-序列化类实例化生成对象---》传入要序列化的数据,many=True----ser.data
-source
-SerializerMethodField
-在表模型中写方法
-ListField
-DictField
-做反序列化
-新增
-序列化类实例化---》对象---》传入前端的数据----》数据校验---》ser.save
-数据校验:字段自己,局部,全局钩子
-修改
-序列化类实例化---》对象---》传入前端的数据和要修改的数据----》数据校验---》ser.save
-数据校验:字段自己,局部,全局钩子
-重点:
有时候,序列化字段和反序列化字段,不一样
-定制的序列化字段,不能用来反序列化
-read_only和write_only 的使用
-ModelSerializer,跟表有关系,好处:
-正常不用重写create和update
-字段可以映射过来
-也可以重写字段
-可以给字段类传参数---》extra_kwargs
-定制字段,跟之前一模一样
-fields 列表,必须要有所有字段(序列化,反序列化都要注册----》一定是表模型的字段吗? 不是)
------------------------------------------------
# 11 请求与响应
-Request 源码
-能够解析的编码格式
-全局配置
-局部配置
-Response 源码
-能够响应的编码格式
-全局
-局部
-drf向响应头中写数据
-原生django向响应头中写数据
obj=HttpResponse()
obj['xx']=yy
return obj
对象里面重写了__setitem__方法,所以才支持obj['xx']=yy这种语法的
------------------------------------------------
# 12 视图 View
-两个视图基类:APIView GenericAPIView
-APIView
-执行流程:新的reqeust,三大认证,全局异常
-重写了as_view与dispatch
-类属性:parser_class,render_class
-------------------------------------
-GenericAPIView---》继承了APIView
# 以后,如果是跟数据库打交道,尽量用它,因为用GenericAPIView,肯定是要先指定queryset与serializer_class的
1 queryset:要序列化或反序列化的表模型数据
2 serializer_class:使用的序列化类
3 lookup_field :查询单条的路由分组分出来的字段名
4 filter_backends:过滤类的配置(了解)
5 pagination_class:分页类的配置(了解)
# 方法
1 get_queryset :获取要序列化的对象
2 get_object :获取单个对象
3 get_serializer :获取序列化类 ,跟它差不多的get_serializer_class,一般重写它,不调用它
4 filter_queryset :过滤有关系(了解)
-补充,根据请求方式,定制序列化类
def get_serializer(self, *args, **kwargs):
if self.request.method=='GET':
return 序列化单条的序列化类
else:
return 新增的序列化类
------------------------------------------------
# 13 5个视图扩展类----》不是视图类----》必须配合GenericAPIView
-每个类自己写了一个方法,写的不是【请求方式,不是put,get。。。】的方法,写的是list,destroy。。。
-minxin 混入,通过多继承来实现多个功能
from rest_framework.mixins import CreateModelMixin, UpdateModelMixin,DestroyModelMixin, RetrieveModelMixin,
ListModelMixin
-继承GenericAPIView+某个视图扩展类+请求方式的方法
.
.
.
.
2. 视图集
2.1 第5层---通过ModelViewSet视图集编写5个接口
# 还可以再继续封装
# drf提供了一个类ModelViewSet 只要继承了它,5个接口都有了,但路由写法变了
# 重点:一旦继承了ModelViewSet,路由的写法就变了---变成了as_view({'get':'list'})
# 意思是:如果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
-------------------------------------------------
# ModelViewSet继承了全部5个视图扩展类 和 GenericViewSet
.
.
.
2.2 通过ReadOnlyModelViewSet编写2个只读接口
# 路由
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
---------------------------
# ReadOnlyModelViewSet继承了查询单个与查询所有的两个视图扩展类 和 GenericViewSet
.
.
.
2.3 ViewSetMixin源码分析
ModelViewSet 继承了全部5个视图扩展类 和 GenericViewSet
GenericViewSet 继承了ViewSetMixin 和 GenericAPIView
这里面只有ViewSetMixin没见过,继承的其他几个类前面用过,都不需要改变路由的写法
所以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的
# setattr(obj,'str','value') 根据字符串给对象设置或者修改数据
# 这个view代码整体就在干一件事情,根据传进来的字典将字典的值通过反射拿到比如list函数名,
# 再利用反射修改,将字典的键比如get作为对象的属性名,将list函数名作为属性值,赋值给对象
# 实际上反射修改就是执行的 self.get = list函数方法名
# 像现在字典里面两组键值对就还会走 self.post = create函数方法名
# 所以dispath里面根据请求方式的不同,如果是get请求,
# 运行self.get方法实际上就是在运行自定义视图类里面的list方法!!
# 如果是post请求,运行self.post方法实际上就是在调用运行create方法!!
----------------------------------------
# 总结:
-1 只要继承ViewSetMixin的视图类,路由写法就变了(重写了as_veiw)
-2 变成需要需要传入字典映射方法:{'get': 'list', 'post': 'create'}
-只要传入actions,以后访问get就是访问list,访问post,就是访问create
-3 其他执行跟之前一样
-4 以后视图类类中的方法名,可以任意命名,只要在路由中做好映射即可【重要】
----------------------------------------
# 所以 基于ViewSetMixin + APIView 写视图类时
from rest_framework.viewsets import ViewSetMixin, ViewSet, GenericViewSet
class TestView(ViewSetMixin, APIView):
def login(self, request):
return Response('哈哈哈')
# 路由要这么写
urlpatterns = [
path('admin/', admin.site.urls),
path('test/', views.TestView.as_view({'get': 'login'})),
]
.
.
.
.
2.4 from rest_framework.viewsets包下的类
'''
from rest_framework.viewsets下有这几个类
ModelViewSet:5个试图扩展类+ViewSetMixin+GenericAPIView
ReadOnlyModelViewSet::2个试图扩展类+ViewSetMixin+GenericAPIView 只读的两个
ViewSetMixin:魔法,重新了as_view,只要继承他,以后路由写法变成了映射方法
ViewSet:ViewSetMixin+ APIView
GenericViewSet:ViewSetMixin+ GenericAPIView
'''
----------------------------------------------
#重点:
以后,你想继承APIView,但是视图类中方法名想任意命名 【或想改路由写法】,就直接继承ViewSet就行了
以后,你想继承GenericAPIView,但是想变路由写法【视图类中方法名任意命名】,就直接继承GenericViewSet就行了
.
.
.
.
.
2.5 视图层大总结!!!
#1 两个试图基类
-APIView,GenericAPIView
#2 5个试图扩展类,不是视图类,必须配合GenericAPIView
#3 9 个视图子类,是视图类,只需要继承其中某一个即可
#4 视图集
-ModelViewSet:路由写法变了,两个路由对的一个视图函数,视图类只需要写一个,并且里面只写两行代码,5个接口都有了
-ReadOnlyModelViewSet:路由写法变了,两个路由对的一个视图函数,视图类只需要写一个,并且里面只需要写两行,2个只读接口都有了
-ViewSetMixin:不是视图类,魔法,重写了as_view,路由写法变了,变成映射了
views.BookView.as_view({'get': 'list', 'post': 'create'})
-ViewSet:ViewSetMixin+ APIView
-GenericViewSet:ViewSetMixin+ GenericAPIView
# 举例子:发送短信接口,视图类叫SendView,方法叫send_sms,路由配置变了
路由:views.BookView.as_view({'get': 'send_sms'})
class SendView(ViewSet):
def send_sms(self,request):
.
.
.
.
.
.
3. 路由系统
3.1 自动生成路由
# drf 由于继承ViewSetMinxin类,路由写法变了
-原生+drf,以后的路由写法,可能会有三种情况:
-path('books/', views.BookView.as_view()
-path('books/', views.BookView.as_view({'get': 'list', 'post': 'create'}))
-自动生成
# drf提供了两个路由类,继承ModelViewSet后,路由可以自动生成
# 路由层 使用步骤:
第一步: 导入路由类
from rest_framework.routers import SimpleRouter,DefaultRouter
第二步:实例化得到对象(两个类,一般使用SimpleRouter)
router = SimpleRouter()
第三步: 注册路由(就是让路径与视图类做绑定关系,有几个视图类,就要建立几个关系)
router.register('books', views.BookView, 'books')
# views.BookView 视图类就会自动生成books这个路径的路由,或者说访问books路由就会自动
# 触发views.BookView里面的接口函数
router.register('publish', views.PublishView, 'publish')
'''
第一个参数是路径,不要带/
第二个参数是视图类
第三个参数是别名,一般和路径相同
'''
------------------------
第四步:在urlpatterns中注册,两种方式:
# 方式一
urlpatterns += router.urls # router.urls会自动生成路由
# 方式二
from django.urls import path,include
urlpatterns = [
path('', include(router.urls)) # 生成的路由路径 books/
path('api/v1/', include(router.urls))
# include的好处就是可以加路由前缀
# 路由路径 api/v1/books/
]
# 注意router.urls自动生成路由时,会根据视图类所继承的类的不同,所自动生成的路由是有区别
# 比如如果视图类继承的是(ViewSetMixin,ListAPIView)自动生成的路由就是books/
# 但是如果视图类继承的是(ViewSetMixin,RetrieveAPIView)自动生成的路由就是books/再加一个匹配到的数字
# 本质是因为ListAPIView与RetrieveAPIView视图子类里面的方法不一样,一个是list方法一个是retrieve
print(router.urls)
[
<URLPattern '^books/$' [name='books-list']>,
<URLPattern '^books/(?P<pk>[^/.]+)/$' [name='books-detail']>
]
------------------------
# 底层实现:
-自动生成路由本质是自动做映射,能够自动成的前提是,
-视图类中要有5个方法(list...)的某一个或某多个!!!
get--->list
get---->retrieve
put---->update
post---->create
delete---->destory
-ModelViewSet,ReadOnlyModelViewSet 可以自动生成路由
-9个试图子类+必须配合ViewSetMixin 才可以自动生成路由
-GenericAPIView+5个试图扩展类+ 也要配合ViewSetMixin 才能自动生成路由
总结就是一句话,必须要继承ViewSetMixin 才能自动生成路由
------------------------------
视图类的继承中,继承9个试图子类+ViewSetMixin 该方法用的最多!!!
SimpleRouter与DefaultRouter区别,了解即可
.
.
.
可以看到注册的时候,两个视图类都与同一个路由做了绑定关系,但是可以看到两个视图类继承的类不一样,就会导致自动生成的路由表达式不一样!!!继承查所有的视图子类自动生成的路由表达式没有数字后缀,继承查所有的视图子类自动生成的路由表达式还有一个匹配数字的后缀!!!
.
.
.
.
3.2 action 装饰器(重要)
-------------------------------------------
# 简单模拟一个发送短信的代码:
path('send/', views.SendView.as_view({'get': 'send_sms'})),
class SendView(ViewSet):
def send_sms(self, request):
phone = request.query_params.get('phone')
print('发送成功,%s'% phone)
return Response({'code':100,'msg':'发送成功'})
--------------------------------------------
# 现在需求 发送短信的类可以自动生成路由
# action 写在视图类的方法上面,可以自动生成路由!!!
# 使用步骤
router = SimpleRouter()
router.register('send', views.SendView, 'send')
urlpatterns = [
path('api/v1/', include(router.urls))
]
自动生成路由本质是自动做映射,能够自动成的前提是,视图类中要有
5个方法(list...)的某一个或某多个!但是现在视图类中没有5个方法,
所以没法映射自动生成路由
from rest_framework.decorators import action
class SendView(ViewSet):
@action(methods=['GET'], detail=False)
def send_sms(self, request):
phone = request.query_params.get('phone')
print('发送成功,%s'% phone)
return Response({'code':100,'msg':'发送成功'})
# methods指定请求方法,可以传多个
# detail:只能传True和False
-False,自动生成的路由不带数字:send/send_sms/
-True,带数字的路径:send/888/send_sms/
如果前端需要在路由中带数字,比如用户的id等情况,就需要改参数改为True
# url_path:生成send后面的路径的名字,默认以方法名命名
# url_name:别名,反向解析使用,了解即可
所以最后生成的路由路径是 api/v1/send/send_sms/
向该路径地址发送get请求,就能触发类里面的被装饰器装饰的函数
http://127.0.0.1:8077/api/v1/send/send_sms/?phone=18888
--------------------------------------------
# 以后看到的drf路由写法
后期,都是自动生成,一般不在urlpatterns里面 加入路由了
--------------------------------------------
# 补充:
-1 不同请求方式可以使用不同序列化类
-2 不同action使用不同序列化类
class SendView(GenericViewSet):
queryset = None
serializer_class1 = '序列化类1'
serializer_class222 = '序列化类2'
def get_serializer(self, *args, **kwargs):
# self.action 视图类对象点action能获取对应函数的函数名,前提是
if self.action=='lqz':
return serializer_class1
else:
return serializer_class222
@action(methods=['GET'], detail=True)
def send_sms(self, request,pk):
self.get_serializer() # 这样该函数就用的是序列化类2
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
self.get_serializer() # 这样该函数就用的是序列化类1
pass
@action(methods=['GET'], detail=True)
def login(self,request): # get
self.get_serializer() # 这样该函数就用的是序列化类2
pass
---------------------------------
视图类点action self.action 的action 是在ViewSetMixin类里面的action
.
.
.
.
4. 认证组件
# 访问某个接口,需要登陆后才能访问
# 第一步:写个登录功能,用户表
-User表
-UserToken表:存储用户登录状态 [这个表可以没有,如果没有,把字段直接写在User表上也可以]
----------------------------------------
当视图类同时继承ViewSetMixin与APIView的时候,当想用自动生成路由的时候
ViewSetMixin一定要放在前面,因为要用它里面的as_view 方法
.
.
.
.
4.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': '用户名或密码错误'})
当报这种错的时候,路由后面再加个斜杠试下!
.
.
.
.
作业
# 1 整理出视图层所有的类,以及继承关系,最好画图,每个视图类,扩展类,如何使用,也要简单写写
# 2 整理自动生成路由和装饰器
# 3 登录接口写完(if,我写的方式)
---扩展
# 3 登录认证功能,没写,登录功能写完了
-实现了图书5个接口
-图书的查询所有和新增不需要登录访问
-图书的查询一个,修改,删除,登录访问
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 开源Multi-agent AI智能体框架aevatar.ai,欢迎大家贡献代码
· Manus重磅发布:全球首款通用AI代理技术深度解析与实战指南
· 被坑几百块钱后,我竟然真的恢复了删除的微信聊天记录!
· 没有Manus邀请码?试试免邀请码的MGX或者开源的OpenManus吧
· 园子的第一款AI主题卫衣上架——"HELLO! HOW CAN I ASSIST YOU TODAY