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= [] , 空列表

节流

自定义节流类

    VISIT_RECORD = {}
class VisitThrottle(object):

    def __init__(self):
        self.history = None

    def allow_request(self,request,view):
        #实现节流的逻辑
        #基于ip做节流
        # #获取用户访问的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]

        # 基于用户的节流
        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设置节流类
            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'})

解析器

因为开发人员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进行章节详情的序列化
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:
            #上传数据不符合规范时ser.errors，返回错误详细
            print(ser.errors)
        return Response(data)

自定义字段验证规则

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
如果视图中的业务逻辑复杂，以上都不能满足的时候，直接使用APIView
CreateModelMixin,DestroyModelMixin,GenericViewSet,ListModelMixin 必须配合 GenericViewSet使用接着路由也会发生一点改变
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阅读 214,029评论 6赞 493
死咒
序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
沈念sama阅读 91,238评论 3赞 388
救了他两次的神仙让他今天三更去死
文/潘晓璐我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
开封第一讲书人阅读 159,576评论 0赞 349
道士缉凶录：失踪的卖姜人
文/不坏的土叔我叫张陵，是天一观的道长。经常有香客问我，道长，这世上最难降的妖魔是什么？我笑而不...
开封第一讲书人阅读 57,214评论 1赞 287
港岛之恋（遗憾婚礼）
正文为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
茶点故事阅读 66,324评论 6赞 386
恶毒庶女顶嫁案：这布局不是一般人想出来的
文/花漫我一把揭开白布。她就那样静静地躺着，像睡着了一般。火红的嫁衣衬着肌肤如雪。梳的纹丝不乱的头发上，一...
开封第一讲书人阅读 50,392评论 1赞 292
城市分裂传说
那天，我揣着相机与录音，去河边找鬼。笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。我是一名探鬼主播，决...
沈念sama阅读 39,416评论 3赞 412
双鸳鸯连环套：你想象不到人心有多黑
文/苍兰香墨我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
开封第一讲书人阅读 38,196评论 0赞 269
万荣杀人案实录
序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
沈念sama阅读 44,631评论 1赞 306
护林员之死
正文独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋以下内容为张勋视角年9月15日...
茶点故事阅读 36,919评论 2赞 328
白月光启示录
正文我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
茶点故事阅读 39,090评论 1赞 342
活死人
序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
沈念sama阅读 34,767评论 4赞 337
日本核电站爆炸内幕
正文年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
茶点故事阅读 40,410评论 3赞 322
男人毒药：我在死后第九天来索命
文/蒙蒙一、第九天我趴在偏房一处隐蔽的房顶上张望。院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
开封第一讲书人阅读 31,090评论 0赞 21
一桩弑父案，背后竟有这般阴谋
文/苍兰香墨我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。一阵脚步声响...
开封第一讲书人阅读 32,328评论 1赞 267
情欲美人皮
我被黑心中介骗来泰国打工，没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。一个月前我还...
沈念sama阅读 46,952评论 2赞 365
代替公主和亲
正文我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
茶点故事阅读 43,979评论 2赞 351

DRF Django restframe work 十大组件

认证

自定义认证类

局部使用认证类

权限

自定义权限

局部使用

全局使用权限认证

节流

自定义节流类

局部使用

全局设置

使用DRF内置的限频类

推荐使用这种

全局设置

版本控制

解析器

序列化

第二种继承自serializers.ModelSerializer

分页

使用分页

视图

路由

渲染器

推荐阅读更多精彩内容