深入解析前后端分离组件django-rest_framework IV

本文涉及的产品
云解析 DNS,旗舰版 1个月
全局流量管理 GTM,标准版 1个月
公共DNS(含HTTPDNS解析),每月1000万次HTTP解析
简介: 深入解析前后端分离组件django-rest_framework IV

解析器


request类


django的request类和rest-framework的request类的源码解析


局部视图


from rest_framework.parsers import JSONParser,FormParser
class PublishViewSet(generics.ListCreateAPIView):
    parser_classes = [FormParser,JSONParser]
    queryset = Publish.objects.all()
    serializer_class = PublshSerializers
    def post(self, request, *args, **kwargs):
        print("request.data",request.data)
        return self.create(request, *args, **kwargs)


全局视图


REST_FRAMEWORK={
    "DEFAULT_AUTHENTICATION_CLASSES":["app01.service.auth.Authentication",],
    "DEFAULT_PERMISSION_CLASSES":["app01.service.permissions.SVIPPermission",],
    "DEFAULT_THROTTLE_CLASSES":["app01.service.throttles.VisitThrottle",],
    "DEFAULT_THROTTLE_RATES":{
        "visit_rate":"5/m",
    },
    "DEFAULT_PARSER_CLASSES":['rest_framework.parsers.FormParser',]
}


备注:局部使用指定解析器时,只需在视图类中添加一个变量:parser_classes = […]

rest_framework全局默认使用的解析器:


DEFAULTS = {
    # Base API policies
    'DEFAULT_PARSER_CLASSES': (
        'rest_framework.parsers.JSONParser',
        'rest_framework.parsers.FormParser',
        'rest_framework.parsers.MultiPartParser'
    ),


分页


简单分页


from rest_framework.pagination import PageNumberPagination,LimitOffsetPagination
class PNPagination(PageNumberPagination):
        page_size = 1     # 每页显示的数据个数
        page_query_param = 'page'    #翻页的参数  ?page=num
        page_size_query_param = "size"    #每页临时显示的数据个数  覆盖page_size
        max_page_size = 5     #每页允许显示的最大条数
class BookViewSet(viewsets.ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializers
    def list(self,request,*args,**kwargs):
     # 单写某个视图时的用法
        book_list=Book.objects.all()
        pp=LimitOffsetPagination()
        pager_books=pp.paginate_queryset(queryset=book_list,request=request,view=self)
        print(pager_books)
        bs=BookSerializers(pager_books,many=True)
        #return Response(bs.data)
        return pp.get_paginated_response(bs.data)


偏移分页


from rest_framework.pagination import LimitOffsetPagination


分页器在视图类中的用法:在视图类中定义一个变量:pagination_class=类

备注:使用LimitOffsetPagination偏移分页,里面的两个参数limit和offset:limit是每页显示的条数,offset是从第几条数据+1开始(offset=3,意为从第四条数据开始)。


default_limit = num,默认显示的条数。


游标分页


from rest_framework.views import APIView
from .models import UserInfo
from rest_framework.response import Response
from rest_framework import serializers
from rest_framework.pagination import CursorPagination
class MyPagination(CursorPagination):
    # URL传入的游标参数
    cursor_query_param = 'cursor'
    # 默认每页显示的数据条数
    page_size = 2
    # URL传入的每页显示条数的参数
    page_size_query_param = 'page_size'
    # 每页显示数据最大条数
    max_page_size = 1000
    # 根据ID从大到小排列
    ordering = "id"
class PagerSerialize(serializers.ModelSerializer):
    '''数据序列化'''
    class Meta:
        model = UserInfo
        fields = "__all__"
        depth = 2     #用于显示关联字段的对应的表的详细内容
class PagerView(APIView):
    def get(self,request,*args,**kwargs):
        user_list=UserInfo.objects.all().order_by('-id')  #将数据按照id从大到小排序
        #根据url参数,获取分页数据
        obj=MyPagination()
        page_user_list=obj.paginate_queryset(user_list,request,self)
        #数据进行序列化
        ser=PagerSerialize(instance=page_user_list,many=True)
        response=obj.get_paginated_response(ser.data)  #返回带上下页连接的数据
        return response
        # return Response(ser.data)   #不含上下页链接


游标方式分页的本质是通过记住当前页面数据的最大、最小id,翻页时根据记录的最大或者最小id,查询下一页对应的数据,这样就不会出现每一次翻页都会重头遍历数据的情况,大大的提高了查询效率。缺点是无法直接跳转到某一页。


url路由器


我们在使用rest_framework时,url都是一个规定的格式,当我们有很多表时,意味着大量的复用一些代码,对于每一个模型表对应的url,只有两个地方不同,一个是路径的前缀,一个是对应的视图类。在rest_framework中也提供了一个url的分发,完美的解决了url的分发。


from rest_framework import routers


rest_framework提供一个routers的py文件,这个文件中包含跟路由相关的类。


使用方式:在routers.py中有一个DefaultRouter类,先实例化一个这个类的对象,router=routers.DefaultRouter(),通过这个router对象,可以将对应的路径和视图类注册:router.register(r"路径前缀",对应的视图类),最后只需将url(r'^', include(router.urls)),这个url加入到urlpatterns中即可。


备注:rest_framework中为我们提供了四种形式的访问方式:


  • books/
  • books/1/
  • books.json/
  • books/?format=json            后两种不常用


响应器


rest_framework默认提供给我们两种响应器:


DEFAULTS = {
    # Base API policies
    'DEFAULT_RENDERER_CLASSES': (
        'rest_framework.renderers.JSONRenderer',
        'rest_framework.renderers.BrowsableAPIRenderer',
    ),


如果请求是浏览器,就用BrowsableAPIRenderer响应器返回一个页面,如果请求是非浏览器(比如Postman),就使用JSONRenderer响应一个json格式的数据。


rest_framework提供这两个响应器是为了利于开发。


我们可以在视图类中配置一个变量:renderer_classes = [JSONRenderer]


from rest_framework.renderers import JSONRenderer


这样我们再使用浏览器发送请求是,响应的是一个json格式的字符串,而不是一个界面。


版本控制


版本控制是由传入的客户端请求决定的,并且可能基于请求URL,或者基于请求头。


restframework也提供了对应的版本控制。当使用版本控制时,request.version属性(字符串)与客户端请求的版本一致。 默认情况下,没有使用版本控制,request.version将会返回None,我们可以通过request.version的值进行判断和逻辑分发.


基于请求url


class APIView(View):
    # 版本控制的默认配置    可以在局部中定义versoning_class=的自定义配置
    versioning_class = api_settings.DEFAULT_VERSIONING_CLASS
     def initial(self, request, *args, **kwargs):
        #  版本控制相关
        # Determine the API version, if versioning is in use.
        version, scheme = self.determine_version(request, *args, **kwargs)
        request.version, request.versioning_scheme = version, scheme


全局配置


  1. 添加配置
REST_FRAMEWORK = {
             ....
'DEFAULT_VERSIONING_CLASS':'rest_framework.versioning.URLPathVersioning',
             'ALLOWED_VERSIONS':['v1','v2'], # 允许的版本
             'VERSION_PARAM':'version', # 参数
             'DEFAULT_VERSION':'v1', # 默认版本
             ....
      }


  1. 设置路由
BeesCity/urls.py
             urlpatterns = [
                    #url(r'^admin/', admin.site.urls),
                    url(r'^api/(?P<version>\w+)/', include('api.urls')),
             ]
      api/urls.py
             urlpatterns = [
                    url(r'^course/$', course.CourseView.as_view()),
             ]


  1. 传递版本信息
http://127.0.0.1:8000/api/v1/course/


  1. 获取版本


request.version 获取版本


局部配置


除非明确设置,否则DEFAULT_VERSIONING_CLASS值为None.此例中request.version将会始终返回None


您还可以在一个单独的视图上设置版本控制方案。通常,您不需要这样做,因为在全局范围内使用一个版本控制方案更有意义。如果您确实需要这样做,请使用versioning_class属性。


from rest_framework.versioning import QueryParameterVersioning
class Course(APIView):
    versioning_class = QueryParameterVersioning


这个时候可以用过url传参的方式来传递版本信息,如:


http://127.0.0.1:8000/api/course/?version=1


添加头信息控制版本


在API请求header中添加Accept字段。


Accept的作用是客户端指出响应可以接受的媒体类型


如Accept:application/json; version=v2


具体格式也可以参考下面。


Accept: application/vnd.xxxx[.version].param[+json]


例如Accept: application/vnd.demo.app-v2+json


总结


小版本的更新可通过把版本号作为参数的方式或者通过accept字段标示版本号的方式判断,大的版本更新则通过URL上添加版本号控制


目录
相关文章
|
2月前
|
人工智能 自然语言处理 前端开发
SpringBoot + 通义千问 + 自定义React组件:支持EventStream数据解析的技术实践
【10月更文挑战第7天】在现代Web开发中,集成多种技术栈以实现复杂的功能需求已成为常态。本文将详细介绍如何使用SpringBoot作为后端框架,结合阿里巴巴的通义千问(一个强大的自然语言处理服务),并通过自定义React组件来支持服务器发送事件(SSE, Server-Sent Events)的EventStream数据解析。这一组合不仅能够实现高效的实时通信,还能利用AI技术提升用户体验。
189 2
|
2月前
|
运维 负载均衡 安全
深度解析:Python Web前后端分离架构中WebSocket的选型与实现策略
深度解析:Python Web前后端分离架构中WebSocket的选型与实现策略
105 0
|
2月前
|
前端开发 JavaScript UED
探索Python Django中的WebSocket集成:为前后端分离应用添加实时通信功能
通过在Django项目中集成Channels和WebSocket,我们能够为前后端分离的应用添加实时通信功能,实现诸如在线聊天、实时数据更新等交互式场景。这不仅增强了应用的功能性,也提升了用户体验。随着实时Web应用的日益普及,掌握Django Channels和WebSocket的集成将为开发者开启新的可能性,推动Web应用的发展迈向更高层次的实时性和交互性。
85 1
|
4月前
|
监控 网络协议 Java
Tomcat源码解析】整体架构组成及核心组件
Tomcat,原名Catalina,是一款优雅轻盈的Web服务器,自4.x版本起扩展了JSP、EL等功能,超越了单纯的Servlet容器范畴。Servlet是Sun公司为Java编程Web应用制定的规范,Tomcat作为Servlet容器,负责构建Request与Response对象,并执行业务逻辑。
Tomcat源码解析】整体架构组成及核心组件
|
3月前
|
负载均衡 5G 网络性能优化
深入解析LTE(长期演进技术)的基本架构及其关键组件
深入解析LTE(长期演进技术)的基本架构及其关键组件
431 2
|
4月前
|
Kubernetes API 调度
Kubernetes 架构解析:理解其核心组件
【8月更文第29天】Kubernetes(简称 K8s)是一个开源的容器编排系统,用于自动化部署、扩展和管理容器化应用。它提供了一个可移植、可扩展的环境来运行分布式系统。本文将深入探讨 Kubernetes 的架构设计,包括其核心组件如何协同工作以实现这些功能。
349 0
|
3月前
|
开发工具
Flutter-AnimatedWidget组件源码解析
Flutter-AnimatedWidget组件源码解析
179 60
|
1月前
|
前端开发 JavaScript 开发者
揭秘前端高手的秘密武器:深度解析递归组件与动态组件的奥妙,让你代码效率翻倍!
【10月更文挑战第23天】在Web开发中,组件化已成为主流。本文深入探讨了递归组件与动态组件的概念、应用及实现方式。递归组件通过在组件内部调用自身,适用于处理层级结构数据,如菜单和树形控件。动态组件则根据数据变化动态切换组件显示,适用于不同业务逻辑下的组件展示。通过示例,展示了这两种组件的实现方法及其在实际开发中的应用价值。
35 1
|
2月前
|
存储 JavaScript 前端开发
Vue3权限控制全攻略:路由与组件层面的用户角色与权限管理方法深度解析
Vue3权限控制全攻略:路由与组件层面的用户角色与权限管理方法深度解析
146 2
|
2月前
|
机器学习/深度学习 编解码 算法
深入解析MaxFrame:关键技术组件及其对视频体验的影响
【10月更文挑战第12天】随着流媒体服务和高清视频内容的普及,用户对于视频质量的要求越来越高。为了满足这些需求,许多技术被开发出来以提升视频播放的质量。其中,MaxFrame是一种旨在通过一系列先进的图像处理算法来优化视频帧的技术。本文将深入探讨构成MaxFrame的核心组件,包括运动估计、超分辨率重建以及时间插值算法,并讨论这些技术如何协同工作以改善视频播放效果。
43 1

推荐镜像

更多