7.9.10DRF高级功能

7.9.10DRF高级功能

（1）认证Authentication

1）说明

识别登录用户是谁

2）配置

可以在配置文件中配置全局默认的认证方案

REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': ( 

    'rest_framework.authentication.BasicAuthentication', # 基本认证

    'rest_framework.authentication.SessionAuthentication', # session认证 ) 

}

也可以在每个视图中通过设置authentication_classess属性来设置

from rest_framework.authentication import SessionAuthentication, BasicAuthentication 

from rest_framework.views import APIView 

class ExampleView(APIView): 

    authentication_classes = (SessionAuthentication, BasicAuthentication)

    ...

3）补充

认证失败会有两种可能的返回值：

• 401 Unauthorized 未认证
• 403 Permission Denied 权限被禁止

（2）权限Permissions

1）说明

①权限控制可以限制用户对于视图的访问和对于具体数据对象的访问。

• 在执行视图的dispatch()方法前，会先进行视图访问权限的判断
• 在通过get_object()获取具体对象时，会进行对象访问权限的判断

②限制用户的权限

提供的权限

• AllowAny 允许所有用户
• IsAuthenticated 仅通过认证的用户
• IsAdminUser 仅管理员用户
• IsAuthenticatedOrReadOnly 认证的用户可以完全操作，否则只能get读取

2）视图访问权限

①全局权限

REST_FRAMEWORK = {

   'DEFAULT_PERMISSION_CLASSES': ( 'rest_framework.permissions.IsAuthenticated', )

}

②局部权限

class BookInfoViewSet(mixins.ListModelMixin,mixins.RetrieveModelMixin,GenericViewSet):

    """使用视图集实现返回列表数据和单一数据"""

    queryset = BookInfo.objects.all()

    serializer_class = BookInfoSerializer



    #权限认证：只有登录哟用户才能访问

    permission_classes = [IsAuthenticated]

    pass

3）自定义权限

①说明

如需自定义权限，需继承rest_framework.permissions.BasePermission父类，并实现以下两个任何一个方法或全部

• .has_permission(self, request, view)

是否可以访问视图， view表示当前视图对象

• .has_object_permission(self, request, view, obj)

是否可以访问数据对象， view表示当前视图， obj为数据对象

②实现

class MyPermission(BasePermission):
    def has_object_permission(self, request, view, obj):
        """控制对obj对象的访问权限，此案例决绝所有对对象的访问"""
        return False

class BookInfoViewSet(ModelViewSet):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer
    permission_classes = [IsAuthenticated, MyPermission]

（3）限流Throttling

1）说明

可以对接口访问的频次进行限制，以减轻服务器压力

2）配置

①可以在配置文件中

使用DEFAULT_THROTTLE_CLASSES 和 DEFAULT_THROTTLE_RATES进行全局配置

DEFAULT_THROTTLE_RATES 可以使用 second, minute, hour 或day来指明周期。

REST_FRAMEWORK = {
    'DEFAULT_THROTTLE_CLASSES': (
        'rest_framework.throttling.AnonRateThrottle',
        'rest_framework.throttling.UserRateThrottle'
    ),
    'DEFAULT_THROTTLE_RATES': {
        'anon': '100/day',
        'user': '1000/day'
    }
}

②也可以在具体视图中通过throttle_classess属性来配置，如：

from rest_framework.throttling import UserRateThrottle
from rest_framework.views import APIView

class ExampleView(APIView):
    throttle_classes = (UserRateThrottle,)

3）可选限流类

① AnonRateThrottle

限制所有匿名未认证用户，使用IP区分用户。

使用DEFAULT_THROTTLE_RATES['anon'] 来设置频次

②UserRateThrottle

限制认证用户，使用User id 来区分。

使用DEFAULT_THROTTLE_RATES['user'] 来设置频次

③ScopedRateThrottle

限制用户对于每个视图的访问频次，使用ip或user id。

（4）过滤Filtering

1）安装过滤模块

pip install django-filter

2）注册应用

INSTALLED_APPS = [ ... 'django_filters', # 需要注册应用， ]

3）配置过滤后端

REST_FRAMEWORK = { 
    'DEFAULT_FILTER_BACKENDS': ('django_filters.rest_framework.DjangoFilterBackend',) 
}

4）视图中添加过滤字段

filter_fields = ('btitle', 'bread')

5）测试

http://127.0.0.1:8000/books/?btitle=西游记

http://127.0.0.1:8000/books/?bread=10

（5）排序OrderingFilte

对于列表数据，REST framework提供了OrderingFilter过滤器来帮助我们快速指明数据按照指定字段进行排序。

在类视图中设置filter_backends，使用rest_framework.filters.OrderingFilter过滤器，REST framework会在请求的查询字符串参数中检查是否包含了ordering参数，如果包含了ordering参数，则按照ordering参数指明的排序字段对数据集进行排序。

前端可以传递的ordering参数的可选字段值需要在ordering_fields中指明。

如：

class BookListView(ListAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer
    filter_backends = [OrderingFilter]
    ordering_fields = ('id', 'bread', 'bpub_date')

测试：127.0.0.1:8000/books/?ordering=bread # 正序

           127.0.0.1:8000/books/?ordering=-bread # 倒序

（6）分页Pagination

1）可以在配置文件中设置全局的分页方式，如：

REST_FRAMEWORK = {
   'DEFAULT_PAGINATION_CLASS':'rest_framework.pagination.PageNumberPagination',
    'PAGE_SIZE': 100  # 每页数目
}

2）也可通过自定义Pagination类，来为视图添加不同分页行为。在视图中通过pagination_clas属性来指明。

class LargeResultsSetPagination(PageNumberPagination):
    page_size = 1000
    page_size_query_param = 'page_size'
    max_page_size = 10000

class BookDetailView(RetrieveAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer
    pagination_class = LargeResultsSetPagination

注意：如果在视图内关闭分页功能，只需在视图内设置

pagination_class = None

3）可选分页器

①PageNumberPagination

前端访问网址形式：

GET http://api.example.org/books/?page=4

可以在子类中定义的属性：

• page_size 每页数目
• page_query_param 前端发送的页数关键字名，默认为"page"
• page_size_query_param 前端发送的每页数目关键字名，默认为None
• max_page_size 前端最多能设置的每页数量

②LimitOffsetPagination

前端访问网址形式：

GET http://api.example.org/books/?limit=100&offset=400

可以在子类中定义的属性：

• default_limit 默认限制，默认值与PAGE_SIZE设置一致
• limit_query_param limit参数名，默认'limit'
• offset_query_param offset参数名，默认'offset'
• max_limit 最大limit限制，默认None

（7）版本Versioning

在需要获取请求的版本号时，可以通过request.version来获取。

默认版本功能未开启，request.version 返回None。

开启版本支持功能，需要在配置文件中设置DEFAULT_VERSIONING_CLASS

REST_FRAMEWORK = { 
    'DEFAULT_VERSIONING_CLASS': 'rest_framework.versioning.NamespaceVersioning' 
}

其他可选配置：

• DEFAULT_VERSION 默认版本号，默认值为None
• ALLOWED_VERSIONS 允许请求的版本号，默认值为None
• VERSION_PARAM 识别版本号参数的名称，默认值为'version'

支持的版本处理方式

1） AcceptHeaderVersioning

请求头中传递的Accept携带version

2）URLPathVersioning

URL路径中携带

3）NamespaceVersioning

命名空间中定义

4）HostNameVersioning

主机域名携带

5）QueryParameterVersioning

查询字符串携带

获取版本：request.version = 'xxxx'

（8）异常处理 Exceptions

REST framework提供了异常处理，可以自定义异常处理函数。

from rest_framework.views import exception_handler

	def custom_exception_handler(exc, context):
   	 # 先调用REST framework默认的异常处理方法获得标准错误响应对象
    	response = exception_handler(exc, context)

   	 # 在此处补充自定义的异常处理
    	if response is not None:
       		response.data['status_code'] = response.status_code
   	 return response

在配置文件中声明自定义的异常处理

REST_FRAMEWORK = { 
    'EXCEPTION_HANDLER': 'my_project.my_app.utils.custom_exception_handler' 
}

如果未声明，会采用默认的方式，如下

REST_FRAMEWORK = { 
    'EXCEPTION_HANDLER': 'rest_framework.views.exception_handler' 
}

REST framework定义的异常

• APIException 所有异常的父类
• ParseError 解析错误
• AuthenticationFailed 认证失败
• NotAuthenticated 尚未认证
• PermissionDenied 权限决绝
• NotFound 未找到
• MethodNotAllowed 请求方式不支持
• NotAcceptable 要获取的数据格式不支持
• Throttled 超过限流次数
• ValidationError 校验失败

（9）自动生成接口文档

接口文档以网页的方式呈现。

自动接口文档能生成的是继承自APIView及其子类的视图。

1）安装

pip install coreapi

2）配置接口文档的路由

from rest_framework.documentation import include_docs_urls

url(r'^docs/', include_docs_urls(title='My API title'))

3)访问接口文档网页

浏览器访问 127.0.0.1:8000/docs/，即可看到自动生成的接口文档。