【Django-rest-framework框架】 第09回 内置类，过滤类的其他使用，全局异常处理，接口文档

目录

• 1. 内置认证类，权限类，频率类
  • 1.1 内置的认证类：
  • 1.2 内置权限类
  • 1.3 内置的频率类
• 2. django的配置文件每个配置项的作用
• 3. 过滤类的其它使用
  • 3.1 django-filter
    • 3.1.1 继承精准搜索
    • 3.1.2 模糊搜索
  • 3.2 自定义过滤类
  • 3.3 特点
• 4. 全局异常处理
• 5. 接口文档
• 作业
  • 1. 自定义一个过滤类，实现可以通过图书名或作者模糊匹配
  • 2. 编写一个全局异常处理，让它生效
  • 3. 使用django-filter实现模糊匹配

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

1.1 内置的认证类：

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

1.2 内置权限类

BasePermission：所有的基类
AllowAny：允许所有
IsAuthenticated：是否登录，登录了才有权限
    认证类，如果登录了，返回(当前登录用户,None), 如果没有登录返回 None
IsAdminUser：auth的user表中is_staff字段是否为True，对后台管理有没有权限

1.3 内置的频率类

BaseThrottle：所有的基类
SimpleRateThrottle：咱们写频率类都继承它，少写代码
AnonRateThrottle：如果你想按ip地址限制，只需要在配置文件中配置
'DEFAULT_THROTTLE_RATES': {
        'anon': '3/m',
    	}
UserRateThrottle:如果你想按用户id限制，只需要在配置文件中配置
'DEFAULT_THROTTLE_RATES': {
        'user': '3/m',
    	}

2. django的配置文件每个配置项的作用

"""
Django settings for drf_day09 project.

Generated by 'django-admin startproject' using Django 3.2.12.

For more information on this file, see
https://docs.djangoproject.com/en/3.2/topics/settings/

For the full list of settings and their values, see
https://docs.djangoproject.com/en/3.2/ref/settings/
"""
# 必须大写才是配置项
# django项目要启动，要先加载配置文件，如果配置文件报错，项目运行不起来

from pathlib import Path

# Build paths inside the project like this: BASE_DIR / 'subdir'.
# 项目根路径
BASE_DIR = Path(__file__).resolve().parent.parent


# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/3.2/howto/deployment/checklist/

# SECURITY WARNING: keep the secret key used in production secret!
# 密钥，自动生成的，很复杂，django中涉及到加密的都使用他，没有不行
SECRET_KEY = 'django-insecure-z9iztljz_h3p=o=d$lah0200qiw%s=25hv91$wz3a-r_50u8o!'

# SECURITY WARNING: don't run with debug turned on in production!
# 如果是True,项目是调试模式，好处是抛异常在浏览器直接能看到，如果路径不存在，也会提示有那些路径
DEBUG = True
# 允许项目部署的地址（后期项目上线，这里写服务器的地址），DEBUG是False,这个必须加，不加就报错
ALLOWED_HOSTS = ['*']


# Application definition
# 所有的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_day09.urls'
# 模板相关
TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [BASE_DIR / 'templates']
        ,
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]

# 后期项目项目上线，uwsgi运行这个application,测试阶段使用manage.py 运行项目
WSGI_APPLICATION = 'drf_day09.wsgi.application'


# Database
# https://docs.djangoproject.com/en/3.2/ref/settings/#databases

# 数据库配置 【可以使用多数据库】
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': BASE_DIR / 'db.sqlite3',
    }
}


# Password validation
# https://docs.djangoproject.com/en/3.2/ref/settings/#auth-password-validators
# 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',
    },
]


# Internationalization
# https://docs.djangoproject.com/en/3.2/topics/i18n/
# 国际化
LANGUAGE_CODE = 'zh-hans'

TIME_ZONE = 'UTC'

USE_I18N = True

USE_L10N = True

USE_TZ = True


# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/3.2/howto/static-files/
# 静态文件相关
STATIC_URL = '/static/'

# Default primary key field type
# https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field
# 所有的自增主键都用BigAutoField
DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

3. 过滤类的其它使用

3.1 django-filter

内置的过滤类 只能通过?search=搜索条件，这种搜索，不能指定 name=三国&publish=出版社

第三方：django-filter
    1. pip3 install django-filter
    2. 配置在视图类中配置：filter_backends = [DjangoFilterBackend,]
    3. 配置搜索的字段：filterset_fields = ['name','publish']
    4. 支持的搜索方式：http://127.0.0.1:8000/books/?name=三国演义&publish=南京出版社（精准搜索，条件是并且的关系）

3.1.1 继承精准搜索

from .models import Book

from .serializer import BookSerializer
from rest_framework.generics import ListAPIView
from rest_framework.mixins import CreateModelMixin
from rest_framework.viewsets import ViewSetMixin
from rest_framework.response import Response
from .pagination import OutPageNumberPagination, OutCursorPagination, OutLimitOffsetPagination

from rest_framework.filters import OrderingFilter, SearchFilter

from django_filters.rest_framework import DjangoFilterBackend


class BookView(ViewSetMixin, ListAPIView, CreateModelMixin):
    pagination_class = OutPageNumberPagination
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    # 指定过滤类。第三方的过滤类：django_filter
    filter_backends = [DjangoFilterBackend, ]
    # 指定过滤字段：准确匹配， /books/?name=三国&publish=北京出版社  两个条件是and，并且是精确查找
    filterset_fields = ['name', 'publish']

3.1.2 模糊搜索

import django_filters


class BookFilter(django_filters.FilterSet):
    name = django_filters.CharFilter(lookup_expr='icontains')
    publish = django_filters.CharFilter(lookup_expr='icontains')

    class Meta:
        model = Book
        fields = ['name', 'publish']

3.2 自定义过滤类

from rest_framework.filters import BaseFilterBackend


class OutFilter(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.3 特点

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

面试官问你，你在工作中遇到的问题及如何解决的？
    我在写XX接口的时候，因为我们过滤条件很多，搜索数据库很慢，写了很多搜索类，之前时候搜索类的排序是随意的，搜索效率比较低，后来，读；drf搜索类的源码，发现执行顺序是从左往右，我就想到了，最左侧的搜索类，尽量搜索速度快，并且过滤掉的数据多，再搜索就会更快，所以我调整了一下搜索类的配置顺序，发现该接口的效率有所提升

4. 全局异常处理

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

自己写一个函数，配置在配置文件中，以后出了异常，它就走咱们写的函数
    1. 统一返回格式{'code':101,'msg':错误信息}
    2. 记录日志

exctptions.py

import time

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


def common_exception_handler(exc, context):
    # 记录日志：只要进入到这里面，一定是出了异常，只要出异常就要记录日志
    request = context.get('request')  # 当此请求的request
    try:
        username = request.user.username
    except:
        username = '没有登录'
    ctime = time.time()
    path = request.path
    method_type = request.method
    print('%s用户，在%s时间，访问%s接口，通过%s请求访问，出个错误：%s' % (username, str(ctime), path, method_type, str(exc)))
    # 后期以上的代码要写到日志中
    response = exception_handler(exc, context)  # 内置的这个异常处理函数，只处理了drf自己的异常（继承了APIException的异常）
    if response:  # 如果response有值，说明错误被处理了（Http404,PermissionDenied,APIException）
        return Response({'code': 222, 'msg': 'drf错误，错误原因是:%s' % response.data.get('detail', '未知错误')})
    else:
        # 如果是None，这个错误没有被处理，说明这个错误不是drf的错误，而是django的或代码的错误
        return Response({'code': 999, 'msg': '系统错误，错误原因是：%s' % str(exc)})

views.py

# 写个视图类，测试异常
from .auth import MyAuth


class PublishView(APIView):
    authentication_classes = [MyAuth, ]

    def get(self, request):
        a = [1, 2, 3]
        print(a[9])
        # 直接抛异常
        # raise Exception('崩了')
        return Response('ok')

auth.py

from rest_framework.authentication import BaseAuthentication
from rest_framework.exceptions import AuthenticationFailed


class MyAuth(BaseAuthentication):
    def authenticate(self, request):
        raise AuthenticationFailed('您没有登录')

5. 接口文档

1. 接口编写已经写完了,需要编写接口文档，给前端的人使用
    请求地址
    请求方式
    支持的编码格式
    请求参数(get,post参数)
    返回格式示例
2. 在公司里的写法
    1. 直接使用word或者md写
    2. 使用接口文档平台，在接口文档平台录入(Yapi(百度开源的自己搭建)，第三方平台(收费)，自己开发接口文档平台)
       https://www.showdoc.com.cn/item/index
       不想花钱，没有能力开发，就使用开源的YAPI，https://zhuanlan.zhihu.com/p/366025001
       http://www.liuqingzheng.top:3000
          输入邮箱：306334678@qq.com
	  输入密码：admin

3. 项目自动生成：swagger,coreapi
   1. 下载：pip3 install coreapi
   2. 路由中配置：
      from rest_framework.documentation import include_docs_urls
      urlpatterns = [
            path('docs/', include_docs_urls(title='站点页面标题'))
        ]
   3. 在视图类中加注释
   4. 在配置文件中配置
      REST_FRAMEWORK = {
         'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
        }

文档描述说明的定义位置
1.单一方法的视图，可以直接使用类视图的文档字符串
class BookListView(generics.ListAPIView):
    """
    返回所有图书信息.
    """
2.包含多个方法的视图，在类视图的文档字符串中，分开方法定义
class BookListCreateView(generics.ListCreateAPIView):
    """
    get:
    返回所有图书信息.

    post:
    新建图书.
    """
3.对于视图集ViewSet，仍在类视图的文档字符串中封开定义，但是应使用action名称区分
class BookInfoViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet):
    """
    list:
    返回图书列表数据

    retrieve:
    返回图书详情数据

    latest:
    返回最新的图书数据

    read:
    修改图书的阅读量
    """

作业

1. 自定义一个过滤类，实现可以通过图书名或作者模糊匹配

from rest_framework.filters import BaseFilterBackend


class OutFilter(BaseFilterBackend):
    def filter_queryset(self, request, queryset, view):
        name = request.query_params.get('name', None)
        publish = request.query_params.get('publish', None)
        if name and publish:
            qs = queryset.filter(name__icontains=name, publish__icontains=publish)
            return qs
        elif name:
            qs = queryset.filter(name__icontains=name)
            return qs
        elif publish:
            qs = queryset.filter(publish__icontains=publish)
            return qs
        else:
            return queryset

2. 编写一个全局异常处理，让它生效

import time

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


def common_exception_handler(exc, context):
    request = context.get('request')  
    try:
        username = request.user.username
    except:
        username = '没有登录'
    ctime = time.time()
    path = request.path
    method_type = request.method
    print('%s用户，在%s时间，访问%s接口，通过%s请求访问，出个错误：%s' % (username, str(ctime), path, method_type, str(exc)))
    response = exception_handler(exc, context) 
    if response: 
        return Response({'code': 222, 'msg': 'drf错误，错误原因是:%s' % response.data.get('detail', '未知错误')})
    else:
        return Response({'code': 999, 'msg': '系统错误，错误原因是：%s' % str(exc)})

3. 使用django-filter实现模糊匹配

import django_filters

class BookFilter(django_filters.FilterSet):
    name = django_filters.CharFilter(lookup_expr='icontains')
    publish = django_filters.CharFilter(lookup_expr='icontains')

    class Meta:
        model = Book
        fields = ['name', 'publish']

class BookView(ViewSetMixin, ListAPIView, CreateModelMixin):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    filter_backends = [DjangoFilterBackend, ]
    filterset_class = BookFilter