restful-framwork续集3

时间 2019-11-05

标签 restful framwork 续集繁體版

原文原文链接

1.DRF权限

1.1权限流程

其实咱们版本，认证，权限，频率控制走的源码流程大体相同~~你们也能够在源码里看到~~

咱们的权限类必定要有has_permission方法~不然就会抛出异常~~这也是框架给我提供的钩子~~

咱们先看到在rest_framework.permissions这个文件中~存放了框架给咱们提供的全部权限的方法~~

1.2权限案例

utils/permission.py

class MyPermission(BasePermission):
    message = "VIP用户才能访问"

    def has_permission(self, request, view):
        """
        自定义权限只有vip用户能访问，
        注意咱们初始化时候的顺序是认证在权限前面的，因此只要认证经过~
        咱们这里就能够经过request.user,拿到咱们用户信息
        request.auth就能拿到用户对象
        """
        if request.user and request.auth.type == 2:
            return True
        else:
            return False

views.py

class TestAuthView(APIView):
    authentication_classes = [MyAuth, ]
    permission_classes = [MyPermission, ]

    def get(self, request, *args, **kwargs):
        print(request.user)
        print(request.auth)
        username = request.user
        return Response(username)

全局注册权限

settings.py
REST_FRAMEWORK = {
    # 默认使用的版本控制类
    'DEFAULT_VERSIONING_CLASS': 'rest_framework.versioning.URLPathVersioning',
    # 容许的版本
    'ALLOWED_VERSIONS': ['v1', 'v2'],
    # 版本使用的参数名称
    'VERSION_PARAM': 'version',
    # 默认使用的版本
    'DEFAULT_VERSION': 'v1',
    # 配置全局认证
    # 'DEFAULT_AUTHENTICATION_CLASSES': ["BRQP.utils.MyAuth", ]
    # 配置全局权限
    "DEFAULT_PERMISSION_CLASSES": ["BROP.utils.MyPermission"]
}

2.DRF的频率

2.1介绍

开放平台的API接口调用须要限制其频率，以节约服务器资源和避免恶意的频繁调用。

咱们的DRF提供了一些频率限制的方法

2.2频率组件原理

DRF中的频率控制基本原理是基于访问次数和时间的，固然咱们能够经过本身定义的方法来实现。

当咱们请求进来，走到咱们频率组件的时候，DRF内部会有一个字典来记录访问者的IP，

以这个访问者的IP为key，value为一个列表，存放访问者每次访问的时间，

{  IP1: [第三次访问时间，第二次访问时间，第一次访问时间]，}

把每次访问最新时间放入列表的最前面，记录这样一个数据结构后，经过什么方式限流呢~~

若是咱们设置的是10秒内只能访问5次，

　　-- 1，判断访问者的IP是否在这个请求IP的字典里

　　-- 2，保证这个列表里都是最近10秒内的访问的时间

　　　　　　判断当前请求时间和列表里最先的(也就是最后的)请求时间的查

　　　　　　若是差大于10秒，说明请求以及不是最近10秒内的，删除掉，

　　　　　　继续判断倒数第二个，直到差值小于10秒

　　-- 3，判断列表的长度(即访问次数)，是否大于咱们设置的5次，

　　　　　　若是大于就限流，不然放行，并把时间放入列表的最前面。

2.3自定义频率组件类

from rest_framework.throttling import BaseThrottle
import time

VISIT_RECORD = {}

class MyThrottle(BaseThrottle):

    def __init__(self):
        self.history = None

    def allow_request(self, request, view):
        # 实现限流的逻辑
        # 以IP限流
        # 访问列表 {IP: [time1, time2, time3]}
        # 1, 获取请求的IP地址
        ip = request.META.get("REMOTE_ADDR")
        # 2，判断IP地址是否在访问列表
        now = time.time()
        if ip not in VISIT_RECORD:
            # --1， 不在 须要给访问列表添加key，value
            VISIT_RECORD[ip] = [now,]
            return True
            # --2 在 须要把这个IP的访问记录 把当前时间加入到列表
        history = VISIT_RECORD[ip]
        history.insert(0, now)
        # 3， 确保列表里最新访问时间以及最老的访问时间差 是1分钟
        while history and history[0] - history[-1] > 60:
            history.pop()
        self.history = history
        # 4，获得列表长度，判断是不是容许的次数
        if len(history) > 3:
            return False
        else:
            return True

    def wait(self):
        # 返回须要再等多久才能访问
        time = 60 - (self.history[0] - self.history[-1])
        return time

#配置局部类使用

REST_FRAMEWORK = {
    # ......
    # 频率限制的配置
    "DEFAULT_THROTTLE_CLASSES": ["Throttle.throttle.MyThrottle"],
    }
}

2.4使用自带的频率控制类

from rest_framework.throttling import SimpleRateThrottle

class MyVisitThrottle(SimpleRateThrottle):
    scope = "WD"

    def get_cache_key(self, request, view):
        return self.get_ident(request)

REST_FRAMEWORK = {
    # 频率限制的配置
    # "DEFAULT_THROTTLE_CLASSES": ["Throttle.throttle.MyVisitThrottle"],
    "DEFAULT_THROTTLE_CLASSES": ["Throttle.throttle.MyThrottle"],
    "DEFAULT_THROTTLE_RATES":{
        'WD':'5/m',         #速率配置每分钟不能超过5次访问，WD是scope定义的值，

    }
}

3.分页组件

3.1PageNumberPagination

utils/pagination.py

from rest_framework.pagination import PageNumberPagination, LimitOffsetPagination, CursorPagination

class MyPagination(PageNumberPagination):
    # xxxx?page=1&size=2
    page_size = 1
    page_query_param = "page"
    page_size_query_param = "size"
    max_page_size = 3

views.py

from rest_framework.generics import GenericAPIView
from rest_framework.mixins import ListModelMixin
from utils.pagination import MyPagination
from app.models import Book
from app.serializers import BookSerializer
# class BookView(GenericAPIView, ListModelMixin):
#     queryset = Book.objects.all()
#     serializer_class = BookSerializer
#     pagination_class = MyPagination
#     # self.paginate_queryset(queryset)
#
#     def get(self, request):
#         return self.list(request)

class BookView(APIView):
    def get(self, request):
        book_list = Book.objects.all()
        # 分页
        page_obj = MyPagination()
        page_article = page_obj.paginate_queryset(queryset=book_list, request=request, view=self)

        ret = BookSerializer(page_article, many=True)
        # return Response(ret.data)
        # 返回带超连接 需返回的时候用内置的响应方法
                #该方法返回的信息更多些
        return page_obj.get_paginated_response(ret.data)

urls.py

urlpatterns = [
    path('admin/', admin.site.urls),
re_path(r"book", BookView.as_view()),
]

3.2LimitOffsetPagination

utils/pagination.py

class MyPagination(LimitOffsetPagination):

    default_limit = 1
    limit_query_param = "limit"
    offset_query_param = "offset"
    max_limit = 3

views.py

class BookView(GenericAPIView, ListModelMixin):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    pagination_class = MyPagination
    # self.paginate_queryset(queryset)

    def get(self, request):
        return self.list(request)

3.3CursorPagination

utils/pagination.py

class MyPagination(CursorPagination):

    cursor_query_param = "cursor"
    page_size = 2
    ordering = "-id"

views.py

class BookView(GenericAPIView, ListModelMixin):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    pagination_class = MyPagination
    # self.paginate_queryset(queryset)

    def get(self, request):
        return self.list(request)

views.py

class BookView(APIView):
    def get(self, request):
        book_list = Book.objects.all()
        # 分页
        page_obj = MyPagination()
        page_article = page_obj.paginate_queryset(queryset=book_list, request=request, view=self)

        ret = BookSerializer(page_article, many=True)
        return Response(ret.data)

3.4全局配置pagesize

REST_FRAMEWORK = {
    'PAGE_SIZE': 2
}