認證組件

訪問某個介面 需要登陸后才能訪問 

#第一步 寫一個登錄功能 用戶表
	User表
    UserToken表 ：存盤用戶登錄狀態 【這個表可以沒有 如果沒有 把欄位直接卸載User表上也可以】

登錄介面

model.py

class Books(models.Model):
    name = models.CharField(max_length=32)
    price = models.CharField(max_length=32)
    publish = models.ForeignKey(to='Publish',on_delete=models.CASCADE)
    authors = models.ManyToManyField(to='Authors')

    def publish_dict(self):
        return {'name':self.publish.name,'addr':self.publish.addr}

    def author_list(self):
        l = []
        for author in self.authors.all():
            l.append({'name':author.name,'phone':author.phone})
        return l

class Publish(models.Model):
    name = models.CharField(max_length=32)
    addr = models.CharField(max_length=32)

class Authors(models.Model):
    name = models.CharField(max_length=32)
    phone = models.CharField(max_length=32)

class User(models.Model):
    username = models.CharField(max_length=32)
    password = models.IntegerField()

class UserToken(models.Model):
    token = models.CharField(max_length=32)
    user = models.OneToOneField(to='User',on_delete=models.CASCADE,null=True)

url.py

router = SimpleRouter()
router.register('user',views.UserView,'user')
urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/v1/', include(router.urls))
]

views.py

import uuid
from django.shortcuts import render
from .models import User, UserToken
from rest_framework.viewsets import ModelViewSet,ViewSet
from rest_framework.decorators import action
from rest_framework.response import Response


# Create your views here.

class UserView(ViewSet):
    @action(methods=['POST'], detail=False)
    def login(self, request):
        username = request.data.get('username')
        password = request.data.get('password')
        user = User.objects.filter(username=username, password=password).first()
        if user:
            token = str(uuid.uuid4())
           #用戶登陸成功隨機生成一個用不重復的字串 
        	#在Usertoken表中存盤一下 ：1 從來沒有登陸過 插入一條 2登陸過 修改記錄
        UserToken.objects.update_or_create(user=user, defaults={'token': token})
            #如果有就修改 沒有就新增 
            #kwargs 傳入的東西查找 能找到 使用defaults的更新 否則新增一條
            return Response({'code': 100, 'msg': '登陸成功', 'token': token})
        else:
            return Response({'code': 101, 'msg': '用戶名或密碼錯誤'})
    
'''
以后 有的介面組要登錄后才能訪問 有的介面不登陸就能訪問（查詢所有不需要登錄就能訪問 查詢單個 需要登陸才能訪問）
	登錄認證的限制
	
寫登錄介面 回傳token 以后只要帶著token過來 就是登陸了 不帶就是沒有登陸
'''

認證組件使用

# 查詢所有不需要登錄就能訪問
# 查詢單個，需要登錄才能訪問
# 在查詢單個個視圖類中寫authentication_classes=[]

1.寫一個認證類需要繼承BaseAuthentication

from rest_framework.authentication import BaseAuthentication

2.通過看原始碼分析必須重寫authenticate方法在該方法中實作登錄認證

3.如果認證成功回傳兩個值【登錄用戶和token或None】

4.認證不通過拋例外

from rest_framework.exceptions import AuthenticationFailed

5.區域使用和全域使用

區域：只在某視圖類中使用【當前視圖類管理的所有介面均使用過】

class BookView(ViewSetMixin,RetrieveAPIView):
    queryset = Books.objects.all()
    serializer_class = BooksSerializers
    authentication_classes = [LoginAuth]
    '''登錄以后才能查詢單個書資訊'''

全域：全部介面都生效（登錄介面不需要）

REST_FRAMEWORK={
'DEFAULT_AUTHENTICATION_CLASSES': ['app01.authentication.LoginAuth']
}
'''
所有介面都需要認證 登陸不能驗證 區域禁用
'''

區域禁用：

class UserView(ViewSet):
    authentication_classes = []

view.py

#查所有
class BooksView(ViewSetMixin,ListAPIView):
    queryset = Books.objects.all()
    serializer_class = BooksSerializers

#查單個
class BookView(ViewSetMixin,RetrieveAPIView):
    queryset = Books.objects.all()
    serializer_class = BooksSerializers
    authentication_classes = [LoginAuth] #需要寫一個認證類

authentication.py 認證類代碼

#自己寫的認證類 需要繼承某個類
from .models import UserToken
from rest_framework.authentication import BaseAuthentication
from rest_framework.exceptions import AuthenticationFailed

class LoginAuth(BaseAuthentication):
    def authenticate(self,request):
        #在這里實作用戶的驗證 如果是登錄的繼續走 不是就拋例外
        #請求中是否攜帶token判斷是否登錄 地址欄中 request是新的
        token = request.query_params.get('token',None)
        if token: #前端傳入token 去表中查 如果查到了登錄了回傳兩個值 固定的 1.當前登錄用戶 2.token
            user_token=UserToken.objects.filter(token=token).first()
            if user_token:
                return user_token.user,token
            else:
                raise AuthenticationFailed('token認證失敗')#沒登陸就拋例外
        else:
            raise AuthenticationFailed('token沒傳')

權限組件

即便登陸成功 有些介面 還是不能訪問 因為沒有權限

登陸后 有的介面有訪問權限 有的沒有

查詢單個和查詢所有 都要登錄才能訪問 -- 全域認證
	查詢單個需要超級管理員
    查詢所有需要登陸的用戶
    
權限是一個欄位 在User表中加入user_type
欄位

權限的使用

1.寫一個權限類繼承BasePermission

from rest_framework.permissions import BasePermission

2.重寫has_permission方法在該方法實作權限認證在這方法中request.user就是當前登錄用戶

3.如果有權限回傳True

4.如果沒有權限回傳False 定制回傳中文 self.message = '中文'

5.區域使用和全域使用

區域：只在某個視圖類中使用【當前視圖類管理的所有介面都使用

】

class BookView(ViewSetMixin,RetrieveAPIView):
    queryset = Books.objects.all()
    serializer_class = BooksSerializers
    authentication_classes = [LoginAuth] #需要寫一個認證類
    permission_classes = [CommonPermission] #認證和權限都可以加多個 多層

全域：全域所有介面都生效

'DEFAULT_PERMISSION_CLASSES': ['app01.permissions.CommonPermission'],

區域禁用：

permission_classes = []

views.py

class BookView(ViewSetMixin,RetrieveAPIView):
    queryset = Books.objects.all()
    serializer_class = BooksSerializers
    authentication_classes = [LoginAuth] #需要寫一個認證類
    permission_classes = [CommonPermission] #認證和權限都可以加多個 多層

permission.py

#權限類  寫一個類 重寫方法 在方法中實作權限認證
from rest_framework.permissions import BasePermission


class CommonPermission(BasePermission):
    #重寫has_permission方法 有權限回傳True，沒有權限回傳False
    def has_permission(self,request,view):
        #實作權限的控制  -- 要先知道當前的登錄用戶是誰 request.user 前面認證回傳的登錄用戶 就是這里的request.user
        if request.user.user_type == 1:
            return True
        else:
            #沒有權限 可以放一個message
            self.message = '您是%s 您沒有權限' %request.user.get_user_type_display()
            return False

頻率組件

控制某個介面訪問頻率（次數）

查詢所有介面 同一個ip一分鐘只能訪問5次

使用步驟

1.寫一個頻率類繼承SimpleRateThrottle

from rest_framework.throttling import BaseThrottle,SimpleRateThrottle

2.重寫get_cache_key方法回傳什么就以什么做限制先用ip

#客戶端的ip地址 從哪里拿 HttpRequest.META里取
return request.META.get('REMOTE_ADDR')

3.配置一個類屬性

scope = 'lzy'

4.在組態檔中配置

 'DEFAULT_THROTTLE_RATES': {
        'lzy': '5/m',
    },

5.區域使用和全域使用

區域：只在某個視圖類中使用【當前視圖類管理的所有介面都使用

】

    throttle_classes = [CommonThrottle]

全域：全域所有介面都生效

'DEFAULT_THROTTLE_CLASSES': ['app01.throttling.CommonThrottle'],

區域禁用：

    throttle_classes = []

過濾排序

必須繼承GenericAPIView及其子類才能使用這種方式

只有查所有才用到過濾

內置過濾類的使用繼承GenericAPIView

#查所有
class BooksView(ViewSetMixin,ListAPIView):
    queryset = Books.objects.all()
    serializer_class = BooksSerializers
    #這樣就有過濾功能
    filter_backends = [SearchFilter]
    search_fields = ['name']  #按照名字模糊匹配 內置的 固定用法
    search_fields = ['name','price']  #按照名字或價格模糊匹配  其中有一個是相同的都會被篩選出來
ulr = 127.0.0.1:8000/api/v1/books/?seach=書

使用第三方django-filter實作過濾

# 安裝：django-filter
#查所有
class BooksView(ViewSetMixin,ListAPIView):
    queryset = Books.objects.all()
    serializer_class = BooksSerializers
    #這樣就有過濾功能
    filter_backends = [DjangoFilterBackend]
    filterset_fields = ['name'] #支持完整匹配 name=書
    
url = 127.0.0.1:8000/api/v1/books/?name=書2
url = 127.0.0.1:8000/api/v1/books/?name=書2&price=12

自己定制過濾類實作過濾

查詢價格大于100的書
url = http://127.0.0.1:8000/api/v1/books/?price_gt=100

1.定義一個過濾類繼承BaseFilterBackend

from django_filters.rest_framework import DjangoFilterBackend

2.重寫filter_queryset方法

def filter_queryset(self,request, queryset, view):
    price_gt = request.query_params.get('price_gt',None)
    if price_gt:
        qs=queryset.filter(price__gt=int(price_gt))
        return qs
    else:
        return queryset

3.配置在視圖類

filter_backends = [CommentFilter] 
'''可以定制多個 從左往右 依次執行'''

排序的使用

內置
from rest_framework.filters import OrderingFilter

    filter_backends = [OrderingFilter,CommentFilter]
    ordering_fields = ['price']
    #按照價格排序
    
支持查詢的方法
	http://127.0.0.1:8000/api/v1/books/?ordering=price
    http://127.0.0.1:8000/api/v1/books/?ordering=-price
   http://127.0.0.1:8000/api/v1/books/?ordering=-id,pric

分頁

只有查詢才有分頁

drf內置了三個分頁器之前的東西一樣用

第一種:PageNumberPagination

from rest_framework.pagination import LimitOffsetPagination,CursorPagination,PageNumberPagination



class CommonPageNumberPagination(PageNumberPagination):
    page_size = 1 #每頁顯示兩條
    page_query_param = 'page' #page=10 查詢第10也的資料
    page_size_query_param = 'size' # page=10&size=5 查詢第十頁 每頁顯示5條
    max_page_size = 10   #每頁最大的顯示條數
    
    #配置在試圖頁即可
    
    pagination_class = CommonCursorPagination

第二種：LimitOffsetPagination

from rest_framework.pagination import LimitOffsetPagination,CursorPagination,PageNumberPagination



class CommonPageNumberPagination(LimitOffsetPagination):
    default_limit = 3 #每頁顯示3條
    limit_query_param = 'limit' #limit=3
    offset_query_param = 'offset' #offset=1 從第一個位置開始 取limit條
    max_limit = 5
    
    #配置在試圖頁即可
    
    pagination_class = CommonCursorPagination

app用

class CommonPageNumberPagination(CursorPagination):
    cursor_query_param = 'cursor'  #查詢引數
    page_size = 2 #每頁多少條
    ordering = 'id'  #排序欄位
    #配置在試圖頁即可
    
    pagination_class = CommonCursorPagination
#游標分頁 只能下一頁 上一頁 不能跳到中間 但他的效率最高 大資料量分頁 使用這種較好

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/543255.html

標籤：Python

上一篇：Python求取檔案夾內的檔案數量、子檔案夾內的檔案數量

下一篇：03-Pandas詳解

drf 認證組件、權限組件、頻率組件

認證組件

登錄介面

認證組件使用

權限組件

權限的使用

頻率組件

使用步驟

過濾排序

內置過濾類的使用 繼承GenericAPIView

使用第三方django-filter實作過濾

自己定制過濾類實作過濾

排序的使用

分頁

app用

內置過濾類的使用繼承GenericAPIView