restful-framwork續集3

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
}