2. DRF 认证、权限、限流、分页、过滤、序列 化

2.1 user/urls.py

 

　　ModelViewSet注册路由三部曲

　　

　　from django.urls import include, path

　　from user import views

　　from rest_framework.routers import SimpleRouter, DefaultRouter

 

　　# 自动生成路由方法, 必须使用视图集

　　# router = SimpleRouter() # 没有根路由 /user/ 无法识别

　　router = DefaultRouter() # 1.有根路由

　　router.register(r'user', views.UserViewSet) # 2.配置路由

 

　　urlpatterns = [

　　　　path('index/', views.index),

　　　　path('api-auth/', include('rest_framework.urls', namespace='rest_framework'))

　　# 认证地址

　　]

 

　　urlpatterns += router.urls # 3.模块地址

 

2.2 创建 user/serializers.py 写序列化器

 

功能一：数据校验， 创建/修改数据

　　在创建数据或者修改数据时校验用户提交的数据是否合法

　　用户名必须是8位以上，邮箱、手机号是合法的

功能二：序列化

　　把通过model查询的queryset对象转换成JSON格式

 

from rest_framework import serializers

from user.models import User

 

def address_validate(data):

　　print(data)

　　# data：是用户提交的地址这个字段的数据（河南省 郑州市）

　　# 独立校验器

　　# raise serializers.ValidationError('请填写实际地址') # 有错就抛出异常

　　# 没错就返回数据

　　return data

 

class UserSerializer(serializers.ModelSerializer):

　　# 1.独立校验器：重新设定字段, 替换掉模型中的设定, 重新设定地址的长度为5

　　# address_validate是自定义的数据校验函数

　　address = serializers.CharField(max_length=255, min_length=5, validators=

　　[address_validate])

 

　　# 2.单一字段验证（validate_字段名）, 验证地址

　　def validate_address(self, data):

　　　　if data == '测试':

　　　　　　raise serializers.ValidationError('请填写实际地址') # 有错就抛出异常

　　　　return data # 没错就返回结果

 

　　def validate_phone(self, data):

　　# 不符合手机号格式

　　# raise serializers.ValidationError('手机号格式不正确')

　　model = self.root.Meta.model

　　num = model.objects.filter(phone=data).count()

　　if num > 0:

　　　　raise serializers.ValidationError('手机号已存在')

　　return data

 

　　# 3.所有属性验证器

　　def validate(self, attrs):

　　　　# attrs：{"username":"zhangsan", "phone":"18538752511", ....}

　　　　# 所有属性验证器

　　　　# self.context 中有request和view上下文

　　　　# self.context['view'].action 可以取到动作

　　　　# attrs 是需要序列化的数据

　　　　# raise serializers.ValidationError('xxx错误') # 有问题报错

　　　　return attrs # 没问题返回数据

 

class Meta:

　　model = User

　　# fields = ('id', ) # 临时添加字段也需要写在这里

　　fields = '__all__' # 所有字段

　　# exclude = ['id'] # 排除 id 字段

　　read_only_fields = ('',) # 指定字段为 read_only,

　　# 扩展address： extra_kwargs = {} # 局部替换某些字段的设定, 或者新增设定

　　extra_kwargs = {

　　　　"address": {

　　　　"min_length": 5, # 给地址增加 最小长度限制

　　　　　　"default": '默认测试地址', # 增加默认值

　　}

}

 

class UserUnActiveSerializer(serializers.ModelSerializer):

　　class Meta:

　　　　model = User

　　　　fields = ('id', 'username', 'is_active') # 临时添加字段也需要写在这里

　　　　# fields = '__all__' # 所有字段

 

2.3 user/views.py

 

from django.http import HttpResponse

from django_filters.rest_framework import DjangoFilterBackend

from rest_framework import viewsets

from rest_framework.authentication import BasicAuthentication,

SessionAuthentication

from rest_framework.decorators import action

from rest_framework.filters import OrderingFilter

from rest_framework.permissions import AllowAny, IsAdminUser, IsAuthenticated,

IsAuthenticatedOrReadOnly

from rest_framework.response import Response

from rest_framework.throttling import UserRateThrottle

from rest_framework.pagination import PageNumberPagination

from rest_framework.views import APIView

from rest_framework.permissions import BasePermission, SAFE_METHODS

from user.models import User

from user.serializers import UserSerializer, UserUnActiveSerializer

 

def index(request):

　　# 需要认证才能访问的视图

　　return HttpResponse('hello')

 

　

# 分页（局部）：自定义分页器 局部

class PageNum(PageNumberPagination):

　　# 查询字符串中代表每页返回数据数量的参数名, 默认值: None

　　page_size_query_param = 'page_size'

　　# 查询字符串中代表页码的参数名, 有默认值: page

　　# page_query_param = 'page'

　　# 一页中最多的结果条数

　　max_page_size = 2

 

# 自定义权限（局部）

class MyPermission(BasePermission):

　　# has_permission 是用户对这个视图有没有 GET POST PUT PATCH DELETE 权限的分别判断

　　def has_permission(self, request, view):

　　print('has_perm')

　　# print(view.kwargs.get("pk"), request.user.id)

　　"""判断用户对模型有没有访问权"""

　　# 任何用户对使用此权限类的视图都有访问权限

　　if request.user.is_superuser:

　　# 管理员对用户模型有访问权

　　　　return True

　　elif view.kwargs.get('pk') == str(request.user.id):

　　# 携带的id和用户的id相同时有访问权

　　　　return True

　　return False

 

# has_object_permission 是用户过了 has_permission 判断有权限以后，再判断这个用户有没有对一个具体的对象有没有操作权限

 

# 这样设置以后，即使是django admin管理员也只能查询自己user标的信息，不能查询其他用户的单条信息

def has_object_permission(self, request, view, obj):

　　print('has_object_perm')"""获取单个数据时,判断用户对某个数据对象是否有访问权限"""

　　if request.user.id == obj.id:

　　　　return True

　　return False

 

class UserViewSet(viewsets.ModelViewSet):

　　"""

　　完成产品的增删改查

　　"""

　　queryset = User.objects.all()

　　serializer_class = UserSerializer # 优先使用 get_serializer_class 返回的序列化器

　　# # 1.认证：自定义认证类, 自定义会覆盖全局配置

　　# authentication_classes = (BasicAuthentication, SessionAuthentication)

　　# # 2.权限：自定义权限类

　　# permission_classes = (MyPermission,)

 

　　# 3.分页：自定义分页器 覆盖全局配置

　　pagination_class = PageNum

 

　　# 4.限流：自定义限流类

　　throttle_classes = [UserRateThrottle]

 

　　# 5.过滤：指定过滤方法类, 排序方法类, 一个或多个

　　filter_backends = (DjangoFilterBackend, OrderingFilter) # 同时支持过滤和排序

　　# 5.1指定排序字段, 不设置, 排序功能不起效

　　ordering_fields = ('date_joined', 'id') # ?ordering=-id

　　# 5.2指定过滤字段, 不设置, 过滤功能不起效

　　filter_fields = ('username', 'phone', 'is_active')

　　# ?username=tom&phone=&is_active=true

 

　　

　　# 根据不同的请求, 获得不同的序列化器

　　def get_serializer_class(self):

　　　　if self.action == 'unactived':

　　　　　　return UserUnActiveSerializer

　　　　else:

　　　　　　return UserSerializer

 

　　

　　@action(methods=['get'], detail=False)

　　def unactived(self, request, *args, **kwargs):

　　　　# 获取查询集, 过滤出未激活的用户

　　　　qs = self.queryset.filter(is_active=False)

　　　　# 使用序列化器, 序列化查询集, 并且是

　　　　ser = self.get_serializer(qs, many=True)

　　　　return Response(ser.data)

 

　　@action(methods=['get'], detail=False)

　　def actived(self, request, *args, **kwargs):

　　　　# 获取查询集, 过滤出未激活的用户

　　　　qs = self.queryset.filter(is_active=True)

　　　　# 使用序列化器, 序列化查询集, 并且是

　　　　ser = self.get_serializer(qs, many=True)

　　　　return Response(ser.data)