备案控制台
探索云世界
开发者社区 安全 文章 正文

DRF框架学习（四）

2023-09-19 31
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： DRF框架学习（四）

DRF框架学习（四）

1.视图集对象的action属性

作用：

获取现在要执行的是哪一种操作。

  1. self.action:是字符串类型，目的是获取所有执行的操作。

使用场景：

重写 get_serializer_class和get_queryset,根据不同的操作返回不同的序列化器类和不同的查询集。

  1. def get_serializer_class(self):
  2.    if self.action =='list':
  3.        # 返回list操作对应的序列化器类
  4.    elif self.action =='latest'：
  5.        # 返回latest操作对应的序列化器类
  6.    else:
  7.        # 返回其他操作对应的序列化器类

  9. def get_queryset(self):
  10.    if self.action =='list':
  11.        # 返回list操作所使用的查询集
  12.    elif self.action =='latest':
  13.        # 返回latest操作所使用的查询集
  14.    else:
  15.        # 返回其他操作所使用的查询集

2.路由Router(urls文件中使用)

作用：（重点）

配合视图集进行使用，动态生成视图集中处理函数的url配置项。

使用：（重点）

1.创建router类的对象

  1. from restframe_work.routers importSimpleRouter,DefaultRouter
  2. router =SimpleRouter()或DefaultRouter（）

2.注册视图集

  1. router.register(prefix,viewset,base_name)

例如：

  1. # 例如：
  2. from booktest.views importBookInfoViewSet
  3. router.register('books',views.BookInfoViewSet,base_name='books')

3.将生成的url配置项列表添加 urlpatterns中。

  1. urlpatterns += router.urls

注意点：

指定Router生成视图集处理函数url配置项时，提取的参数正则表达式。

  1. lookup_value_regex ='\d+'

2.1视图集额外处理方法url配置项的生成

  • 需要给对应的方法添加action装饰器。
  1. # detail为False 表示路径名格式应该为 books/latest/
  2.    @action(methods=['get'], detail=False)
  3.    def latest(self, request):
  4.        """
  • 需要提取参数detail改为True，不需要提取参数的时候改为False
  • DefaultRouter与 SimpleRouter的区别是， DefaultRouter会多附带一个默认的API根视图，返回一个包含所有列表视图的超链接响应数据。 DefaultRouter创建的对象，在访问url地址的时候，我们都可以在后面加一个 .json,那么后台会给我们返回json格式的数据。

3.案例

写一个视图集，提供一下两个接口

1.获取所有的图书信息 GET/books/list

2.获取指定的图书信息 GET/books/(?P\<pk>\d+)/retrieve

  1. from rest_framework.authentication importSessionAuthentication
  2. from rest_framework.permissions importIsAuthenticated
  3. from rest_framework.generics importReadOnlyModelViewSet

  5. classBookInfoViewSet(ReadOnlyModelViewSet):
  6.    # 指定当前视图所使用的查询集
  7.    queryset =BookInfo.objects.all()
  8.    # 指定当前视图所使用的序列化器类
  9.    serializer_class =BookInfoSerializer
  10.    # 指定当前视图所使用的认证类
  11.    authentication_classes =[SessionAuthentication]
  12.    # 指定当前视图所使用的权限控制类
  13.    permission_classes =[IsAuthenticated]

url文件配置：

  1. from restframe_work.routers importDefaultRouter
  2. router =DefaultRouter()
  3. from booktest.views importBookInfoViewSet
  4. router.register('books',views.BookInfoViewSet,base_name='bookss')
  5. urlpatterns += router.urls

4.认证

DRF框架默认设置了两种全局认证方案，session认证和基本认证。

全局认证就是针对我们所有的接口。

认证需要配合权限来使用

4.1使用

DRF框架的默认全局认证方案如下，可对其进行修改，比如注释掉基本认证:

  1. REST_FRAMEWORK ={
  2.    'DEFAULT_AUTHENTICATION_CLASSES':(
  3.        'rest_framework.authentication.SessionAuthentication',  # session认证
  4.        'rest_framework.authentication.BasicAuthentication',   # 基本认证
  5.    )
  6. }

也可以在每个视图中通过设置authentication_classess属性来设置视图的认证方案:

  1. from rest_framework.authentication importSessionAuthentication,BasicAuthentication
  2. from rest_framework.views importAPIView

  4. classExampleView(APIView):
  5.    # 指定当前视图的认证方式（指定后不再使用全局的认证方案）
  6.    authentication_classes =(SessionAuthentication,BasicAuthentication)
  7.    ...

配合权限，如果认证失败会有两种可能的返回值：

  • 401 Unauthorized 未认证
  • 403 Permission Denied 权限被禁止

5.权限

权限控制可以限制用户对于视图的访问和对于具体数据对象的访问。

  • 在执行视图的dispatch()方法前，会先进行视图访问权限的判断
  • 在通过get_object()获取具体对象时，会进行对象访问权限的判断

DRF框架提供了四个权限控制类:

  • AllowAny允许所有用户(默认的)
  • IsAuthenticated仅通过认证的用户
  • IsAdminUser仅管理员用户
  • IsAuthenticatedOrReadOnly认证的用户可以完全操作，否则只能get读取

5.1使用

DRF框架的默认权限控制如下:

  1. 'DEFAULT_PERMISSION_CLASSES':(
  2.   'rest_framework.permissions.AllowAny',# 允许所有人
  3. )

可以在配置文件中设置权限管理类，如:

  1. REST_FRAMEWORK ={
  2.    # 权限设置
  3.    'DEFAULT_PERMISSION_CLASSES':(
  4.        'rest_framework.permissions.IsAuthenticated',# 仅仅允许认证用户进行访问
  5.    )
  6. }

也可以在具体的视图中通过 permission_classes属性来指定某个视图所使用的权限控制类，如:

  1. from rest_framework.permissions importIsAuthenticated
  2. from rest_framework.views importAPIView

  4. classExampleView(APIView):
  5.    #指定当前视图的权限控制类，指定以后不再使用全局设置
  6.    permission_classes =[IsAuthenticated]
  7.    # 还可以写成下面这个样子，但是注意逗号
  8.    permission_classes =(IsAuthenticated,)
  9.    ...

5.2自定义权限（了解即可）

如需自定义权限，需继承 rest_framework.permissions.BasePermission父类，并实现以下两个任何一个方法或全部

  • .has_permission(self,request,view)

是否可以访问视图， view表示当前视图对象

  • .has_object_permission(self,request,view,obj)

是否可以访问数据对象， view表示当前视图， obj为数据对象


例如：

  1. classMyPermission(BasePermission):
  2.    def has_permission(self, request, view):
  3.        """判断对使用此权限类的视图是否有访问权限"""
  4.        # 任何用户对使用此权限类的视图都有访问权限
  5.        # True有权限，False没有权限
  6.        returnTrue

  8.    def has_object_permission(self, request, view, obj):
  9.        """判断对使用此权限类视图某个数据对象是否有访问权限"""
  10.        # 需求: 对id为1，3的数据对象有访问权限，其他的对象没有访问权限
  11.        if obj.id in(1,3):
  12.            returnTrue
  13.        returnFalse

  15. classBookInfoViewSet(ReadOnlyModelViewSet):
  16.    # 指定当前视图所使用的查询集
  17.    queryset =BookInfo.objects.all()
  18.    # 指定当前视图所使用的序列化器类
  19.    serializer_class =BookInfoSerializer
  20.    # 指定当前视图所使用的认证类
  21.    authentication_classes =[SessionAuthentication]
  22.    # 使用自定义的权限控制类
  23.    permission_classes =[MyPermission]

6.限流

作用：可以对接口访问的频次进行限制，以减轻服务器压力。

6.1 使用

DRF框架默认没有进行全局限流设置，但是提供了配置项，我们可以在配置文件中，使用 DEFAULT_THROTTLE_CLASSES 和 DEFAULT_THROTTLE_RATES进行全局配置。

6.1.1 可选限流类

6.1.1.1 AnonRateThrottle

限制所有匿名未认证用户，使用IP区分用户。

使用 DEFAULT_THROTTLE_RATES['anon'] 来设置频次

6.1.1.2 UserRateThrottle

限制认证用户，使用User id 来区分。

使用 DEFAULT_THROTTLE_RATES['user'] 来设置频次

6.1.1.3 ScopedRateThrottle

限制用户对于每个视图的访问频次，使用ip或user id。

6.1.2 限流设置

6.1.2.1针对匿名用户和认证用户分别进行限流控制
  1. REST_FRAMEWORK ={
  2.    'DEFAULT_THROTTLE_CLASSES':(
  3.        # 针对未登录(匿名)用户的限流控制类
  4.        'rest_framework.throttling.AnonRateThrottle',
  5.        # 针对登录(认证)用户的限流控制类
  6.        'rest_framework.throttling.UserRateThrottle'
  7.    ),
  8.    # 指定限流频次
  9.    'DEFAULT_THROTTLE_RATES':{
  10.        # 认证用户的限流频次
  11.        'user':'5/minutes',
  12.        # 匿名用户的限流频次
  13.        'anon':'3/minutes',
  14.    },
  15. }

DEFAULT_THROTTLE_RATES 可以使用 second, minute, hour 或 day来指明周期。

也可以在具体视图中通过throttle_classess属性来配置，如

  1. from rest_framework.throttling importUserRateThrottle
  2. from rest_framework.views importAPIView

  4. classExampleView(APIView):
  5.    throttle_classes =[UserRateThrottle]
  6.    ...
6.1.2.2针对匿名用户和认证用户进行统一的限流控制
  1. REST_FRAMEWORK ={
  2.    # 针对匿名用户和认证用户进行统一的限流控制
  3.    'DEFAULT_THROTTLE_CLASSES':(
  4.        'rest_framework.throttling.ScopedRateThrottle',
  5.    ),

  7.    # 设置限流频次选择项
  8.    'DEFAULT_THROTTLE_RATES':{
  9.        'upload':'3/minute',
  10.        'contacts':'5/minute'
  11.    },
  12. }

进行了上面的配置之后，其实我们的视图还没有限流的效果，如果想实现限流，还需进行下列操作：

  1. classContactListView(APIView):
  2.    # 指定限流频次选择项
  3.    throttle_scope ='contacts'
  4.    ...
  5.    pass


  8. classUploadView(APIView):
  9.    throttle_scope ='uploads'
  10.    ...
  11.    pass

7.过滤

对于列表数据可能需要根据字段进行过滤，我们可以通过添加django-fitlter扩展来增强支持。

  1. pip install django-filter

在配置文件中增加过滤后端的设置：

  1. INSTALLED_APPS =[
  2.    ...
  3.    'django_filters',  # 需要注册应用，
  4. ]
  5. # 过滤
  6. REST_FRAMEWORK ={
  7.    'DEFAULT_FILTER_BACKENDS':('django_filters.rest_framework.DjangoFilterBackend',)
  8. }

在视图中添加filter_fields属性，指定可以过滤的字段

需求：写一个类视图，提供1个接口

1.获取所有的图书信息 GET/books/

  1. classBookListView(ListAPIView):
  2.    queryset =BookInfo.objects.all()
  3.    serializer_class =BookInfoSerializer
  4.    # 指定过滤字段，根据书名和阅读量过滤，还可以添加其他的过滤字段
  5.    filter_fields =('btitle','bread')

  7. # 127.0.0.1:8000/books/?btitle=西游记

8.排序

对于列表数据，REST framework提供了OrderingFilter过滤器来帮助我们快速指明数据按照指定字段进行排序。

8.1使用方法：

在类视图中设置filter_backends，使用 rest_framework.filters.OrderingFilter过滤器，REST framework会在请求的查询字符串参数中检查是否包含了ordering参数，如果包含了ordering参数，则按照ordering参数指明的排序字段对数据集进行排序。

前端可以传递的ordering参数的可选字段值需要在ordering_fields中指明。

示例：

默认是升序，如果想要实现降序的效果，那么在传入查询字符串的时候在字段名前加-，如下：

  1. classBookListView(ListAPIView):
  2.    queryset =BookInfo.objects.all()
  3.    serializer_class =BookInfoSerializer
  4.    filter_backends =[OrderingFilter]
  5.    # 根据指定字段进行排序
  6.    ordering_fields =('id','bread','bpub_date')
  7. # 127.0.0.1:8000/books/?ordering=-bread

9.分页（重点）

REST framework提供了分页的支持。

我们可以在配置文件中设置全局的分页方式，如：

  1. REST_FRAMEWORK ={
  2.    'DEFAULT_PAGINATION_CLASS':  '<全局分页类>',
  3.    'PAGE_SIZE':<页容量>  
  4. }

如:

  1. REST_FRAMEWORK ={
  2.    'DEFAULT_PAGINATION_CLASS':  'rest_framework.pagination.PageNumberPagination',
  3.    'PAGE_SIZE':5  # 每页数目
  4. }

9.1可选分页类

9.1.1PageNumberPagination

?page=<页码>

前端访问网址形式：

  1. GET  http://api.example.org/books/?page=4

可以在子类中定义的属性：

  • page_size 每页数目
  • pagequeryparam 前端发送的页数关键字名，默认为"page"
  • pagesizequery_param 前端发送的每页数目关键字名，默认为None
  • maxpagesize 前端最多能设置的每页数量

9.1.2LimitOffsetPagination

?offset=<偏移量>&limit=<数据条数>

前端访问网址形式：

  1. GET http://api.example.org/books/?limit=100&offset=400

可以在子类中定义的属性：

  • default_limit 默认限制，默认值与 PAGE_SIZE设置一直
  • limitqueryparam limit参数名，默认'limit'
  • offsetqueryparam offset参数名，默认'offset'
  • max_limit 最大limit限制，默认None

注意：如果在视图内关闭分页功能，只需在视图内设置

  1. pagination_class =None

9.2自定义分页类

也可通过自定义Pagination类，来为视图添加不同分页行为。在视图中通过 pagination_clas属性来指明。

  1. classStandardResultPagination(PageNumberPagination):
  2.    # 分页默认页容量
  3.    page_size =3
  4.    # 获取分页数据时，传递也容量的参数名称
  5.    page_size_query_param ='page_size'
  6.    # 分页时最大页容量，但是不能超过最大的页容量
  7.    max_page_size =5
  8. classBookListView(ListAPIView):
  9.    queryset =BookInfo.objects.all()
  10.    serializer_class =BookInfoSerializer
  11.    # 指定当前视图所使用的分页类
  12.    pagination_class =StandardResultPagination

通过 http://api.example.org/books/?page=<页码>&page_size=<页容量> 进行访问。

注意：视图关闭分页

  1. pagination_class =None

10.异常处理(重点)

REST framework提供了异常处理，可以出来以下异常：

  • APIException 所有异常的父类
  • ParseError 解析错误
  • AuthenticationFailed 认证失败
  • NotAuthenticated 尚未认证
  • PermissionDenied 权限决绝
  • NotFound 未找到
  • MethodNotAllowed 请求方式不支持
  • NotAcceptable 要获取的数据格式不支持
  • Throttled 超过限流次数
  • ValidationError 校验失败

10.1异常处理设置

DRF框架的默认异常处理设置如下：

  1. REST_FRAMEWORK ={
  2.    'EXCEPTION_HANDLER':'rest_framework.views.exception_handler'
  3. }

默认使用 rest_framework.views.exception_handler模块下的 exception_handler函数进行异常处理。

10.2自定义异常处理

10.2.1自定义DRF框架异常处理函数

1.自定义异常处理函数

2.设置EXCEPTION_HANDLER配置项

10.2.2详解

可以在DRF框架异常处理函数的基础上，补充一些其他的异常处理，比如数据库处理：

  1. from rest_framework.views import exception_handler as drf_exception_handler
  2. from rest_framework import status
  3. from django.db importDatabaseError

  5. def exception_handler(exc, context):
  6.    # 先调用DRF框架的默认异常处理函数
  7.    response = drf_exception_handler(exc, context)

  9.    if response isNone:
  10.        view = context['view']
  11.        # 补充数据库的异常处理
  12.        if isinstance(exc,DatabaseError):
  13.            print('[%s]: %s'%(view, type(exc)))
  14.            response =Response({'detail':'服务器内部错误'}, status=status.HTTP_507_INSUFFICIENT_STORAGE)

  16.    return response

在配置文件中声明自定义的异常处理：

  1. REST_FRAMEWORK ={
  2.    'EXCEPTION_HANDLER':'booktest.utils.exceptions.exception_handler'
  3. }
文章标签：
数据安全/隐私保护
前端开发
网络架构
数据格式
JSON
全栈技术精选
目录
相关文章
IT从业者张某某
|
4月前
|
Python API 网络架构
Django实践-10RESTful架构和DRF入门
Django实践-10RESTful架构和DRF入门
IT从业者张某某
38 0
Django实践-10RESTful架构和DRF入门
python兴趣圈
|
1月前
|
前端开发 API 网络架构
Python 如何开发出RESTful Web接口，DRF框架助力灵活实现!
Python 如何开发出RESTful Web接口，DRF框架助力灵活实现!
python兴趣圈
44 0
全栈技术精选
|
7月前
|
JSON API 数据库
DRF框架学习（二）
DRF框架学习（二）
全栈技术精选
34 0
全栈技术精选
|
7月前
|
JSON 前端开发 API
DRF框架学习（一）
DRF框架学习（一）
全栈技术精选
54 0
全栈技术精选
|
7月前
|
JSON 前端开发 数据库
DRF框架学习（三）
DRF框架学习（三）
全栈技术精选
41 0
全栈技术精选
|
7月前
|
JSON 前端开发 Android开发
DRF框架使用时的一些注意点
DRF框架使用时的一些注意点
全栈技术精选
49 0
javaedge
|
11月前
|
测试技术 Apache
学习新框架的方法
官网：xxxx.apache.org apache基金会顶级项目 英文 平时的积累 云笔记：记下来
javaedge
61 0
老师我作业忘带了
|
JSON 算法 API
DRF知识点总结（1）
DRF知识点总结（1）
老师我作业忘带了
193 0
DRF知识点总结（1）
老师我作业忘带了
|
JSON API 数据库
DRF知识点总结（2）
DRF知识点总结（2）
老师我作业忘带了
277 0
DRF知识点总结（2）
老师我作业忘带了
|
API 数据格式
DRF知识点总结（3）
DRF知识点总结（3）
老师我作业忘带了
241 0
DRF知识点总结（3）

热门文章

最新文章

  • 1
    Linux查看进程的内存占用情况
  • 2
    大咖云集，技术宅开趴倒计时 —— 2017 Kubernetes Meetup | 成都站
  • 3
    ubuntu安装KVM虚拟机管理virt-manager
  • 4
    OpenCV4之C++入门详解 （上）
  • 5
    vue2中computed中无法获取到this
  • 6
    Visual Basic快速入门
  • 7
    HDU 4968 Improving the GPA
  • 8
    这56家公司共同发力智慧城市
  • 9
    书写高质量JavaScript代码的要义（The Essentials of Writing High Quality JavaScript）翻译
  • 10
    linux驱动开发--字符设备：信号量
  • 1
    【软件工程】融通未来的工艺：深度解析统一过程在软件开发中的角色
    16
  • 2
    IBM SPSS Modeler分类决策树C5.0模型分析空气污染物数据
    14
  • 3
    【软件工程】走进瀑布模型：传统软件开发的经典之路
    14
  • 4
    数据分享|R语言用lme4多层次（混合效应）广义线性模型（GLM），逻辑回归分析教育留级调查数据（下）
    12
  • 5
    【软件工程】走近演化过程模型：软件开发的不断进化之路
    88
  • 6
    【Mybatis】深入学习MyBatis：概述、主要特性以及配置与映射
    17
  • 7
    【MySQL】数据库规范化的三大法则 — 一探范式设计原则
    16
  • 8
    r语言中对LASSO回归，Ridge岭回归和弹性网络Elastic Net模型实现（下）
    17
  • 9
    【MySQL】数据库中为什么使用B+树不用B树
    12
  • 10
    【MySQL】SQL优化
    11

    • 相关课程

    更多
  • SpringMVC框架入门
  • Python Web 框架 Django 快速入门
  • 前端开发框架Bootstrap使用教程
  • Python Web 框架 Flask 快速入门

    • 相关电子书

    更多
  • ReactNative实战优化之路
  • 函数计算最佳实践：快速开发一个分布式 Puppeteer 网页截图服务
  • ui-model，跨框架复用

    • 相关实验场景

    更多
  • 语言入门-1：环境构建
  • 使用Java面向对象编写网络通信程序应用
  • 基于函数计算快速搭建Zblog等传统应用框架
    • 下一篇
    部署LAMP环境（Alibaba Cloud Linux 3）