**
DRF十大元件
**
認證
作用，檢測使用者是否登入
自定義認證類（繼承自object）
class MyBaseAuthentication(Object):
def authenticate(self, request):
#完成認證邏輯
def authenticate_header(self, request):
pass
#自定義認證類（繼承自BaseAuthentication）
from rest_framework.authentication import BaseAuthentication
from rest_framework.exceptions import AuthenticationFailed
class MyBaseAuthentication(BaseAuthentication):
def authenticate(self, request):
#完成認證邏輯
局部配置配置（在視圖中配置）
登入使用者才能通路所有注冊使用者清單(局部使用設定)
authentication_classes = [MyBaseAuthentication,]
設定為空清單，就不走認證流程了（全局設定後，要想單個視圖不走認證）
authentication_classes = []
全局設定
REST_FRAMEWORK = {
'DEFAULT_AUTHENTICATION_CLASSES':['util.authentication.MyBaseAuthentication',],
}
匿名使用者（使用者未登入的情況下，可以設定匿名使用者資訊（ user、auth））
必要條件：不管是全局還是視圖中都沒有設定認證類
REST_FRAMEWORK = {
'UNAUTHENTICATED_USER':lambda :'匿名使用者',
'UNAUTHENTICATED_TOKEN':lambda :'1234',
}
源碼邏輯（看造化）
權限
作用：某些接口隻能是特定的使用者才能通路
使用
自定義權限類（Object）
class MyPermission(object):
message = 'vip使用者才能通路'
def has_permission(self,request,view):
#完成權限邏輯
#傳回True,表示有權限通路
#傳回Flase，表示沒有權限通路
#自定義權限類（BasePermission）
from rest_framework.permissions import BasePermission
class MyPermission(BasePermission):
message = 'vip使用者才能通路'
def has_permission(self,request,view):
#完成權限邏輯
#傳回True,表示有權限通路
#傳回Flase，表示沒有權限通路
局部配置配置（在視圖中配置）
設定權限類(局部使用設定)
permission_classes = [MyPermission,]
設定為空清單，就不走權限流程了（全局設定後，要想單個視圖不走權限設定了）
permission_classes = []
全局設定
REST_FRAMEWORK = {
'DEFAULT_PERMISSION_CLASSES':['util.permission.MyPermission',],
{
節流
作用：根據使用者的ip位址使用者的唯一标示限制使用者的通路頻率
使用
自定義（Object）
RECORD_VISITS = {}
class VisitThrottle(object):
def __init__(self):
#擷取使用者的通路曆史
self.history = []
def allow_request(self, request, view):
#allow_request是否允許方法
#True 允許通路
#False 不允許通路
#擷取使用者的IP位址
# ip_adress = request._request.META.get('REMOTE_ADDR')
# key = ip_adress
#基于使用者
token = request.auth
key = token
currenttime = time.time()
if key not in RECORD_VISITS:
#目前的IP位址沒有通路過伺服器
RECORD_VISITS[key] = [currenttime]
return True
#擷取通路曆史記錄
visit_history = RECORD_VISITS[key]
self.history = visit_history
#[ 12:01:00, 12:01:25, 12:02:25] 12:03:30 - 60
# 12:02:30
while visit_history and visit_history[-1] < currenttime - 60:
visit_history.pop()
if len(visit_history) < 5:
#每分鐘通路5次
visit_history.insert(0,currenttime)
return True
return False # False表示通路頻率太高被限制
def wait(self):
# 12:03:03
# [12:02:58,12:02:55,12:02:50,12:02:45,12:02:40]
first_time = self.history[-1]
return 60 - (time.time() - first_time)
自定義（SimpleRateThrottle）
class MySimpleRateThrottle(SimpleRateThrottle):
scope = 'unlogin'
def get_cache_key(self, request, view):
#根據ip或者使用者标示擷取使用者的通路記錄
return self.get_ident(request)
# return request.user.name
局部使用
設定節流的類(局部使用設定)
throttle_classes = [VisitThrottle,]
throttle_classes = [MySimpleRateThrottle,]
設定為空清單，就不進行節流設定了
throttle_classes = []
全局設定
REST_FRAMEWORK = {
'DEFAULT_THROTTLE_RATES':{
'unlogin':'5/m',
},
'DEFAULT_THROTTLE_CLASSES':['util.throttle.MySimpleRateThrottle',],
}
版本
作用:判斷使用者請求的Api是否有效（公司版本疊代時做相容）
使用
自定義（object）：（url位址傳參）
class MyPathVersioning(object):
def determine_version(self,request, *args, **kwargs):
# 擷取使用者傳遞的版本參數（version）
# version = request._request.GET.get('version')
version = request.query_params.get('version')
return version
#設定自定義的版本類
versioning_class = MyPathVersioning
使用DRF自帶的版本類QueryParameterVersioning
from rest_framework.versioning import QueryParameterVersioning
在視圖中
versioning_class = QueryParameterVersioning
#如果需要做版本的預設和限制，需要在settings中設定
REST_FRAMEWORK = {
'DEFAULT_VERSION':'v1',
'ALLOWED_VERSIONS':['v1','v2','v3'],
'VERSION_PARAM':'version',
}
設定預設的版本
default_version = api_settings.DEFAULT_VERSION
設定允許的版本
allowed_versions = api_settings.ALLOWED_VERSIONS
設定版本的參數
version_param = api_settings.VERSION_PARAM
使用DRF自帶的版本類URLPathVersioning
from rest_framework.versioning import URLPathVersioning
在視圖中（局部使用）
versioning_class = URLPathVersioning
versioning_class = None
#如果需要做版本的預設和限制，需要在settings中設定
REST_FRAMEWORK = {
'DEFAULT_VERSION':'v1',
'ALLOWED_VERSIONS':['v1','v2','v3'],
'VERSION_PARAM':'version',
}
全局設定
REST_FRAMEWORK = {
'DEFAULT_VERSIONING_CLASS':'rest_framework.versioning.URLPathVersioning',
}
解析器
問題？在POST請求中擷取表單參數時，有時在_request.POST中拿不到資料
from rest_framework.parsers import JSONParser,FormParser
FormParser
目前端發送過來的資料是json資料的時候
content-type：application/x-www-form-urlencoded
post請求的資料在_request.POST拿到資料
發送到後端的資料格式productId=123&productName=宋&userId=1
productId = request._request.POST.get('productId')
productName = request._request.POST.get('productName')
userId = request._request.POST.get('userId')
print(productId,productName,userId)
JSONParser
目前端發送過來的資料是json資料的時候
content-type：application/json
post請求的資料在_request.POST已經擷取不到了
在_request.body可以拿到
發送到後端的資料格式{'productId': 123, 'productName': '宋', 'userId': 1}
data = request._request.body
import json
data = json.loads(data)
print(data)
######################上面的寫法并沒有用上解析器##############
#隻用調用request.data的時候才使用上了解析器
data = request.data
print(data)
序列化
DRF中的序列化的作用
1.對查詢出的結果queryset進行序列化，傳回
第一種方式（serializers.Serializer）
class xxxxSerializer(serializers.Serializer):
username = serializers.CharField()
#使用者的id
id = serializers.IntegerField()
# 使用者類型（普通使用者、VIP使用者)
#type = serializers.IntegerField()
type = serializers.CharField(source="get_type_display")
# 1:男 2:女
#自定義序列化方法
gender = serializers.SerializerMethodField()
# 出生日期
birthday = serializers.DateTimeField(format='%Y-%m-%d')
#自定義序列化方法的方法民命規範：def get_字段名(self,row)
#生成url位址
#序列化時傳回使用者詳情的url位址
url = serializers.HyperlinkedIdentityField(
view_name ='userdetail',lookup_field='id',lookup_url_kwarg ='pk')
URL中：
url(r"^(?P<version>[v1|v2]+)/userdetail/(?
P<pk>\d+)/",UserDetailView.as_view(),name='userdetail'),
按性别自定義序列化：
def get_gender(self,row):
##row -> User()
if row.gender == 1:
return "男"
elif row.gender == 2:
return "女"
如果使用serializers.Serializer序列化的類儲存資料時，需要重寫create
def create(self, validated_data):
instance = models.User.objects.create(**validated_data)
return instance
第二種方式（serializers.ModelSerializer）
class UserListSerializer(serializers.ModelSerializer):
class Meta:
model = models.User
#fields = "__all__"
fields = ["id","username"]
2.對請求的資料進行驗證（POST）
class RegisterUserSerializer(serializers.ModelSerializer):
#使用者名
username = serializers.CharField(error_messages=
{
'required':'使用者名不能為空'
},
)
#密碼(A a-z 0-9,不低于8位)
password = serializers.CharField()
#自定義驗證方法(validate_字段名)
def validate_password(self,value):
#value -> password
import re
from rest_framework.exceptions import ValidationError
if re.match(r'[A-Z]',value):
#首字母是大寫
if re.search(r'[a-z]',value) and re.search(r'[0-9]',value) and len(value) > 7:
return value
else:
raise ValidationError('密碼格式錯誤')
else:
raise ValidationError('密碼首字母必須大寫')
class Meta:
model = models.User
fields = ["username","password"]
分頁元件
DRF提供了三種方式
第一種繼承自PageNumberPagination
from rest_framework.pagination import PageNumberPagination
# https://www.baudi.com/?kw=xxx&page=1&pagesize=5
# 自定義分頁類
class MyPageNumberPagination(PageNumberPagination):
#page_size,每頁傳回多少條資料
page_size = 5
#傳遞分頁的參數
page_query_param = 'page'
#傳遞每頁傳回多少條資料的參數
page_size_query_param = 'pagesize'
#每頁傳回資料的最大條數
max_page_size = 10
def get_paginated_response(self, data):
###可選方法，自定義分頁的傳回結果
ret = {
'code':1,
'count':self.page.paginator.count,
'next':self.get_next_link(),
'previous':self.get_previous_link(),
'data':data
}
return Response(ret)
第二種分頁方式LimitOffsetPagination
from rest_framework.pagination import LimitOffsetPagination
##域名格式:####https://www.baudi.com/?kw=xxx&offset=5&limit=5
class MyLimitOffsetPagination(LimitOffsetPagination):
#預設每頁傳回的條數
default_limit = 5
#限制傳回條數的參數名
limit_query_param = 'limit'
#設定起始的偏移量參數
offset_query_param = 'offset'
#每頁傳回資料的最大條數
max_limit = 10
第三種分頁方式CursorPagination
第三種（加密的方式）
from rest_framework.pagination import CursorPagination
##域名格式：###http://127.0.0.1:8000/v2/userlist/?cursor=cD03&pagesize=2
class MyCursorPagination(CursorPagination):
cursor_query_param = 'cursor'
page_size = 5
#排序方式
ordering = '-id'
page_size_query_param = 'pagesize'
max_page_size = 10
視圖中的局部使用
class UserList(APIView):
def get(self,request,*args,**kwargs):
ret = {
'code':1,
'data':None
}
# 擷取使用者清單
queryset = models.User.objects.all()
#執行個體化分頁類
pg = MyCursorPagination()
#調用paginate_queryset進行分頁，擷取目前分頁資料
pg_data = pg.paginate_queryset(queryset=queryset,request=request,view=self)
ser = UserSerializer(
instance=pg_data,
context={'request': request},
many=True
)
# return response(ser.data)
return pg.get_paginated_response(ser.data)
視圖
最早使用的是django自帶的視圖類
from django.views import View
class UserView(View):
def get(self,request,*args,**kwargs):
pass
def post(self,request,*args,**kwargs):
pass
後來使用rest_framework的APIView視圖類（定制性很強）
from rest_framework.views import APIView
class Register(APIView):
def get(self,request,*args,**kwargs):
pass
def post(self,request,*args,**kwargs):
pass
GenericAPIView視圖的使用（其實它繼承自APIView，隻是在APIView的基礎上
添加了屬性和方法,可以提供給我們調用）
from rest_framework.generics import GenericAPIView
class UserGenericAPIView(GenericAPIView):
#擷取使用者的清單
#擷取資料庫中表裡面的資料集
queryset = models.User.objects.all()
#設定序列化的類
serializer_class = UserSerializer
#設定分頁類
pagination_class = MyPageNumberPagination
def get(self,request,*args,**kwargs):
#調用get_queryset擷取結果集
data = self.get_queryset()
#調用paginate_queryset擷取目前分頁下的資料
pd_data = self.paginate_queryset(queryset=data)
#調用get_serializer方法擷取UserSerializer序列化對象
ser = self.get_serializer(
instance=pd_data,many=True,
context={'request':request},
)
# return Response(ser.data)
return self.get_paginated_response(ser.data)
GenericViewSet視圖，路由和請求反射對應的方法就會發生變化
（例如get請求的->list）
from rest_framework.viewsets import GenericViewSet
class UserGenericAPIView(GenericViewSet):
#擷取使用者的清單
#擷取資料庫中表裡面的資料集
queryset = models.User.objects.all()
#設定序列化的類
serializer_class = UserSerializer
#設定分頁類
pagination_class = MyPageNumberPagination
def list(self,request,*args,**kwargs):
#調用get_queryset擷取結果集
data = self.get_queryset()
#調用paginate_queryset擷取目前分頁下的資料
pd_data = self.paginate_queryset(queryset=data)
#調用get_serializer方法擷取UserSerializer序列化對象
ser = self.get_serializer(
instance=pd_data,many=True,
context={'request':request},
)
# return Response(ser.data)
return self.get_paginated_response(ser.data)
## 路由發生的變化如下
url(r"^(?P<version>[v1|v2]+)/userlist/$",UserListView.as_view({'get': 'list','post':'create'})),
url(r"^(?P<version>[v1|v2]+)/userlist/(?P<pk>\d+)/$",UserListView.as_view(
{'delete':'destroy','put':'update','get':'retrieve'}))
####終極視圖的使用
from rest_framework.mixins import ListModelMixin,\
CreateModelMixin,DestroyModelMixin,UpdateModelMixin,\
RetrieveModelMixin
# CreateModelMixin: 新增資料（POST請求）
# DestroyModelMixin: 删除資料（DELETE請求）
# UpdateModelMixin: 更新資料（PUT請求）
# ListModelMixin: 擷取清單資料 (GET請求)
# RetrieveModelMixin: 擷取詳情資料（GET請求）
# 使用以上視圖類的時候一定要和GenericViewSet配合使用
class UserListView(ListModelMixin,CreateModelMixin,
DestroyModelMixin,UpdateModelMixin,
RetrieveModelMixin,GenericViewSet):
#設定資料集
queryset = models.User.objects.all()
#設定序列化類
serializer_class = UserListSerializer
#設定分頁類
pagination_class = MyPageNumberPagination
視圖類使用的總結：
1.繼承自APIVIew的視圖是萬能的，自定義性比較強
2.GenericAPIView視圖的使用（其實它繼承自APIView，隻是在APIView的基礎上
添加了屬性和方法,可以提供給我們調用,一般情況下不會單獨使用它）
3.如果隻是實作簡單的增、删、改、查,下面類可以随機配合使用
CreateModelMixin: 新增資料（POST請求）
DestroyModelMixin: 删除資料（DELETE請求）
UpdateModelMixin: 更新資料（PUT請求）
ListModelMixin: 擷取清單資料 (GET請求)
RetrieveModelMixin: 擷取詳情資料（GET請求）
使用以上視圖類的時候一定要和GenericViewSet配合使用
4.如果隻是實作增、删、改、查功能全部都要實作，可以直接繼承自ModelViewSet
from rest_framework.viewsets import ModelViewSet
自動路由比對（urls.py）
自動路由比對
from rest_framework.routers import DefaultRouter
router = DefaultRouter()
#注冊一個路由
router.register(r'userlist',UserListView)
^(?P<version>[v1|v2]+)/ ^userlist/$ [name='user-list']
^(?P<version>[v1|v2]+)/ ^userlist\.(?P<format>[a-z0-9]+)/?$ [name='user-list']
^(?P<version>[v1|v2]+)/ ^userlist/(?P<pk>[^/.]+)/$ [name='user-detail']
^(?P<version>[v1|v2]+)/ ^userlist/(?P<pk>[^/.]+)\.(?P<format>[a-z0-9]+)/?$ [name='user-detail']
urlpatterns = [
url(r"^(?P<version>[v1|v2]+)/",include(router.urls)),
]
渲染器
step1:添加rest_framework
INSTALLED_APPS = [
.....
'rest_framework',
]
渲染器
渲染器模版
from rest_framework.renderers import JSONRenderer,\
BrowsableAPIRenderer,AdminRenderer
#JSONRenderer:在浏覽器中隻會傳回json資料
#BrowsableAPIRenderer:得到可視化的模版界面
#AdminRenderer:得到管理者可視化的模版界面
局部使用（視圖中）
renderer_classes = [JSONRenderer,AdminRenderer]
全局使用（DRF預設已經設定過了，不需要自己設定）
'DEFAULT_RENDERER_CLASSES': (
'rest_framework.renderers.JSONRenderer',
'rest_framework.renderers.BrowsableAPIRenderer',
),
######################十大元件
認證 ***
權限 ***
節流 ***
版本 ***
解析器 **
序列化 ***
分頁 ***
視圖 ***
路由 **
渲染器 *
![伺服器下拉github代碼并使用定時任務每5分鐘更新（實作熱更新）[圖]](data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs=)