Django-rest-framework框架之drf内置认证，权限，频率类，异常处理与自动生成接口文档

今日内容概要

• 内置认证类，权限类，频率类
• django的配置文件（每个配置项的作用）
• 过滤类的其他作用
• 全局异常处理
• 接口文档

内置认证类，权限类，频率类

1.内置的认证类：

• BasicAuthentication
• RemoteUserAuthentication
• SessionAuthentication：session认证，建议自己写
  

如果前端带着cookie过来，经过session的中间件，如果登录了，在request.user中就有当前登录用户;
drf没有限制是否登录;
加了这个认证，如果没有登录，就不允许往后访问了.

• TokenAuthentication：jwt认证，建议自己写

所有的认证类建议自己写认证类。

2.内置的权限类

• BasePermission：所有的基类
• AllowAny：允许所有
• IsAuthenticated：是否登录，登录了才有权限
  

认证类，如果登录了，返回(当前登录用户,None), 如果没有登录返回 None

• IsAdminUser：auth的user表中is_staff字段是否为True，对后台管理有没有权限
  

3.内置的频率类：

• BaseThrottle：所有的基类
• SimpleRateThrottle：咱们写频率类都继承它，少写代码
• AnonRateThrottle：如果你想按ip地址限制，只需要在配置文件中配置

'DEFAULT_THROTTLE_RATES': {
   'anon': '3/m',
}

• UserRateThrottle:如果你想按用户id限制，只需要在配置文件中配置

'DEFAULT_THROTTLE_RATES': {
   'user': '3/m',
}

django的配置文件（每个配置项的作用）

首先注意：必须大写才是配置项！！！

• django项目要启动，要先加载配置文件，如果配置文件报错，项目运行不起来

from pathlib import Path

• 项目根路径

BASE_DIR = Path(__file__).resolve().parent.parent

• 密钥，自动生成的，很复杂，django中涉及到加密的都使用它，没有不行

SECRET_KEY = 'django-insecure-4i$6azd399fl$vh9%*7#oald(i&ik(5#i_-y)v&z3g+cxsd$@-'

• DEBUG如果是True，项目是调试模式，好处是抛异常在浏览器直接能看到,如果路径不存在，也会提示有哪些路径

DEBUG = True

• 允许项目部署的地址（后期项目上线，这里写服务器的地址），debug是False，这个必须加，不加就报错

ALLOWED_HOSTS = ['*']

• 所有的app，django大而全，就是因为它提供了很多内置的app

INSTALLED_APPS = [
   'django.contrib.admin', # 后台管理admin
   'django.contrib.auth', # 权限，6个表
   'django.contrib.contenttypes',
   'django.contrib.sessions',# session认证相关 ---》django_session表
   'django.contrib.messages', # 消息框架（不了解）
   'django.contrib.staticfiles',# 静态文件
   'app01.apps.App01Config', # app01
   'rest_framework',
]

• 中间件

MIDDLEWARE = [
   'django.middleware.security.SecurityMiddleware',  #
   'django.contrib.sessions.middleware.SessionMiddleware', # session相关
   'django.middleware.common.CommonMiddleware',           #把路径跟路由匹配，如果匹配不成功把路径加/ 再匹配，如果匹配成功，让该请求重定向到带/的地址
   'django.middleware.csrf.CsrfViewMiddleware', # csrf相关
   'django.contrib.auth.middleware.AuthenticationMiddleware', # 认证相关
   'django.contrib.messages.middleware.MessageMiddleware',  # 消息框架，学到flask，闪现相同的功能
   'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

• 根路由，所有请求进来，先去根路由匹配—》内部可能有路由分发

ROOT_URLCONF = 'drf_day08.urls'

• 模板相关

TEMPLATES = [
]

• 后期项目项目上线，uwsgi运行这个application，测试阶段使用manage.py 运行项目

WSGI_APPLICATION = 'drf_day08.wsgi.application'

• 数据库配置 【可以使用多数据库】

DATABASES = {
   'default': {
       'ENGINE': 'django.db.backends.sqlite3',
       'NAME': BASE_DIR / 'db.sqlite3',
   }
}

• auth的认证相关

AUTH_PASSWORD_VALIDATORS = [
   {
       'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
   },
   {
       'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
   },
   {
       'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
   },
   {
       'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
   },
]

• 国际化

LANGUAGE_CODE = 'en-us'
TIME_ZONE = 'UTC'
USE_I18N = True
USE_L10N = True
USE_TZ = True

• 静态文件相关

STATIC_URL = '/static/'

• 所有的自增主键都用BigAutoField

DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

过滤类的其它使用

1.内置的过滤类
只能通过?search=搜索条件进行搜索，这种搜索不能实现“name=三国&publish=出版社”这种情况。

2.第三方模块------django-filter

• 步骤：
  （1）下载模块：pip3 install django-filter
  （2）配置在视图类中配置：filter_backends = [DjangoFilterBackend, ]
  （3）配置搜索的字段：filterset_fields = [‘name’, ‘publish’]
  （4）支持的搜索方式：http://127.0.0.1:8008/books/?name=三国演义&publish=南京出版社

搜索结果为精准搜索，条件是并且的关系，没有做到模糊搜索。

• 代码展示

from django_filters.rest_framework import DjangoFilterBackend

class BookView(ViewSetMixin,ListAPIView,CreateModelMixin):
filter_backends = [DjangoFilterBackend, ]
filterset_fields=['name','publish']
   queryset = Book.objects.all()
   serializer_class = BookSerializer

3.自定义过滤类

• 步骤
  （1）写一个类，继承BaseFilterBackend
  （2）重写某个方法：filter_queryset，在该方法中实现过滤，返回qs对象

from rest_framework.filters import BaseFilterBackend


class Myfilter(BaseFilterBackend):
   def filter_queryset(self, request, queryset, view):
       # 在这里面实现过滤，一定要返回qs对象，过滤后的数据
       name = request.query_params.get('name', None)
       publish = request.query_params.get('publish', None)
       qs = queryset.filter(name__icontains=name, publish__icontains=publish)
       return qs

（3）配置在视图类上

filter_backends = [MyFilter, ]

4.一些功能
多个过滤类和排序类可以共用，filter_backends=[],可以配置多个，执行顺序是从做往右，所以，放在最左侧的尽量先过滤掉大部分数据。

全局异常处理

1.源码分析情况下

• drf中无论在三大认证还是视图类的方法中执行，只要报错(主动抛异常)，都能执行一个函数（异常处理的函数）
• 只要除了异常在APIView的dispatch中捕获了，执行了配置文件中配置的：‘EXCEPTION_HANDLER’: ‘rest_framework.views.exception_handler’

2.提出需求：自己写一个函数，配置在配置文件中，以后出了异常，就走我们写的函数

• 统一返回格式 {‘code’:101,‘msg’:错误信息}
• 记录日志

3.自己写一个函数
exctptions.py文件：

from rest_framework.response import Response
from rest_framework.views import exception_handler

import time


def common_exception_handler(exc, context):
   # 记录日志：出现异常要写入日志
   request = context.get('request')
   try:
       username = request.user.username
   except:
       username = '您还没有登录'
   nowtime = time.time()
   # 接口路径
   path = request.path
   # 请求方式
   method_type = request.method
   print('%s用户，在%s时间，访问%s接口,通过%s请求访问，出了错误：%s' % (username, str(nowtime), path, method_type, str(exc)))
   # 以上代码可以封装到日志中

   response = exception_handler(exc, context)  # 内置的这个异常处理函数，只处理了drf自己的异常（继承了APIException的异常）
   if response:  # 如果response有值，说明错误被处理了（Http404,PermissionDenied,APIException）
       return Response({'code': 888, 'msg': 'drf错误,错误原因是:%s' % response.data.get('detail', '未知错误')})
   else:  # 如果是None，这个错误没有被处理，说明这个错误不是drf的错误，而是django的或者代码的错误
       return Response({'code': 999, 'msg': '系统错误，错误原因是：%s' % str(exc)})

views.py测试文件：

# 全局异常处理
from rest_framework.views import APIView
from rest_framework.response import Response

class PublishView(APIView):
   def get(self, request):
       # a = [1, 2, 3]
       # print(a[9])
       # 直接抛异常
       raise Exception('直接抛异常：报错')
       # return Response('ok')

接口文档

1.接口编号写完后，需要编写接口文档，用于供前端人员使用。

• 请求地址
• 请求方式
• 支持的编码格式
• 请求参数(get,post参数)
• 返回格式示例

2.一般在公司的写法

• 直接使用word或者md写
• 使用接口文档平台，在接口文档平台录入(Yapi（百度开源的自己搭建）,第三方平台(收费)，自己开发接口文档平台)

使用开源的YAPI：
https://www.showdoc.com.cn/item/index

docker-compose部署Yapi：
https://zhuanlan.zhihu.com/p/366025001

访问接口：
https://www.liuqingzheng.top:3000/
输入邮箱：306334678@qq.com
输入密码：admin

• 项目自动生成(使用第三方模块)：swagger，coreapi
  （1）下载：pip3 install coreapi
  （2）路由中配置：

from rest_framework.documentation import include_docs_urls
       urlpatterns = [
           path('docs/', include_docs_urls(title='站点页面标题'))
       ]

• 在视图类中加注释

举个栗子：
   """
   list:
   返回所有图书信息.

   create:
   新建图书.
   """

• 在配置文件中配置

REST_FRAMEWORK = {
  'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
}

• 两点说明：
  （1）视图集ViewSet中的retrieve名称，在接口文档网站中叫做read
  （2）参数的Description需要在模型类或序列化器类的字段中以help_text选项定义，如：

class StudentSerializer(serializers.ModelSerializer):
   class Meta:
       model = Student
       fields = "__all__"
       extra_kwargs = {
           'age': {
               'required': True,
               'help_text': '年龄'
           }
       }