目录
内置认证类、权限类、频率类
一、内置认证类
- BasicAuthentication
- RemoteUserAuthentication
- SessionAuthentication：
# session认证，建议自己写
1.如果前端带着cookies过滤，经过session的中间件，如果登录了，在request.user中就有当前登录用户
2.drf没有限制是否登录
3.加了这个认证，如果没有登录，就不允许往后访问了
- TokenAuthentication：
# jwt认证，建议自己写
二、内置权限类
- BasePermission：所有的基类
- AllowAny：允许所有
- IsAuthenticated：是否登录，登录了才有权限
- 认证类，如果已经登录，返回(当前登录用户，None)，如果没有登录就返回 None
- IsAdminUser：auth的user表中is_staff字段是否为True，对后台管理没有权限
三、内置频率类
- BaseThrottle：所有的基类
- SimpleRateThrottle：咱们写频率类都继承它，少写代码
- AnonRateThrottle：如果你想按ip地址限制，只需要在配置文件中配置
'DEFAULT_THROTTLE_RATES': {
'anon': '3/m',
}
-UserRateThrottle:如果你想按用户id限制，只需要在配置文件中配置
'DEFAULT_THROTTLE_RATES': {
'user': '3/m',
}
过滤类的其他使用
一、内置过滤类
-
缺点：
只能通过?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:8008/books/?name=三国演义&publish=南京出版社 # 精准搜索，条件是并且的关系 -
自定义过滤类
1.重写一个类，继承BaseFilterBackend 2.重写某个方法：filter_queryset，在该分分钟实现过滤，返回qs对象 from rest_framework.filters import BaseFilterBackend class MyFilter(BaseFilterBackend): # 在这里面实现过滤，一定要返回qs对象，过滤后的数据 def filter_queryset(self, request, queryset, view): name = request.query_params.get('name', None) publish = request.query_params.get('publish', None) if not name: qs = queryset.filter(publish__icontains=publish) elif not publish: qs = queryset.filter(name__icontains=name, ) else: qs = queryset.filter(name__icontains=name, publish__icontains=publish) return qs 3.配置在视图类上 filter_backends = [MyFilter, ] # 多个过滤类和排序类可以共用，filter_backends=[],可以配置多个，执行顺序是从左往右，使用放在最左侧的尽量先过滤掉大部分数据
全局异常处理
一、简介
drf中无论在三大认证还是视图类的方法中执行，只要报错(包括主动抛异常)，都会执行异常处理函数
只要出了异常在APIView的dispatch中捕获了，执行了配置文件配置的：'EXCEPTION_HANDLER': 'rest_framework.views.exception_handler'
我们也可以写一个函数，配置在配置文件中，以后出了异常就会走我们写的函数
- 统一返回格式：{'code':101,'msg':错误信息}
- 记录日志：记录异常，便于排查
二、自己写一个函数捕获异常
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)})
接口文档
接口编写完，需要写接口文档，供前端使用
一、文档内容
1.请求地址
2.请求方式
3.支持的编码格式
4.请求参数(get,post参数)
5.返回格式案例
二、在公司的写法
1.直接使用word或md写
2.使用接口文档平台，在接口文档平台录入
- Yapi（百度开源的自己搭建）
- 第三方平台(收费)
- 自己开发接口文档平台
- https://www.showdoc.com.cn/item/index
- 不想花钱，没有能力开发，就使用开源的YAPI，https://zhuanlan.zhihu.com/p/366025001
3.项目自动生成：swagger、coreapi
- 下载：pip3 install coreapi
- 路由配置：
from rest_framework.documentation import include_docs_urls
urlpatterns = [
path('docs/', include_docs_urls(title='站点页面标题'))
]
- 在视图类中加注释
- 在配置文件中配置
{'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',}
django配置文件
一、简介
-
配置项必须大写
-
django项目如果要启动，会先加载配置文件，如果配置文件报错，项目会运行不起来
二、详解
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
# 项目根路径
SECRET_KEY = '!qyiyiw-n5k*os)36yb+npk^e*lertauj!d64ie2_%ofwx+@-e'
# 密钥，自动生成，很复杂，django中涉及到加密的都会使用它，不能没有
DEBUG = True
# DEBUG如果是True，表示项目是调试模式，特点：抛异常在浏览器能直接看到；如果路径不存在，会提示存在的路径
ALLOWED_HOSTS = []
# 允许项目部署的地址(后期项目上线，这里写服务器的地址)，DEBUG=False时，这个必须加'*'，不加会报错
# 所有的app，django大而全就在于它提供了很多内置的app
INSTALLED_APPS = [
'django.contrib.admin', # 后台管理admin
'django.contrib.auth', # 权限，六个表，如下图
'django.contrib.contenttypes',
'django.contrib.sessions', # session认证相关 ==》 django_session表
'django.contrib.messages', # 消息框架
'django.contrib.staticfiles', # 静态文件
'app01.apps.App01Config', # app01
]
# 中间件
MIDDLEWARE = [
'django.middleware.security.SecurityMiddleware',
# 为request/response提供了几种xss脚本过滤的安全改进，无它不安全
'django.contrib.sessions.middleware.SessionMiddleware',
# 开启session会话支持，无它无session
'django.middleware.common.CommonMiddleware',
# 基于 PREPEND_WWW 和 APPEND_SLASH 的设置来重写路径
# 如果 APPEND_SLASH设为True，会把没有/结尾的匹配不不成功的路径，重定向到在末尾加上/的路径
# 如果 PREPEND_WWW设为True，会把开头缺少www.的路径，重定向到www.开头的相同的路径
'django.middleware.csrf.CsrfViewMiddleware',
# 添加跨站点请求伪造的保护，通过想POST表单添加一个隐藏的表单字段，并检查请求中是否有正确的值，无它无csrf保护
'django.contrib.auth.middleware.AuthenticationMiddleware',
# 在视图函数执行前向每个接收到的user对象添加HttpRequest属性，表示当前登录的用户，无它用不了request.user
'django.contrib.messages.middleware.MessageMiddleware',
# 开启基于cookie和会话的消息指出，无它无message
'django.middleware.clickjacking.XFrameOptionsMiddleware',
# 对点击劫持的保护
]
ROOT_URLCONF = '分页排序.urls'
# 根路由，所有请求进来，先去根路由匹配 ==》 内部可能有路由分发
TEMPLATES = [...]
# 模板相关配置
WSGI_APPLICATION = '分页排序.wsgi.application'
# 后期项目上线，uwsgi运行这个application，测试间断使用manage.py运行项目
# 数据库相关配置，可以使用多数据库
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
}
}
# auth认证相关
AUTH_PASSWORD_VALIDATORS = [...]
# 国际化
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'