DRF十大组件

作者: 时光清浅_许你心安_ | 来源:发表于2019-08-03 15:49 被阅读0次

认证

作用，检测用户是否登录
在视图类中配置 authentication_classes = [] 这是一个列表
需要实现 authenticate() 方法

自定义认证类

 #自定义认证类（继承自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',
    }

权限

作用：某些接口只能是特定的用户才能访问
在视图类中配置permission_classes = [] 这是一个列表
需要实现 has_permission() 方法，表示全部对象对资源的权限问题
还有一个 has_object_permission() 表示某个对象是否对资源有权限
返回 True 或 False，True 表示有权限，False 表示无
全局配置 DEFAULT_PERMISSION_CLASSES，认证类中属性 message，表示无权限时返回的内容
权限自定义类最好继承 BasePermission

自定义权限类

#自定义权限类（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地址用户的唯一标示限制用户的访问频率
在视图类中配置 throttle_classes= [] 这是一个列表
实现 allow_request 方法 wait 是一个提示方法
返回 True/False。True 可以继续访问，False 表示限制
全局配置 DEFAULT_THROTTLE_CLASSE，DEFAULT_THROTTLE_RATES 表示频率限制，比如 10/m 表示每分钟 10 次

自定义（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
        
            while visit_history and visit_history[-1] < currenttime - 60:
                visit_history.pop()

        if len(visit_history) < 10:
            #每分钟访问10次
            visit_history.insert(0,currenttime)
            return True
                
        return False  # False表示访问频率太高被限制
        
        def wait(self):
            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':'10/m',
            },
            'DEFAULT_THROTTLE_CLASSES':['util.throttle.MySimpleRateThrottle',],
        }

版本

作用:判断用户请求的Api是否有效（公司版本迭代时做兼容）
在视图类中配置 versioning_class =注意这是单数形式，只能配置一个类
实现 determine_version 方法
全局配置 DEFAULT_VERSION ALLOWED_VERSIONS VERSION_PARAM

自定义版本类

自定义（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',
    }

解析器

全局 DEFAULT_PARSER_CLASSES= ['rest_framework.parsers.JSONParser', 'rest_framework.parsers.FormParser']
视图配置 parser_classes = []
使用 request.data 或 request.FILE

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)

序列化

序列化不仅可以序列化数据库中的数据，也可以验证提交字段
提交的字段放在 request.validated_data中，这是一个字典，Django form是 request.cleaned_data。
自定义验证规则，钩子函数：
def validate_field() 字段名
django clean_field()

第一种方式（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(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"]


    #对请求的数据进行验证（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.baidu.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.baidu.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视图，路由和请求反射对应的方法就会发生变化

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)

终极视图的使用

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

路由

#自动路由配置
"""
     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']

渲染器

 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',
    )

DRF十大组件

认证

自定义认证类

局部配置

全局配置

权限

自定义权限类

局部设置

全局设置

节流

自定义（Object）

自定义（SimpleRateThrottle）

局部设置

全局设置

版本

自定义版本类

全局设置

解析器

序列化

分页

第一种继承自PageNumberPagination

第二种分页方式LimitOffsetPagination

第三种分页方式CursorPagination（加密的方式）

视图

视图中的局部使用

GenericAPIView视图的使用（其实它继承自APIView，只是在APIView的基础上添加了属性和方法,可以提供给我们调用）

GenericViewSet视图，路由和请求反射对应的方法就会发生变化

终极视图的使用

路由

渲染器

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读