DRF Django restframe work 十大組件

認證

看到認證這兩個字那肯定登錄是其用處之一榜贴，python中使用的話可以自定義認證類栈源；或者用默認的直接在django項目中settings文件中配置RESTFRAME_WORK飒箭，這個是在全局生效的晦譬，自定義類寫好之后只要在需要的地方設置authenication_classess = [自定義認證類]倘要。如果你設置了全局的認證又不想讓某一個視圖進行認證汰翠，只需要把剛剛設置的改為空列表或是空元祖即可

自定義認證類

    from rest_framework.authentication import BaseAuthentication
    from rest_framework.permissions import BasePermission
    from rest_framework.exceptions import AuthenticationFailed
    from store import models

    class Myauthentication(BaseAuthentication):
        def authenticate(self,request):
           # 實現認證邏輯
           token = request._request.GET.get('token')
           obj = models.Token.objects.filter(token=token).first()
           if obj:
                return (obj.appid,token)
          else:
                raise AuthenticationFailed('認證失敗')

局部使用認證類

    REST_FRAMEWORK = {
'DEFAULT_AUTHENTICATION_CLASSES': [
    'rest_framework.authentication.BasicAuthentication',
    'rest_framework.authentication.SessionAuthentication',
    'rest_framework_jwt.authentication.JSONWebTokenAuthentication',
]
}

權限

和上面的一樣自定義的寫好之后锈拨，局部使用寫permission_classess權限類砌庄，全局的使用直接在settings文件配置。

自定義權限

重寫has_object_permission方法

    from rest_framework import permissions
    class IsOwnerOrReadOnly(permissions.BasePermission):

# 重寫has_object_permission方法奕枢，自定義權限類
def has_object_permission(self, request, view, obj):
    # Read permissions are allowed to any request,
    # so we'll always allow GET, HEAD or OPTIONS requests.
    if request.method in permissions.SAFE_METHODS:
        return True

    # Instance must have an attribute named `owner`.
    #obj相當于數據庫中的model娄昆，這里要把owner改為我們數據庫中的user
    return obj.user == request.user

局部使用

    from .permiss import IsOwnerOrReadOnly
    from rest_framework.mixins import CreateModelMixin, 
    from rest_framework.viewsets import GenericViewSet

  class Run(CreateModelMixin,GenericViewSet):
permission_classes= [IsOwnerOrReadOnly]  #自定義認證類局部使用

全局使用權限認證

    REST_FRAMEWORK = {
'DEFAULT_THROTTLE_CLASSES':['store.utils.permisss.IsOwnerOrReadOnly']

}

不想使用全局可以在相對應的視圖里設permission_classes= [] , 空列表

節(jié)流

自定義節(jié)流類

    VISIT_RECORD = {}
class VisitThrottle(object):

    def __init__(self):
        self.history = None

    def allow_request(self,request,view):
        #實現節(jié)流的邏輯
        #基于ip做節(jié)流
        # #獲取用戶訪問的IP地址
        # ip_address = request._request.META.get('REMOTE_ADDR')
        ctime = time.time()
        # if ip_address not in VISIT_RECORD:
        #     #第一次訪問的時候將訪問的時間存儲在字典中（ip地址為Key,訪問的時間為value值）
        #     VISIT_RECORD[ip_address] = [ctime,]
        #
        # #第二次訪問的時候取出訪問的歷史記錄
        # history = VISIT_RECORD[ip_address]

        # 基于用戶的節(jié)流
        username = request.user.username
        if username not in VISIT_RECORD:
            VISIT_RECORD[username] = [ctime, ]
        history = VISIT_RECORD[username]
        self.history = history

        while history and history[-1] < ctime - 10:
            #如果訪問的時間記錄超過60秒,就把超過60秒的時間記錄移除
            history.pop()

        if len(history) < 6:
            history.insert(0,ctime)
            return True

        return False

    def wait(self):
        #一旦用戶訪問次數到達閥值,顯示用戶需要等待的時間
        ctime = time.time()
                    #09:54:30    09:54:28
        return 10 - (ctime - self.history[-1])

局部使用

    class OrderView(APIView):
            # throttle_classes設置節(jié)流類
            throttle_classes = [VisitThrottle,]

全局設置

        REST_FRAMEWORK = {
   'DEFAULT_THROTTLE_CLASSES':['unitls.throttle.VisitThrottle'],
}

使用DRF內置的限頻類

from rest_framework.throttling import  SimpleRateThrottle

推薦使用這種

class VisitThrottle(SimpleRateThrottle):
  #沒有登錄用戶，每分鐘訪問10次
  scope = 'unlogin'
  def get_cache_key(self, request, view):
  return request.user.username

全局設置

    REST_FRAMEWORK = {
   'DEFAULT_THROTTLE_RATES':{
       'unlogin':'10/m',
       'logined':'3/m',
   },
   'DEFAULT_THROTTLE_CLASSES':['unitls.throttle.VisitThrottle'],

}
不想限流可將列表設為空 throttle_classes = []

版本控制

    自定義版本控制類

class ParmasVersion(object):
    def determine_version(self, request, *args, **kwargs):
        version = request.query_params.get('version')
        return version


使用(局部)

class VersionView(APIView):
    #設置獲取版本的類
    versioning_class = ParmasVersion


全局設置

 'DEFAULT_VERSIONING_CLASS':'unitls.version.ParmasVersion',


使用 DRF內置的版本控制類QueryParameterVersioning(局部)

from rest_framework.versioning import QueryParameterVersioning
class VersionView(APIView):
    #設置獲取版本的類
    versioning_class = QueryParameterVersioning


設置文件中的配置信息

REST_FRAMEWORK = {
    'VERSION_PARAM':'version',
    'DEFAULT_VERSION':'v1',
    'ALLOWED_VERSIONS':['v1','v2'],
}


全局設置

REST_FRAMEWORK = {
    'VERSION_PARAM':'version',
    'DEFAULT_VERSION':'v1',
    'ALLOWED_VERSIONS':['v1','v2'],
    'DEFAULT_VERSIONING_CLASS':'rest_framework.versioning.QueryParameterVersioning',
}



使用 DRF內置的版本控制類URLPathVersioning(局部)

from rest_framework.versioning import URLPathVersioning
class VersionView(APIView):
    #設置獲取版本的類
    versioning_class = URLPathVersioning


設置文件中的配置信息

REST_FRAMEWORK = {
    'VERSION_PARAM':'version',
    'DEFAULT_VERSION':'v1',
    'ALLOWED_VERSIONS':['v1','v2'],
}


全局設置

REST_FRAMEWORK = {
    'VERSION_PARAM':'version',
    'DEFAULT_VERSION':'v1',
    'ALLOWED_VERSIONS':['v1','v2'],
    'DEFAULT_VERSIONING_CLASS':'rest_framework.versioning.URLPathVersioning',
}


如果使用URLPathVersioning缝彬，路由格式如下

url(r"^(?P<version>[v1|v2]+)/version/",VersionView.as_view(),name='vvvv')


#使用 DRF內置的版本控制類URLPathVersioning 反向生成url地址

#反向生成url地址 reverse
obj = request.versioning_scheme
url1 = obj.reverse(viewname='orders',request=request)

#使用django的reverse方法反響生成url地址
from django.urls import reverse
url2 = reverse(viewname='orders',kwargs={'version':'v2'})

解析器

因為開發(fā)人員post請求上傳數據時萌焰，傳遞的數據類型不同，我們可能在request._request.POST中獲取不到數據

    case1: Content-Type : application/x-www-form-urlencoded
服務端接收到的post請求的數據格式：username=xxxxx&age=18&sex=男
我們就可以在request._request.POST中獲取到數據

class UserInfoView(APIView):
    def post(self,request,*args,**kwargs):
        username = request._request.POST.get('username')
        age = request._request.POST.get('age')
        sex = request._request.POST.get('sex')


case2:Content-Type:application/json
服務端接收到的post請求的數據格式就是json數據：{"username":"xxxx","age":"18","sex":"男"}
在request._request.POST中就獲取不到數據谷浅，但是在request.body中可以拿到

class UserInfoView(APIView):
    def post(self,request,*args,**kwargs):
        import json
        data = json.loads(request.body.decode('utf8'))
        print(data)


DRF內置的解析器FormParser,JSONParser
使用(局部)：

   from rest_framework.parsers import FormParser,JSONParser
   class UserInfoView(APIView):
      parser_classes = [FormParser,JSONParser]
    
    #這時DRF 內部代碼會根據request.Content-Type和解析器支持的media_type比較
    從而選擇對應的解析器
    
    def post(self,request,*args,**kwargs):
        # 如果使用JSONParser扒俯、FormParser解析數據的話
        data = request.data
        print(data)

序列化

    Django的序列化

#django序例化方式一
books = models.BookInfo.objects.all().values('id','bookname')
books = list(books)
print(type(books), books)
self.ret['books'] = books

#django序例化方式二
books = models.BookInfo.objects.all()
books = [model_to_dict(item) for item in books]
self.ret['books'] = books


DRF 序列化
 第一種：繼承自serializers.Serializer

 class BookDetailSerializer(serializers.Serializer):
         # 正常的字段序列化
         id = serializers.IntegerField()
         bookname = serializers.CharField()
         author = serializers.CharField()
         category = serializers.IntegerField()
         bookdesc = serializers.CharField()
         
         
         # 獲取枚舉類型的文本是 source=get_字段名_display
         status = serializers.CharField(
             source='get_status_display'
         )
         categoryname = serializers.CharField(
             source='get_category_display'
         )
         
         # 自定義方法獲取字段
         chpaters = serializers.SerializerMethodField()
         #序列化時可以自定義方法獲取字段
         def get_chpaters(self,row):
             """ row - > bookinfo """
                 chpaters = models.ChpaterInfo.objects.filter(book=row)
                 ser = ChpaterSerializer(instance=chpaters,many=True,
                                         context=self.context
                                         )
                 return ser.data

 序列化時生成url

url = serializers.HyperlinkedIdentityField(
view_name='chpaterdetail', lookup_field='id',
lookup_url_kwarg='pk',
)

注意：如果序列化類中使用HyperlinkedIdentityField生成url,那我們在序例化時添加context={'request': request}

ser = BookDetailSerializer(
instance=obj,many=False,
context={'request': request}
)


如果出現關聯關系時，獲取model對像的某一個字段

bookname = serializers.CharField(source='book.bookname')

第二種繼承自serializers.ModelSerializer

    class ChpaterDetailSerializer(serializers.ModelSerializer):
#使用ModelSerializer進行章節(jié)詳情的序列化
bookname = serializers.CharField(source='book.bookname')
class Meta:
    model = models.ChpaterInfo
    #fields = "__all__"
    fields = ['id','bookname']


DRF （序列化時）自定義方法獲取數據

 book = serializers.SerializerMethodField()

 def get_book(self,row):
     """ row - > UserInfo"""
         print('======',row.book.all())
         ser = UsersBooksSerializer(
             instance=row.book.all(),
             many=True
         )
    
         return ser.data


DRF depth深度的使用
# depth會根據關聯的數據不停的深入將數據獲取出來（最多不超過10層）
# depth = 1

class UsersSerializer(serializers.ModelSerializer):
class Meta:
    model = models.UserInfo
    fields = "__all__"
    #depth會根據關聯的數據不停的深入將數據獲取出來（最多不超過10層）
    depth = 1


DRF序列化的驗證功能

class UsersSerializer(serializers.ModelSerializer):
#自定義驗證錯誤的信息
username = serializers.CharField(error_messages={'required':'用戶名不能為空'})
class Meta:
    model = models.UserInfo
    fields = "__all__"


class UsersView(APIView):
    def post(self,request,*args,**kwargs):
      """DRF 序列化自帶驗證功能"""
        data = request.data
    #print(data)
        ser = UsersSerializer(data=data)
        if ser.is_valid(): # ser.is_valid()y驗證數據的有效性
            print('驗證后的數據',ser.validated_data)
        #驗證后的數據正確后,保存數據至數據庫
          ser.save()
        else:
            #上傳數據不符合規(guī)范時ser.errors一疯，返回錯誤詳細
            print(ser.errors)
        return Response(data)

自定義字段驗證規(guī)則

class UsersInfoSerializer(serializers.ModelSerializer):
username = serializers.CharField(error_messages={'required':'用戶名不能為空'})
    class Meta:
        model = models.UserInfo
        fields = "__all__"
    
    # 用戶名中必須包含老王兩個字,不包含則認為名字無效
    def validate_username(self,validated_value):
        print(validated_value)
        from rest_framework.exceptions import ValidationError
        if '老王' not in validated_value:
        #驗證不通過陵珍，拋出異常
            raise ValidationError('用戶名不合法')
        #驗證通過，返回數據
        return validated_value

分頁

    自定義分頁類PageNumberPagination
  # 自定制分頁類
class MyPageNumberPagination(PageNumberPagination):
"""[http://127.0.0.1:8000/api/userpage/?    page=1&pagesize=10](https://links.jianshu.com/go?to=http%3A%2F%2F127.0.0.1%3A8000%2Fapi%2Fuserpage%2F%3Fpage%3D1%26pagesize%3D10)"""
# page_size每一返回多少條
page_size = 5
# 設置分頁的參數名
page_query_param = 'page'
# 設置每頁返回數據量的參數名
page_size_query_param = 'pagesize'
# 設置每頁最大返回的條數
max_page_size = 6

使用分頁

          class UsersPageView(APIView):
      
      def get(self,request,*args,**kwargs):
          # 獲取表中所有用戶的row（記錄）
          obj = models.UserInfo.objects.all()
          #實例化分頁的類
          #page_obj = PageNumberPagination()
          page_obj = MyPageNumberPagination()
          #獲取分頁數據
          page_data = page_obj.paginate_queryset( queryset=obj,request=request,view=self)
          # 序列化
          ser = UsersSerializer(instance=page_data,many=True)

          # return Response(ser.data)
          #get_paginated_response會返回上一頁下一頁和總條數
          return page_obj.get_paginated_response(ser.data)

自定義分頁類LimitOffsetPagination
from  rest_framework.pagination import LimitOffsetPagination

class MyLimitOffsetPagination(LimitOffsetPagination):
    """http://127.0.0.1:8000/api/userpage/?limit=10&offset=0"""
    default_limit = 5
    limit_query_param = 'limit'
    offset_query_param = 'offset'
    max_limit = 7


自定義分頁類CursorPagination(會對分頁參數進行加密)
from  rest_framework.pagination import CursorPagination

class MyCursorPagination(CursorPagination):
    """http://127.0.0.1:8000/api/userpage/?cursor=cD01"""
    cursor_query_param = 'cursor'
    page_size = 4
    #返回數據市的排序的方式
    ordering = '-id'
    max_page_size = 8

 設置全局的分頁
 """
     REST_FRAMEWORK = {
         'DEFAULT_PAGINATION_CLASS':'unitl.pagination.MyCursorPagination',
         'PAGE_SIZE':3
     }
 """

視圖

只想增刪改查 ModelViewSet
只想增 CreateModelMixin,GenericViewSet
只想增刪 CreateModelMixin,DestroyModelMixin,GenericViewSet
只想實現簡單的增刪改查ModelViewSet
如果視圖中的業(yè)務邏輯復雜违施，以上都不能滿足的時候互纯，直接使用APIView
CreateModelMixin,DestroyModelMixin,GenericViewSet,ListModelMixin 必須配合 GenericViewSet使用接著路由也會發(fā)生一點改變
ListModelMixin : 返回列表數據據( get請求)
CreateModelMixin : 新增一條數據（Post請求）
RetrieveModelMixin, : 獲取詳情數據 (get請求)
DestroyModelMixin, : 刪除數據的時候 (delete)
UpdateModelMixin : 跟新數據的時候使用 (put)
as_view({'get': 'list'}) ----> ,ListModelMixin
as_view({'post': 'create'}) ----> CreateModelMixin
as_view({'put': 'update'}) ----> UpdateModelMixin
as_view({'delete': 'destroy'}) ----> DestroyModelMixin
```
 定義一個類里面的參數設置最基本的方法
 # queryset： 設置獲取的數據
 queryset = model.objects.all()
 # serializer_class： 設置序列化的類
 serializer_class = [序列化的類]
 # pagination_class ： 設置分頁的類
 pagination_class = [分頁方法]
```

路由

     #自動路由配置

 from django.conf.urls import url,include
 from api import views
 from rest_framework import routers
 
 router = routers.DefaultRouter()
 router.register(r"bookpage",views.BookView,base_name='bookpage')
 
 
 urlpatterns = [
    url(r'v1/',include(router.urls)),
 ]

 
自動路由會生成四個接口
^api/ v1/ ^bookpage/$ [name='bookpage-list']
^api/ v1/ ^bookpage\.(?P<format>[a-z0-9]+)/?$ [name='bookpage-list']
^api/ v1/ ^bookpage/(?P<pk>[^/.]+)/$ [name='bookpage-detail']
^api/ v1/ ^bookpage/(?P<pk>[^/.]+)\.(?P<format>[a-z0-9]+)/?$ [name='bookpage-detail']

渲染器

    INSTALLED_APPS = [
              'rest_framework',
             ]

from rest_framework.renderers import BrowsableAPIRenderer,JSONRenderer,AdminRenderer

class BookView(ModelViewSet):
    # 設置渲染器類型
    renderer_classes = [JSONRenderer]

?著作權歸作者所有,轉載或內容合作請聯系作者

人面猴
序言：七十年代末，一起剝皮案震驚了整個濱河市磕蒲，隨后出現的幾起案子留潦，更是在濱河造成了極大的恐慌，老刑警劉巖辣往，帶你破解...
沈念sama閱讀 219,039評論 6贊 508
死咒
序言：濱河連續(xù)發(fā)生了三起死亡事件兔院，死亡現場離奇詭異，居然都是意外死亡站削，警方通過查閱死者的電腦和手機坊萝，發(fā)現死者居然都...
沈念sama閱讀 93,426評論 3贊 395
救了他兩次的神仙讓他今天三更去死
文/潘曉璐我一進店門，熙熙樓的掌柜王于貴愁眉苦臉地迎上來许起，“玉大人十偶，你說我怎么就攤上這事≡跋福” “怎么了惦积？”我有些...
開封第一講書人閱讀 165,417評論 0贊 356
道士緝兇錄：失蹤的賣姜人
文/不壞的土叔我叫張陵，是天一觀的道長猛频。經常有香客問我狮崩，道長蛛勉，這世上最難降的妖魔是什么？我笑而不...
開封第一講書人閱讀 58,868評論 1贊 295
?港島之戀（遺憾婚禮）
正文為了忘掉前任睦柴，我火速辦了婚禮诽凌，結果婚禮上，老公的妹妹穿的比我還像新娘坦敌。我一直安慰自己皿淋，他們只是感情好，可當我...
茶點故事閱讀 67,892評論 6贊 392
惡毒庶女頂嫁案：這布局不是一般人想出來的
文/花漫我一把揭開白布恬试。她就那樣靜靜地躺著窝趣，像睡著了一般。火紅的嫁衣襯著肌膚如雪训柴。梳的紋絲不亂的頭發(fā)上哑舒，一...
開封第一講書人閱讀 51,692評論 1贊 305
城市分裂傳說
那天，我揣著相機與錄音幻馁，去河邊找鬼洗鸵。笑死，一個胖子當著我的面吹牛仗嗦，可吹牛的內容都是我干的膘滨。我是一名探鬼主播，決...
沈念sama閱讀 40,416評論 3贊 419
雙鴛鴦連環(huán)套：你想象不到人心有多黑
文/蒼蘭香墨我猛地睜開眼稀拐，長吁一口氣：“原來是場噩夢啊……” “哼火邓！你這毒婦竟也來了？” 一聲冷哼從身側響起德撬，我...
開封第一講書人閱讀 39,326評論 0贊 276
萬榮殺人案實錄
序言：老撾萬榮一對情侶失蹤铲咨，失蹤者是張志新（化名）和其女友劉穎，沒想到半個月后蜓洪，有當地人在樹林里發(fā)現了一具尸體纤勒，經...
沈念sama閱讀 45,782評論 1贊 316
?護林員之死
正文獨居荒郊野嶺守林人離奇死亡，尸身上長有42處帶血的膿包…… 初始之章·張勛以下內容為張勛視角年9月15日...
茶點故事閱讀 37,957評論 3贊 337
?白月光啟示錄
正文我和宋清朗相戀三年隆檀，在試婚紗的時候發(fā)現自己被綠了摇天。大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
茶點故事閱讀 40,102評論 1贊 350
活死人
序言：一個原本活蹦亂跳的男人離奇死亡恐仑，死狀恐怖泉坐，靈堂內的尸體忽然破棺而出，到底是詐尸還是另有隱情菊霜，我是刑警寧澤坚冀，帶...
沈念sama閱讀 35,790評論 5贊 346
?日本核電站爆炸內幕
正文年R本政府宣布，位于F島的核電站鉴逞，受9級特大地震影響记某，放射性物質發(fā)生泄漏。R本人自食惡果不足惜构捡，卻給世界環(huán)境...
茶點故事閱讀 41,442評論 3贊 331
男人毒藥：我在死后第九天來索命
文/蒙蒙一液南、第九天我趴在偏房一處隱蔽的房頂上張望。院中可真熱鬧勾徽，春花似錦滑凉、人聲如沸。這莊子的主人今日做“春日...
開封第一講書人閱讀 31,996評論 0贊 22
一樁弒父案畅姊，背后竟有這般陰謀
文/蒼蘭香墨我抬頭看了看天上的太陽。三九已至吹由，卻和暖如春若未，著一層夾襖步出監(jiān)牢的瞬間，已是汗流浹背倾鲫。一陣腳步聲響...
開封第一講書人閱讀 33,113評論 1贊 272
情欲美人皮
我被黑心中介騙來泰國打工粗合，沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留，地道東北人乌昔。一個月前我還...
沈念sama閱讀 48,332評論 3贊 373
代替公主和親
正文我出身青樓隙疚，卻偏偏與公主長得像，于是被迫代替她去往敵國和親磕道。傳聞我的和親對象是個殘疾皇子供屉，可洞房花燭夜當晚...
茶點故事閱讀 45,044評論 2贊 355

DRF Django restframe work 十大組件

認證

自定義認證類

局部使用認證類

權限

自定義權限

局部使用

全局使用權限認證

節(jié)流

自定義節(jié)流類

局部使用

全局設置

使用DRF內置的限頻類

推薦使用這種

全局設置

版本控制

解析器

序列化

第二種繼承自serializers.ModelSerializer

分頁

使用分頁

視圖

路由

渲染器

推薦閱讀更多精彩內容