Django REST framework 视图的其他功能（认证、权限、分页等）

最新推荐文章于 2020-08-06 15:50:06 发布
最新推荐文章于 2020-08-06 15:50:06 发布
阅读量350 收藏 1
点赞数
文章标签： DRF框架 其他功能 认证、权限、分页等
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/WangTaoTao_/article/details/101017143
版权

Django REST framework 视图的其他功能

1）认证Authentication

可以在配置文件中配置全局默认的认证方案

REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': (
        'rest_framework.authentication.BasicAuthentication',   # 基本认证
        'rest_framework.authentication.SessionAuthentication',  # session认证
    )
}

也可以在每个视图中通过设置authentication_classess属性来设置

from rest_framework.viewsets import ModelViewSet
from .serializers import BookSerializer
from .models import BookInfo
# Create your views here.

#认证管理
from rest_framework.authentication import SessionAuthentication


class BookModelViewSet(ModelViewSet):
    """
    图书管理视图
    """
    serializer_class = BookSerializer

    def get_queryset(self):
        return BookInfo.objects.all()

    #认证管理
    #认证管理一般和权限管理配合使用
    # authentication_classes = [SessionAuthentication]

认证失败会有两种可能的返回值：

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

2）权限Permissions

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

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

使用

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

REST_FRAMEWORK = {
    'DEFAULT_PERMISSION_CLASSES': (
        'rest_framework.permissions.IsAuthenticated',
    )
}

如果未指明，则采用如下默认配置

'DEFAULT_PERMISSION_CLASSES': (
   'rest_framework.permissions.AllowAny',
)

也可以在具体的视图中通过permission_classes属性来设置，如

from rest_framework.viewsets import ModelViewSet
from .serializers import BookSerializer
from .models import BookInfo
# Create your views here.

#认证管理
from rest_framework.authentication import SessionAuthentication
#权限管理
from rest_framework.permissions import IsAuthenticated,AllowAny,IsAdminUser


class BookModelViewSet(ModelViewSet):
    """
    图书管理视图
    """
    serializer_class = BookSerializer

    def get_queryset(self):
        return BookInfo.objects.all()

    #认证管理
    #认证管理一般和权限管理配合使用
    # authentication_classes = [SessionAuthentication] #权限管理
    # 通过python manager createsuperuser 就可以创建一个管理员账号,登录之后就可以访问
    # permission_classes = [IsAuthenticated]

提供的权限

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

举例

from rest_framework.authentication import SessionAuthentication
from rest_framework.permissions import IsAuthenticated
from rest_framework.generics import RetrieveAPIView

class BookDetailView(RetrieveAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer
    authentication_classes = [SessionAuthentication]
    permission_classes = [IsAuthenticated]

自定义权限

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

  • has_permission(self, request, view)

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

  • has_object_permission(self, request, view, obj)

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

  • class MyPermission(BasePermission):
    def has_object_permission(self, request, view, obj):
        """控制对obj对象的访问权限，此案例决绝所有对对象的访问"""
        return False

class BookInfoViewSet(ModelViewSet):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer
    permission_classes = [IsAuthenticated, MyPermission]

3）限流Throttling

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

使用

可以在配置文件中，使用DEFAULT_THROTTLE_CLASSES和DEFAULT_THROTTLE_RATES进行全局配置，

REST_FRAMEWORK = {
    'DEFAULT_THROTTLE_CLASSES': (
        'rest_framework.throttling.AnonRateThrottle',
        'rest_framework.throttling.UserRateThrottle'
    ),
    'DEFAULT_THROTTLE_RATES': {
        'anon': '100/day',
        'user': '1000/day'
    }
}

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

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

from rest_framework.throttling import UserRateThrottle
from rest_framework.views import APIView

class ExampleView(APIView):
    throttle_classes = (UserRateThrottle,)
    ...

可选限流类

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

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

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

使用DEFAULT_THROTTLE_RATES['user']来这是频次

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

例如：

class ContactListView(APIView):
    throttle_scope = 'contacts'
    ...

class ContactDetailView(APIView):
    throttle_scope = 'contacts'
    ...

class UploadView(APIView):
    throttle_scope = 'uploads'
    ...
REST_FRAMEWORK = {
    'DEFAULT_THROTTLE_CLASSES': (
        'rest_framework.throttling.ScopedRateThrottle',
    ),
    'DEFAULT_THROTTLE_RATES': {
        'contacts': '1000/day',
        'uploads': '20/day'
    }
}

实例

from rest_framework.viewsets import ModelViewSet
from .serializers import BookSerializer
from .models import BookInfo
# Create your views here.

#认证管理
from rest_framework.authentication import SessionAuthentication
#权限管理
from rest_framework.permissions import IsAuthenticated,AllowAny,IsAdminUser
#限流
from rest_framework.throttling import UserRateThrottle,AnonRateThrottle,ScopedRateThrottle

class BookModelViewSet(ModelViewSet):
    """
    图书管理视图
    """
    serializer_class = BookSerializer

    def get_queryset(self):
        return BookInfo.objects.all()

    #认证管理
    #认证管理一般和权限管理配合使用
    # authentication_classes = [SessionAuthentication]
    #权限管理
    # 通过python manager createsuperuser 就可以创建一个管理员账号,登录之后就可以访问
    # permission_classes = [IsAuthenticated]
    #限流
    throttle_classes = [AnonRateThrottle]

4）过滤Filtering

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

pip install django-filter

安装应用:

INSTALLED_APPS = [
    ...
    'django_filters',
    ...
]

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

REST_FRAMEWORK = {
    'DEFAULT_FILTER_BACKENDS': ('django_filters.rest_framework.DjangoFilterBackend',)
}

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

from rest_framework.viewsets import ModelViewSet
from .serializers import BookSerializer
from .models import BookInfo
# Create your views here.

class BookModelViewSet(ModelViewSet):
    """
    图书管理视图
    """
    serializer_class = BookSerializer

    def get_queryset(self):
        return BookInfo.objects.all()

    #过滤
    filter_fields = ['id','name','pub_date']

# 127.0.0.1:8000/books/?name=西游记

5）排序OrderingFilter

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

使用方法：

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

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

示例：

from rest_framework.viewsets import ModelViewSet
from .serializers import BookSerializer
from .models import BookInfo
# Create your views here.

#排序
from rest_framework.filters import OrderingFilter


class BookModelViewSet(ModelViewSet):
    """
    图书管理视图
    """
    serializer_class = BookSerializer

    def get_queryset(self):
        return BookInfo.objects.all()

    #排序
    filter_backends = [OrderingFilter]
    ordering_fields = ['id','readcount','commentcount']

    # 127.0.0.1:8000/books/?ordering=-readcount

6）分页Pagination

REST framework提供了分页的支持

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

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS':  'rest_framework.pagination.PageNumberPagination',
    'PAGE_SIZE': 100  # 每页数目
}

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

class NewSetPagination(PageNumberPagination):
    page_size = 3
    page_size_query_param = 'page_size'
    max_page_size = 100
    


class BookInfoAPIView(RetireveAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerialzer
    pagtination_class = NeSetPagination

可选分页器

1）PageNumberPagination

前端访问网址形式：

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

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

  • page_size 每页数目
  • page_query_param 前端发送的页数关键字名，默认为"page"
  • page_size_query_param 前端发送的每页数目关键字名，默认为None
  • max_page_size 前端最多能设置的每页数量
from rest_framework.viewsets import ModelViewSet
from .serializers import BookSerializer
from .models import BookInfo
#分页
from rest_framework.paginaation import PageNumberPagination

class NewSetPagination(PageNumberPagination):
    
    # 默认每页返回的条数
    page_size = 6
    # 每页返回的最大条数
    max_page_size = 50
    # 设置查询参数传参时候的 page_size 的关键字名 默认为page_size
    page_size_query_param = 'ps'
    # 设置传参数传参的时候 page 的关键字名 默认为page
    page_query_param = 'p'


class BookInfoViewSet(ModelViewSet):
    
    serializer_class = BookInfoSerialzer
    
    def get_queryset(self):
        return Bookinfo.objects.all()
    
    # 分页
    pagination_class = NewSetPagination
    
    # http://127.0.0.1:8000/books/?p=1&ps=10

2）LimitOffsetPagination

前端访问网址形式：

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

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

  • default_limit 默认限制，默认值与PAGE_SIZE设置一致
  • limit_query_param limit参数名，默认’limit’
  • offset_query_param offset参数名，默认’offset’
  • max_limit 最大limit限制，默认None
from rest_framework.viewsets import ModelViewSet
from .serializers import BookSerializer
from .models import BookInfo
#分页
from rest_framework.pagination import LimitOffsetPagination

class NewLimitOffsetPagination(LimitOffsetPagination)
	# 设置每页显示的条数
	default_limit = 5
    # 设置查询参数传参的时候 limit 的关键字名
    limit_query_param = 'li'
    # 设置查询参数传参的时候 offset 的关键字名
    offset_query_param = 'off'
    # 设置每页显示的最大条数
    max_limit = 15


class BookInfoViewSet(ModelViewSet):
    
    serializer_class = BookInfoSerialzer
    
    def get_queryset(self):
        return BookInfo.objects.all()
    
    # 分页
    pagination_class = NewLimitOffsetPagination
        
    # http://127.0.0.1:8000/books/?li=2$off=3

7）异常处理Exceptions

REST framework提供了异常处理，我们可以自定义异常处理函数。例如处理关于数据库的异常

from rest_framework.views import exception_handler
from rest_framework import status
from django.db import DatabaseError
from rest_framework.response import Response

def custom_exception_handler(exc, context):
    #exc 当前异常的对象
    #context 哪个地方出的问题

    #先调用REST framework默认的异常处理方法获得标准错误响应对象
    response = exception_handler (exc, context)
    #在此处补充自定义的异常处理
    if response is None:
        view = context['view']
        if isinstance(exc, DatabaseError):
            print('[%s]: %s' % (view, exc))
            response = Response({'detail': '服务器内部错误'}, status=status.HTTP_507_INSUFFICIENT_STORAGE)

    return response

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

REST_FRAMEWORK = {
    'EXCEPTION_HANDLER': 'book.exceptions.custom_exception_handler'
}

如果未声明，会采用默认的方式，如下

REST_FRAMEWORK = {
    'EXCEPTION_HANDLER': 'rest_framework.views.exception_handler'
}

手动触发异常

from rest_framework.viewsets import ModelViewSet
from .serializers import BookSerializer
from .models import BookInfo
# Create your views here.



class BookModelViewSet(ModelViewSet):
    """
    图书管理视图
    """
    serializer_class = BookSerializer

    def get_queryset(self):

        from django.db import DatabaseError
        raise DatabaseError('error')

        return BookInfo.objects.all()

REST framework定义的异常

  • APIException 所有异常的父类
  • ParseError 解析错误
  • AuthenticationFailed 认证失败
  • NotAuthenticated 尚未认证
  • PermissionDenied 权限决绝
  • NotFound 未找到
  • MethodNotAllowed 请求方式不支持
  • NotAcceptable 要获取的数据格式不支持
  • Throttled 超过限流次数
  • ValidationError 校验失败
王涛涛.
关注
ModelViewSet使用指南
mingyu0530的博客
11-23 2155
ModelViewSet 作用：可以实现增删改查 简化代码 但是代码里不可以有复杂的逻辑 如果有逻辑运算 需要使用APIView 使用： 在View视图中 1.导包 from rest_framework.viewsets import ModelViewSet 2.在类中 调用 先实例化 要获取的数据 然后 使用选择序列化器 3.然后在urls.py中 配置路由 先导包 from rest_framework.routers import DefaultRouter 然后实例化 router =
Django之认证
Lovehanxiaoyan的博客
02-23 145
认证Authentication 可以在配置文件中配置全局默认的认证方案 REST_FRAMEWORK = { 'DEFAULT_AUTHENTICATION_CLASSES': ( 'rest_framework.authentication.BasicAuthentication', # 基本认证 'rest_framework.authentica...
Django rest_framework 视图的全局认证和局部认证
weixin_44105522的博客
12-20 498
Django rest_framework 视图的全局认证和局部认证 当APIView对象执行initialize_request方法创建Reuqest对象时，调用类视图的get_authenticators方法，该方法是从类视图中的authentication_classes属性获取认证类列表然后通过遍历获取认证对象列表。 如果在子类中包含了该属性，则直接获取，这样的认证类属于局部定义，即在类视...
Django里rest_framework的视图组件ModelViewSet进行优化视图
xiao-啸
07-25 1366
使用视图组件进行接口优化 使用视图组件的generics进行接口逻辑优化 导入ModelViewSet from rest_framework.viewsets import ModelViewSet 定义序列化类 class BookSerializer(serializers.ModelSerializer): class Meta: model = 指定模型...
Django之from rest_framework import viewsets
我就叫贝塔
08-04 782
''' 我们不是编写多个视图，而是将所有常见的行为组合到一个名为viewset的类中。 如果需要的话，我们可以很容易地将它们分解为单独的视图，但是使用viewset使视图逻辑组织得很好，并且非常简洁。 ''' class UserViewSet(viewsets.ModelViewSet): pass 源码: class ModelViewSet(mixins.CreateModelMixin, mixins.RetrieveModelMixin,
Django REST framework讲义PDF全集，中文文档PDF版
08-11
它包括序列化、认证、权限管理、分页、过滤等关键功能，并且支持自定义，以满足各种项目需求。DRF的API友好，文档详尽，社区活跃，是开发Web API的首选框架之一。 二、序列化 在DRF中，序列化是将Python对象转换为...
Django rest framework实现分页的示例
09-20
总结来看，在Django REST framework中实现分页功能涉及到了API的路由设置、数据的序列化、分页对象的创建和配置以及视图的编写。通过不同分页方式的选择和自定义配置，开发者可以灵活地根据应用需求提供最合适的分页...
django rest framework 自定义返回方式
12-17
在使用Django Rest Framework开发API时，我们常常需要自定义返回信息，以便更好地与前端进行交互。默认情况下，DRF的响应（Response）通常只包含数据（data），这对于某些复杂的应用场景是不够的，因为我们还需要...
重写 Django REST framework drf-api-logger 应用
最新发布
06-29
在Django REST Framework（DRF）中，`drf-api-logger`是一个非常有用的库，它可以帮助开发者记录API请求的日志，以便于监控、调试和分析应用的行为。然而，原始的`drf-api-logger`可能并不完全满足所有需求，比如在...
Django rest framework使用ModelViewSet视图集
运维求生之路
08-06 1720
ModelViewSet是封装度最高的DRF的视图类。包含了增删改查中的所有接口操作。 它继承自GenericViewSet、ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestoryModelMixin。 使用视图集，可以将一系列逻辑相关的动作放到一个类中： list() 提供一组数据 retrieve() 提供单个数据（详情） create() 创建数据 update() 更新数据 destory() 删除数据
Django之restframework的视图集ViewSet
s_daqing的博客
06-05 370
使用视图集ViewSet，可以将一系列逻辑相关的动作放到一个类中： list() 提供一组数据 retrieve() 提供单个数据 create() 创建数据 update() 保存数据 destory() 删除数据 ViewSet视图集类不再实现get()、post()等方法，而是实现动作 action 如 list() 、create() 等。 视图集只在使用as_view()方法的时候，才会将action动作与具体请求方式对应上。如： class BookInfoViewSet(viewsets.Vi
django Rest Framework 系列 6 - ViewSets & Routers
蓝精灵
04-18 1940
官网地址：http://www.django-rest-framework.org/tutorial/6-viewsets-and-routers/REST框架包含一个用于处理ViewSets 的抽象概念，它允许开发人员能专注于API的状态和相互作用进行建模,并基于常规约定自动构建URL。 ViewSet 类和 View 类几乎是一样的,区别是它提供了类似于read 或 update 这样的操作
django rest framework 自定义ModelViewSet的返回内容
qq_35753140的博客
05-09 7471
django rest framework的ModelViewSet非常爽，省了一大堆业务逻辑代码，跟自己手写restful的API 比至少减了100多行代码，而且serializer这种东西都是复制就行，少耗费好多脑细泡。create和update的时候的各种异常根本不用自己检查，直接就能报出来，加上django的国际化功能，直接甩中文，贼轻松，类似这样： { "name": [ ...
Django Rest framework视图集-----ViewSet
Dong
06-01 1176
视图集ViewSet 使用视图集ViewSet，可以将一系列逻辑相关的动作放到一个类中： list() 提供一组数据 retrieve() 提供单个数据 create() 创建数据 update() 保存数据 destory() 删除数据 1. 常用视图集父类 1） ViewSet 继承自APIView与ViewSetMixin，作用也与APIView基本类似，提供了身份认证、权限...
Django REST framework之ModelViewSet继承关系
Quincy.Coder的博客
02-27 1860
class ModelViewSet(mixins.CreateModelMixin, mixins.RetrieveModelMixin, mixins.UpdateModelMixin, mixins.DestroyModelMixin, mi...
REST framework 视图类之视图集 viewsets
Waller_的博客
02-19 526
viewsets viewsets内拥有5个功能类 ViewSetMixin 作为viewsets内其他4个功能类的基本功能类(其他类直接或间接的继承了它) 功能:重写as_view()，可以将请求方法与视图类中的自定义函数名完成映射 如:as_view({'get': 'list', 'post': 'my_post'}) ViewSet 继承:ViewSetMixin, v...
Django-restframework13 ViewSets
runnoob_1115的博客
11-09 1910
1.简介 路由系统是用于接收合适的请求，然后返回相应的响应 REST框架允许将一系列相关的业务逻辑函数写在一起，称为ViewSet.在其他框架中，相似的实现也被称为’Resources’或者’Controllers’. 一个ViewSet类也是一个基础的View类，不提供任何请求处理函数，如get或post,只提供类似list和created这样的方法 一个ViewSet类，通过.as_view()
使用 Django REST framework 的 Viewsets
zhexiao
05-28 1424
简单点说，DRF的Viewsets就允许你将一批功能类似或者有流程的接口写在一个类里面。 比如我有一个流程：需要先A, 后B，再C，后D，完成4个顺序接口，则可以这样使用Viewsets。 view.py from rest_framework import viewsets from rest_framework.decorators import list_route class U...
Django rest framework分页实战教程
在Django REST Framework中，分页是处理大量数据时非常重要的一个功能，它可以有效地提高API性能，避免一次性返回过多数据导致的网络延迟和客户端处理压力。本示例将介绍如何使用Django REST Framework的内置分页...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值