首页 > 其他分享 >drf认证组件/权限/频率 排序组件 分页组件

drf认证组件/权限/频率 排序组件 分页组件

时间：2023-02-07 22:24:49浏览次数：37  
标签：price py queryset 认证 classes 组件 排序 class drf

Drf认证组件

eg：个别接口需要登录后才可以使用 局部使用

# 需要编写一个认证类 
# 在py文件中创建一个认证类的py文件authentication.py

通过继承来编写：eg：登录验证

from rest_framework.authentication import BaseAuthentication
# 编写认证组件需要继承 认证类
from rest_framework.exceptions import AuthenticationFailed
# 认证失败报异常模块

class LoginAuth(BaseAuthentication):
    def authenticate(self, request):
        token = request.META.get('HTTP_TOKEN')
        # 从请求头中获取token
        if token:
            user_token = UserToken.objects.filter(token=token).first()
            # 判断前端传的token是否正确 是否存在
            if user_token:
                return user_token.usertoken, token
              # 存在即代表已登录，通过外键获得用户对象
            else:
                raise AuthenticationFailed('token认证失败')
                # 认证失败要抛异常 调用模块
        else:
            raise AuthenticationFailed('暂未登录')
            
 
# 视图类绑定认证---------------------------------------
class BooksDetailView(GenericViewSet, RetrieveAPIView):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    authentication_classes = [LoginAuth]
    # 通过authentication_classes来设置执行的认证器，认证成功以后才可以使
    # 用类中的方法
    
    
总结：
# 1 写一个认证类，继承BaseAuthentication
# 2 重写authenticate方法，在该方法在中实现登录认证：token正确即为登录
# 3 如果认证成功，返回两个值【返回用户对象，和 token】
# 4 认证不通过，抛异常AuthenticationFailed
# 5 局部使用和全局使用

全局使用/局部不使用

# 在settings.py文件中最下方添加该认证类，这样默认就是给所有的接口都生效

REST_FRAMEWORK = {
  'DEFAULT_AUTHENTICATION_CLASSES'['app01.authenticate.LoginAuth']
	}


# 如何要局部不使用：

class BooksDetailView(GenericViewSet, RetrieveAPIView):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    authentication_classes = []
    # 只需要在局部把这个认证类置空即可，那么这个类里面的接口都不需要认证了

Drf权限组件

eg：某些接口需要管理员身份，或vip等才可以使用

局部配置

# 需要编写一个权限类 
# 在py文件中创建一个认证类的py文件permissions.py

from rest_framework.permissions import BasePermission
# 导入权限设置类


class CommonPermission(BasePermission):
  # 继承类并重新方法
    def has_permission(self, request, view):
        if request.user.user_type == 1:
          # 判断用户权限是否符合
            return True
          # 权限符合通过就返回 True
        else:
            self.message = f'您是{request.user.get_user_type_display()}'
            # 返回错误信息，错误信息在self.message中
            return False
          # 权限不对就返回 false
          
 知识点：{request.user.get_user_type_display()}
# 搭配数据库中choices=((1,'超级管理员'),(2,'普通用户'))使用
# 通过get_字段名__display()方法可以把数字对应的说明取出来



# 视图类----------------------------------------
class BooksDetailView(GenericViewSet, RetrieveAPIView):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    permission_classes = [CommonPermission]
    # 设置该接口需要的权限类即可
    # 局部配置

全局配置

# 在settings.py文件中最下方添加该认证类，这样默认就是给所有的接口都生效

REST_FRAMEWORK = {
  
  'DEFAULT_AUTHENTICATION_CLASSES':        ['app01.authentications.LoginAuth'],
    'DEFAULT_PERMISSION_CLASSES': ['app01.permissions.CommonPermission']
  
}
# 全局配置


# 局部禁止

class BooksView(GenericViewSet, ListAPIView, CreateAPIView, ):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    authentication_classes = []
    permission_classes = []
    # 局部取消权限认证

总结：

# 1 写一个权限类，继承BasePermission
# 2 重写has_permission方法，在该方法在中实现权限认证，在这方法中，request.user就是当前登录用户
# 3 如果有权限，返回True
# 4 没有权限，返回False， 要定制返回的中文： self.message='中文'
# 5 局部使用和全局使用

Drf频率组件

# 需要编写一个频率类 
# 在py文件中创建一个认证类的py文件throttling.py

from rest_framework.throttling import SimpleRateThrottle
# 导入需要继承的类

class Throttling(SimpleRateThrottle):
    scope = 'booksListThrottling'
    # 设置这个类的别名
    def get_cache_key(self, request, view):
        return request.META.get('REMOTE_ADDR')
        # 这里返回什么就什么做限制，现在是已ip地址做限制
        # return request.user.pk 这种是按照用户id限制
        
        
视图类---------------------------------------
class BooksDetailView(GenericViewSet, RetrieveAPIView):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    permission_classes = []
    throttle_classes = [Throttling]
    # 导过来刚刚写的频率类即可生效
    
    
设置频率类的参数------------------------------
django的sttings文件中配置

REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': ['app01.authentications.LoginAuth'],
    'DEFAULT_PERMISSION_CLASSES': ['app01.permissions.CommonPermission'],
    'DEFAULT_THROTTLE_RATES': {
        'booksListThrottling': '5/m',
        # 配置别名为booksListThrottling的频率类，频率为1分钟5次访问
    },
}


# 1 写一个频率类，继承SimpleRateThrottle
# 2 重写get_cache_key方法，返回什么，就以什么做限制----》ip，用户id做限制
# 3 配置一个类属性：scope = 'book_5_m'
# 4 在配置文件中配置
  'DEFAULT_THROTTLE_RATES': {
        'book_5_m': '5/m',
    },
# 5 局部使用和全局使用
	-局部：只在某个视图类中使用【当前视图类管理的所有接口】
        class BookDetailView(ViewSetMixin, RetrieveAPIView):
    		throttle_classes = [CommonThrottle]
    -全局：全局所有接口都生效
          REST_FRAMEWORK = {
             'DEFAULT_THROTTLE_CLASSES': ['app01.throttling.CommonThrottle'],

        }
    
    -局部禁用：
    	 class BookDetailView(ViewSetMixin, RetrieveAPIView):
            throttle_classes = []

drf三种过滤方式

restful规范中要求，请求地址中带过滤条件
eg：
只有一个接口需要过滤和排序，就是：查所有接口

# 方式一： 内置模块 模糊搜索

from rest_framework.filters import SearchFilter
# 内置的过滤功能，模糊匹配
# 必须搭配GenericAPIView或其子类使用

lass BooksView(GenericViewSet, ListAPIView, CreateAPIView, ):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    permission_classes = []
    # 权限设置功能置空
    throttle_classes = [Throttling]
    # 频率设置功能
    filter_backends = [SearchFilter]
    # 固定语法用法 
    search_fields = ['name']
    # 配置要模糊搜索的表字段名
    
http://127.0.0.1:8003/api/books/?search=海
# 必要要用search来使用
# 这样就实现了模糊搜索 名字中带有海的图书名

精确查找 第三方查询模块Django-filter

from django_filters.rest_framework import DjangoFilterBackend
# 需要导入这个类  


# 视图类中代码
class BooksView(GenericViewSet, ListAPIView, CreateAPIView, ):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    permission_classes = []
    throttle_classes = [Throttling]
    filter_backends = [DjangoFilterBackend]
    # 固定配置用法 带入DjangoFilterBackend类
    filterset_fields = ['name']
    # 设置精确查找字段 也可以设置多个 and关系
    
http://127.0.0.1:8003/api/books/?name=海贼王
# 不需要搭配search来使用了
# 只能精确查找，找不到返回空

自定义搜索类

# 需要编写一个频率类 
# 在py文件中创建一个认证类的py文件filter.py 存放编写的自定义过滤类

from rest_framework.filters import BaseFilterBackend
# 继承该类 进行编写

class booksfilter(BaseFilterBackend):
    def filter_queryset(self, request, queryset, view):
        # 在里面实现过滤，返回queryset对象就是过滤后的对象
        # eg：价格大于100的图书，
        price_gt = request.query_params.get('price_gt', None)
        # 从get请求头里面拿到要搜索的条件
        if price_gt:
            return queryset.filter(price__gt=int(price_gt))
            # 字段实现__gt大于方法 需要该字段为整形才可以
            # 将符合条件的对象返回出去
        else:
            return queryset
          
 视图类---------------------------

class BooksView(GenericViewSet, ListAPIView, CreateAPIView, ):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    permission_classes = []
    throttle_classes = [Throttling]
    filter_backends =   		[SearchFilter,DjangoFilterBackend,booksfilter]
    # 可以同时支持多个过滤类方法，从左到右生效
    search_fields = ['name','price']
    # 固定配置用法
    filterset_fields = ['name','price']
    # 对表字段name进行搜索，只支持精确搜索

# http://127.0.0.1:8003/api/books/?search=海   触发SearchFilter模糊搜索

# http://127.0.0.1:8003/api/books/?name=海贼王   DjangoFilterBackend的精确搜索
    
    
# http://127.0.0.1:8003/api/books/?price_gt=100
# 触发自己定制的搜索类，自己定制的方法price_gt 查找单价大于100的

排序的使用

使用drf内置模块即可

# 视图类----------

from rest_framework.filters import OrderingFilter


class BooksView(GenericViewSet, ListAPIView, CreateAPIView, ):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    permission_classes = []
    throttle_classes = [Throttling]
    filter_backends = [OrderingFilter,SearchFilter,DjangoFilterBackend,booksfilter]
    # 排序的类放到最前面
    search_fields = ['name','price']
    # 固定配置用法
    filterset_fields = ['name','price']
    ordering_fields = ['price']
    # 设置需要排序的字段



http://127.0.0.1:8003/api/books/?ordering=price
# 触发排序的方法 对price字段进行排序 默认升序 从小到大
# ordering=-price 从大到小 加上-号

分页

只有查询所有接口才有分页
def内置3个分页器

分页器一（最常用，网页端）

# 必须继承 GenericAPIView 或子类 才可以使用
# # 需要编写一个分页类 
# 在py文件中创建一个认证类的py文件Page.py

from rest_framework.pagination import PageNumberPagination

class booksPageNumber(PageNumberPagination):
    page_size = 2
    # 控制每页显示条数，每页显示2条
    page_query_param = 'page'
    # 查询第10页的数据，一般不需要改
    page_size_query_param = 'size'
    # page=10&size=5 查询第10页 每页显示2条
    max_page_size = 10
    # 每页最大显示条数设置
    

    
视图类-------------直接配置上就可以了

class BooksView(GenericViewSet, ListAPIView, CreateAPIView, ):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    permission_classes = []
    authentication_classes = []
    throttle_classes = []
    filter_backends = [OrderingFilter,SearchFilter,DjangoFilterBackend,booksfilter]
    search_fields = ['name','price']
    # 固定配置用法
    filterset_fields = ['name','price']
    ordering_fields = ['price']
    pagination_class = booksPageNumber
    # 这里配置上写好的booksPageNumber分页类就可以实现了
    
    
 http://127.0.0.1:8003/api/books/
 # 不写默认是第一页
 http://127.0.0.1:8003/api/books/?page=2%size=10
 # 查询第二页 显示10条，但是这个最大显示数还是根据分页类中设置的

分页器二（偏移取值）不常用

# 在py文件中创建一个认证类的py文件Page.py
from rest_framework.pagination import PageNumberPagination, \
    LimitOffsetPagination, CursorPagination

class booksLimitOffsetPagination(LimitOffsetPagination):
    default_limit = 2
    # 控制每页显示条数，每页显示2条
    limit_query_param = 'limit'
    # 查询页数控制关键字  limit=2 查询第二页
    offset_query_param = 'offset'
    # offset=1 位置偏移设置，从第一个位置取 索引取值
    max_limit = 10
    # 最大显示数
    
    
 class BooksView(GenericViewSet, ListAPIView, CreateAPIView, ):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    permission_classes = []
    authentication_classes = []
    pagination_class = booksLimitOffsetPagination
    # 配置分页器
    
    
http://127.0.0.1:8003/api/books/?limit=4&offset=1
# 意思是 位置偏移1 从一个位置以后拿4个数据  12345拿2345

分页器三 游标分页 app项目经常使用

# 在py文件中创建一个认证类的py文件Page.py
from rest_framework.pagination import CursorPagination


class BooksCursorPagination(CursorPagination):
    cursor_query_param = 'cursor'
    # "http://127.0.0.1:8003/api/books/?cursor=cD01",
    # 设置显示的关键词
    page_size = 2
    # 设置每页显示条数
    ordering = 'id'
    #游标分页自带排序，设置根据排序的字段
    
    
    
class BooksView(GenericViewSet, ListAPIView, CreateAPIView, ):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    permission_classes = []
    authentication_classes = []
    throttle_classes = []
    filter_backends = [SearchFilter,DjangoFilterBackend,booksfilter]
    search_fields = ['name','price']
    # 固定配置用法
    filterset_fields = ['name','price']
    ordering_fields = ['price']
    pagination_class = BooksCursorPagination
    # 匹配游标分页类 使用游标分类后就不可以使用drf的排序了，因为游标分页自带排序
    
    
 # 游标分页只能下一页或者上一页，不能直接取中间的，类似app下滑上滑
 # 但游标分页效率最高 大数据量推荐使用

标签：price,py,queryset,认证,classes,组件,排序,class,drf
From： https://www.cnblogs.com/moongodnnn/p/17100001.html

相关文章

  • drf(6)
    1认证组件#以后有的接口需要登录后才能访问有的接口不登录就能访问 -登录认证的限制#写一个登录接口,返回token,以后只要带着token过来就是登录了，不带，就......
  • DRF - 过滤与排序、分页组件
    目录过滤与排序1.drf内置过滤类【继承GenericAPIView】导入内置过滤器-SearchFilterviews.py-搜索方式2.第三方过滤器导入模块这里用到了第三方模块django-filtersviews......
  • DRF - 过滤与排序、分页器
    目录频率组件1.频率限制2.频率认证步骤3.全局使用和局部使用（1）局部权限：对单独的视图类生效（2）全局权限：对于全局的视图类生效（3）全局权限+局部禁用4.代码演示throttling.py-......
  • drf权限组件 频率组件 过滤排序 分页
    1认证组件#以后，有的接口需要登录才能访问，有的接口，不等了就能访问 -登录认证的限制#写一个登录接口，返回token，以后只要带着token过来，就是登陆了，不带就是没有登录#......
  • DRF三大认证
    DRF三大认证一、认证组件1.基本使用​ 关于认证组件，现实生活中我们经常用到该组件，比如逛淘宝在首页浏览商品不用登录，搜商品也不需要登录，游客模式即可。但是一旦涉及到......
  • drf之三大认证、过滤、排序、分页组件
    drf之三大认证、过滤、排序、分页组件本文所介绍的组件，都有着很相似的配置方式，继承组件类，类体中配置参数，视图类中配置参数添加对应的组件类或者全局配置，我们就可以方便的......
  • drf-认证、权限、频率、过滤、排序、分页
    1.认证组件1.1局部认证1.首先写两个接口，一个查询单个一个查询所有，我们利用视图扩展类和视图子类写在一个视图类上:views.py:fromrest_framework.viewsetsimportVie......
  • drf从入门到精通 07
    今日内容详细认证组件有些接口需要登录才能够访问有些不需要登录就可以直接访问由此引出来了认证组件需求查看所有和创建无需登陆其他需要登录先写一个登录接口......
  • drf从入门到飞升仙界 06
    模型类准备fromdjango.dbimportmodels#图书跟作者：多对多，需要建立中间表，但是我们可以通过ManyToManyField自动生成，写在哪里都行#图书跟出版社：一对多，一个出版社，出......
  • vue高级进阶( 一 ) 组件精髓概述
    前言这个系列可能会分为几部分：基础以及高级用法总结一些比较有代表性的实战源码解析（一定是用最粗俗，不对，是最通俗的语言讲解，这个我可以保证）总之一定对得起高级......

赞助商

阅读排行

网站主页关于我们联系我们网站地图

本网站内容转载自其他媒体，侵权联系[admin##ips99.com]。

Copyright © 2020-2023 IPS99 版权所有 IPS99