内置认证权限频率类、django配置文件说明、django-filter过滤类、全局异常处理，接口文档使用

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

内置认证类

  • BasicAuthentication
  • RemoteUserAuthentication
  • SessionAuthentication
session认证，建议自己写
如果前端带着cookie过来，领过session的中间件，如果登录了，在request.user中就有当前登录用户

drf没有限制是否登录,加了这个认证，如果没有登录，就不允许往后访问了
  • TokenAuthentication:jw认证，建议自己写

以上内置的认证类，可以继承于它们，然后基于此进行扩展。

内置权限类

BasePermission：所有的权限类的基类

  • AllowAny：允许所有
  • IsAuthenticated：是否登录，登录了才有权限
  • IsAdminUser：auth的user表中is_staff字段是否为True，对后台管理有没有权限

内置频率类

BaseThrottle：所有的基类

AnonRateThrottle：如果你想按ip地址限制，只需要再配置文件中配置

   REST_FRAMEWORK = {
    'DEFAULT_THROTTLE_CLASSES': (
        'rest_framework.throttling.AnonRateThrottle',
    ),
    'DEFAULT_THROTTLE_RATES': {
        'anon': '3/m',
    }
}
# 使用 `second`, `minute`, `hour` 或`day`来指明周期。
# 可以全局使用，局部使用

UserRateThrolle：如果你想按用户id限制，只需要再配置文件中配置

REST_FRAMEWORK = {
    'DEFAULT_THROTTLE_CLASSES': (
        'rest_framework.throttling.UserRateThrottle'
    ),
    'DEFAULT_THROTTLE_RATES': {
        'user': '10/m'
    }
}
# 可以全局使用，局部使用

总结

  • AnonRateThrottle：限制所有匿名未认证用户，使用IP区分用户
  • UserRateThrottle：限制认证用户，使用user id来区分
  • ScopedRateThrottle：限制用户对于每个视图的访问频次，使用ip或者user id

补充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$@-'

# 如果是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的认证相关

# 国际化
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'

过滤类的其他使用

使用内置的过滤类，只能通过?search=搜索条件,这种搜索，不能指定name=xxx&publish=xxxx

第三方插件：django-filter

使用步骤

  • 下载：pip3.8 install django-filter
  • 导入该模块：from django_filters.rest_framework import DjangoFilterBackend
  • 配置在视图类中:filter_backends=[DjangoFilter,]，filterset_fields=['name','publish']
  • 支持的搜索方式：精准搜索，条件是并且的关系

注意

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

补充

面试官问：你在工作中遇到的问题及如何解决的

我在写xx接口的时候，因为过滤条件很多，搜索数据库很慢，写了很多搜索类，之前搜索类的排序是随意的，搜索效率比较低。后来，读了drf搜索类的源码，发现执行顺序是从左到右，我就想到了，最左侧的搜索类，尽量搜索速度快，并且过滤掉数据多，后续再搜索就会更快，所以我调整了一下搜索类的配置顺序，发现该接口的效率有所提升。

使用django-filter进行模糊匹配

使用步骤

  • 注册
INSTALLED_APPS = [
    'django_filters'
]

REST_FRAMEWORK = {
  # 过滤器默认后端
    'DEFAULT_FILTER_BACKENDS': (
        'django_filters.rest_framework.DjangoFilterBackend',),
}
  • 重写一个类继承rest_framework.FilterSet
class LikeFilter(rest_framework.FilterSet):
    """
    title过滤:模糊查询
    """
    # title = rest_framework.CharFilter(field_name='title', lookup_expr='icontains')
    class Meta:
        model=Book
        fields= {'title':['icontains'],
                 'author':['icontains']
                 }
        # fields=['title','author']  精准匹配
  • 配置在视图类中
class BookView(ViewSetMixin,ListAPIView):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    filter_class=LikeFilter  # 配置过滤类
  • 使用

因为用了__icontains查询，输入地址时也需要携带查询条件

eg : http://127.0.0.1:8000/books/?title__icontains=西

![image](https://img2022.cnblogs.com/blog/2897688/202210/2897688-20221011201132848-201856960
gif)

全局异常处理

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

我们可以自己写一个函数，配置在配置文件中，以后出了异常，就走自定义的异常处理函数了,可以在函数中扩展如下功能:

  • 统一返回格式：{'code':'msg':'错误信息'}
  • 记录日志等

代码演示

from rest_framework.response import Response
from rest_framework.views import exception_handler
from datetime import datetime
from django.utils.translation import gettext_lazy as _
def new_exception_handler(exc, context):
    response=exception_handler(exc,context)
    request = context.get('request')
    try:
        username=request.user.username
    except:
        username='AnonymousUser'
    if response:
        return Response(
            {
                'code':888,
                'msg':f'drf的异常，异常错误为:{_(response.data.get("detail"))}',
                '请求路径为':request.path_info,
                '用户':username,
                '访问时间':datetime.now().strftime('%Y-%m-%d %X')
            }
        )
    else:
        return Response({
            'code':999,
            'msg':f'django的异常，异常错误为:{_(str(exc))}',
            '请求路径为':request.path_info,
            '用户': username,
            '访问时间': datetime.now().strftime('%Y-%m-%d %X')
        })

接口文档

当接口文档已经写完，需要编写接口文档，给前端的人使用

接口文档的主要内容

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

在公司里的写法

  1. 直接使用word或者md写
  2. 使用接口文档平台，在接口文档平台录入(Yapi (百度开源的自己搭建) ，第三方平台(收费)，自己开发接口文档平台)
-https://www.showdoc.com.cn/item/index
    - 不想花钱，没有能力开发，就使用开源的YAPI，https://zhuanlan.zhihu.com/p/366025001
    - https://www.liuqingzheng.top:3000/
    	输入邮箱：306334678@qq.com
		输入密码：admin
  1. 项目自动生成：swagger，coreapi
1. 下载：pip3.8 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',
          }

注意：
    直接在视图类中写注释
    在序列化类上写help_text
    
 eg:   class BookListView(generics.ListAPIView):
      """
      返回所有图书信息.
      """

文档描述说明的定义位置

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

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

    retrieve:
    返回图书详情数据

    latest:
    返回最新的图书数据

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

注意

restframework版本在3.10以上的需要指定默认schema.

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

自定义过滤类实现模糊匹配

class BooksView(APIView):
    def get(self,request):
        book_query = Book.objects.all()
        page_obj = PagePaginate(request.query_params,book_query)
        queryset=page_obj.filter_queryset()
        ser = BookSerializer(instance=MyFilter().filter_query(request,queryset), many=True)
        return Response(page_obj.show_result(ser))
class PagePaginate:
   pass # 上个博客     
class MyFilter:
    def filter_query(self,request,queryset):
        title=request.query_params.get('title',None)
        author=request.query_params.get('author',None)
        if title:
            queryset=queryset.filter(title__icontains=title)
        if author:
            queryset=queryset.filter(author__icontains=author)
        return queryset
posted @ 2022-10-11 21:03  荀飞  阅读(105)  评论(0)  编辑  收藏  举报