首页 > 其他分享 >DRF06

DRF06

时间:2023-02-06 21:44:22浏览次数:42  
标签:get list 视图 action DRF06 路由 view

9个视图子类

	之前学的是:有两个视图基类,5个扩展类
    
今天学的是: 9个是视图子类:他就是真的视图类,就不需要继承GenerricAPIView,只要继承者9个中的其中一个,就会有某个,或者某几个接口。   
'''第四层,基于9个视图子类,编写5个接口'''
路由:
urlpatterns = [
path('books',views.BookView.as_view()),
path('books/<int:pk>',views.BookDataView.as_view()),
]


视图类:
class BookView(ListCreateAPIView):   # 查询所有和新增一个
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    # get post 通过继承,里面已经写好了


# 新增一个,修改一个,删除一个
class BookViews(RetrieveUpdateDestroyAPIView):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    # get put delete 在父类中也是有的
# 总结:9个视图子类
"""
ListAPIView,CreateAPIView
ListAPIView + CreateAPIView = ListCreateAPIView
DestroyAPIView,RetrieveAPIView,UpdateAPIView
DestroyAPIView + RetrieveAPIView = RetrieveDestroyAPIView   这个是给BookView用
RetrieveAPIView + UpdateAPIView = RetrieveUpdateAPIView
DestroyAPIView + RetrieveAPIView + UpdateAPIView = RetrieveUpdateDestroyAPIView  
# 至于为什么没有 删除和修改的组合,那是因为如果我们想要修改数据,起码得要先查询出来才能做。
"""

通过ModelViewSet编写5个接口

'''第五层 通过上面的代码发现,我们写五个接口配置,路由和视图的代码还是几乎一样'''
# 能否将两个视图类写成一个呢?
"""
如果将连个视图类写成一个的话,会有两个get,而且路由也不一样
drf 写了一个类  ModelViewSet 只要继承它,五个接口都有了,但是路由的写法变了
    只要继承了它,重启羡慕项目就会报一个错:路由的错误 --->For example `.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

通过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
    

ViewSetMixin源码分析

分析源码,看为什么路由的写法会发生变化
	通过看 ModelViewSet 类的源码发现,这个类里面有继承五个扩展类,和一个GenericViewSetz类。
GenericViewSet:ViewSetMixin + GenericAPIView

ViewSetMixin:这个类什么也没有继承,它重写了as_view,所以需要传一个action的参数
	路由:as_view(action={'get': 'list', 'post': 'create'})
 然后就知道了,因为它重写了as_view,所以,路由就需要变化写法。

总结:
	请求来了,路由匹配成功之后,假设get请求匹配成功books,会执行  views.BookView.as_view({'get': 'list', 'post': 'create'})() 通过读as_view的源码【这里的as_view是ViewSetMixin的as_view】(这里是通过执行顺序来找的as_view)
 
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 ,最终执行的是as_view内的view()

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,就到它的父类中找dispatch 所以这个dispatch是APIView的

总结:

  • 只要继承了ViewSetMixin的视图类,它路由的写法就变了,原因(重写as_view)
  • 变成需要传入的字典的映射方法:
    • 只药传入actions,以后访问get就是访问list,访问post就是访问creste
  • 以后只要继承ViewSetMixin,无论是通过直接继承,还是通过父类的继承关系,路由的写法都会变
  • 其他的操作和之前一样
  • 还有就是以后在视图类中的方法可以随意命名,只要在路由中做好映射即可【重点】

rest_framework.viewsets包下的类

ModelViewSet:5个试图扩展类+ViewSetMixin+GenericAPIView
ReadOnlyModelViewSet::2个试图扩展类+ViewSetMixin+GenericAPIView   只读的两个
ViewSetMixin:魔法,重新了as_view,只要继承他,以后路由写法变成了映射方法
ViewSet:ViewSetMixin+ APIView
GenericViewSet:ViewSetMixin+ GenericAPIView

总结:[重点]

  • 以后只要想要继承APIView ,但是想要改变路由的写法【视图类中方法名的任意命名】,一定要继承ViewSet
  • 以后想要继承GenericAPIView,但是想要改变路由的写法【视图类中方法名的任意命名】,一定要继承GenericViewSet

视图层的总结

# 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,路由配置变了
	通过get请求执行视图类中send_sms方法
	class SendView(ViewSet):
        def send_sms(self,request):

路由系统

  • 主要讲的就是drf ,由于继承了ViewSetMixin类以后,路由的方式就变了
  • 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
# 第一步导入类
# 第二步实例化得到对象(有两个类)
# 生成少数(使用的多)
# router=SimpleRouter() # [<URLPattern '^books/$' [name='books-list']>, <URLPattern '^books/(?P<pk>[^/.]+)/$' [name='books-detail']>]
# 生成多个,1.API Root(根) 2:根表示:访问根 可以看到有哪些地址, 比如book的,比如publish
# 给别的起了别名
router=DefaultRouter() #  [<URLPattern '^books/$' [name='books-list']>, <URLPattern '^books\.(?P<format>[a-z0-9]+)/?$' [name='books-list']>, <URLPattern '^books/(?P<pk>[^/.]+)/$' [name='books-detail']>, <URLPattern '^books/(?P<pk>[^/.]+)\.(?P<format>[a-z0-9]+)/?$' [name='books-detail']>, <URLPattern '^$' [name='api-root']>, <URLPattern '^\.(?P<format>[a-z0-9]+)/?$' [name='api-root']>]
 # 第三步 注册
router.register('books',views.BookView,'books') # 注册路由,目的就是让路径和视图类绑定关系,有几个视图类就要建立多少次关系
'''
里面参数的意思是:

1.第一个参数是,路径 不带/
2.第二个参数是视图类
3.第三个参数是别名,一般和路径相同

'''
 # 方式二:使用的多一些
-include:
urlpatterns = [path('api/v1/',include(router.urls)),]



 # 第四步:在urlpatterns中注册,两种方式
    # 方式一:
        -urlpatterns += router.urls
      
              


# 底层实现:自动生成路由
       -本质是自动做映射,能够自动成的前提是,视图类中要有 5个方法的某要给或多个
           get--->list
           get---->retrieve
           put---->update
           post---->create
           delete---->destory
      -ModelViewSet,ReadOnlyModelViewSet可以自动生成
              
       -9个试图子类+需要配合ViewSetMixin   才可以自动生成
       -GenericAPIView+5个试图扩展类+配合ViewSetMixin   才能自动生成

DefaultRouter 例图:

image

action装饰器

# action 写在视图类的方法上,可以自动生成路由

# 使用步骤
	- 1 写在视图类方法上
    class SendView(ViewSet):
        # methods指定请求方法,可以传多个
        # detail:只能传True和False
        	-False,不带id的路径:send/send_sms/
            -True,带id的路径:send/2/send_sms/
        #url_path:生成send后路径的名字,默认以方法名命名 
        # url_name:别名,反向解析使用,了解即可
        @action(methods=['POST'], detail=False)
        def send_sms(self, request):
            
            
 # 以后看到的drf路由写法
	后期,都是自动生成,一般不在urlpatterns 加入路由了
    
    
    
    
    
    
 # 补充:
	-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):
        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

认证组件

	访问某个接口,需要登录之后才能访问
# 第一步:写个登录功能,用户表
	- User表
    - UserToken表:储存用户登录状态,[这个表可以不写,但是没有的话,把字段直接写在 User表上也是可以的]

登录接口

路由:
router=SimpleRouter()
router.register('login',views.UserView,'login')

urlpatterns=[
    path('api/v1/',include(router.urls)),
]
注:在postman中输入路由的时候需要在末尾加斜杠

视图类:
class UserView(ViewSet):
    @action(methods=['POST'],detail=False)
    def login(self, request):
        name = request.data.get('name')
        password = request.data.get('password')
        user = models.User.objects.filter(name=name, password=password).first()
        if user:
            token = str(uuid.uuid4())
            models.Token.objects.update_or_create(user=user, defaults={'token': token})
            return Response({'code': 100, 'msg': '登录成功'})
        else:
            return Response({'code': 101, 'msg': '用户名或密码错误'})

标签:get,list,视图,action,DRF06,路由,view
From: https://www.cnblogs.com/qiguanfusu/p/17096789.html

相关文章

  • DRF06-视图架构
    本文探究Django以及DRF的视图的层层递进,从源码学习视图的不断完善和丰富01最简单的视图FBVurlpatterns=[path('test01/',views.test01)]只要在浏览器上请求......