drf之day09:内置的认证类，权限类，频率类，django配置文件解析，过滤类的其他作用，全局异常处理，接口文档

Jayxieming

已于 2022-10-11 22:55:22 修改

阅读量221

点赞数

分类专栏： django 文章标签： django python 后端

于 2022-10-11 21:35:02 首次发布

本文链接：https://blog.csdn.net/Yydsaoligei/article/details/127272212

版权

django 专栏收录该内容

32 篇文章 2 订阅

订阅专栏

目录标题

一：内置的认证类，权限类，频率类

1.内置的认证类

种类

# 1.BasicAuthentication

# 2.RemoteUserAuthentication

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

# 4.TokenAuthentication：jwt认证，建议自己写

2.内置的权限类

# 1.BasePermission：所有的基类

# 2.AllowAny：允许所有

# 3.IsAuthenticated：是否登录，登录了才有权限,认证类，如果登录了，返回(当前登录用户,None), 如果没有登录返回 None

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

3.内置的频率类

# 1.BaseThrottle：所有的基类

# 2.SimpleRateThrottle：咱们写频率类都继承它，少写代码

# 3.AnonRateThrottle：如果你想按ip地址限制，只需要在配置文件中配置
      'DEFAULT_THROTTLE_RATES': {
        'anon': '3/m',
    	}
        
# 4.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$@-'

# 如果是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=水&publish=上海

1第三方：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=南京出版社

2.自己写一个自定义类

1.写一个类，继承：BaseFilterBackend
2.重写filter_queryset方法，在该方法中实现过滤功能，返回过滤之后的数据对象

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, ]

3.多个过滤类和排序类共用

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

四：全局异常处理

1.drf内置的全局异常处理

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

的：‘EXCEPTION_HANDLER’: ‘rest_framework.views.exception_handler’

2.自定义全局异常处理函数

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

# 写一个函数
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': 888, 'msg': 'drf错误,错误原因是:%s' % response.data.get('detail', '未知错误')})
    else:  # 如果是None，这个错误没有被处理，说明这个错误不是drf的错误，而是django的或代码的错误
        return Response({'code': 999, 'msg': '系统错误，错误原因是：%s' % str(exc)})
    
    
 # 配置在配置文件中
    REST_FRAMEWORK = {
        'EXCEPTION_HANDLER': 'app01.exctptions.common_exception_handler'
    }

五：接口文档

1.接口文档的作用及其内容格式

接口编写已经写完了,需要编写接口文档，给前端的人使用
-请求地址
-请求方式
-支持的编码格式
-请求参数(get,post参数)
-返回格式示例

2.大部分公司的写法

# 第一种写法：
-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

# 第三种写法
-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',
        }
        
        # 注意：
        	-直接在视图类中写注释
            -在序列化类上写help_text
class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book
        fields = '__all__'
        extra_kwargs = {
            "name": {"help_text": "图书名字"}
        }

在这里插入图片描述

练习：

class NewFilter(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(Q(name__icontains=name) | Q(publish__icontains=publish))
            return qs
        elif name:
            qs = queryset.filter(name__icontains=name)
            return qs
        else:
            qs = queryset.filter(publish__icontains=publish)
            return qs

# 使用django-filter实现模糊匹配
# 方式一：
class BookFilter(django_filters.rest_framework.FilterSet):
    name = django_filters.CharFilter(field_name='name', lookup_expr='icontains')
    class Meta:
        model = Book
        fields = ['name']
        
# 方式二：
class BookFilter(django_filters.rest_framework.FilterSet):
   
    class Meta:
        model = Book
        fields = {"name": "icontains"}