标签：name 配置文件 request django filter 文档 user contrib

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

就在这展示一下，以免我忘记，具体用法不做说明

1.内置认证类

from rest_framework.authentication import BaseAuthentication,RemoteUserAuthentication,TokenAuthentication,SessionAuthentication 
#他们全部都会继承BaseAuthentication

#RemoteUserAuthentication源码

class RemoteUserAuthentication(BaseAuthentication):
    header = "REMOTE_USER"

    def authenticate(self, request):
        user = authenticate(request=request, remote_user=request.META.get(self.header))
        if user and user.is_active:
            return (user, None)

#SessionAuthentication源码

class SessionAuthentication(BaseAuthentication):
    def authenticate(self, request):
        user = getattr(request._request, 'user', None)
        if not user or not user.is_active:
            return None
        self.enforce_csrf(request)
        return (user, None)

 

2.内置权限类

from rest_framework.permissions import BasePermission,AllowAny,IsAuthenticated,IsAdminUser
#他们都会继承BasePermission

#AllowAny 源码

class AllowAny(BasePermission):  #（只要调用就返回Ture所以没有限制权限）
    def has_permission(self, request, view):
        return True

# IsAdminUser源码

class IsAdminUser(BasePermission): #（返回是判断request.user有没有值和request.user是否对后台管理有权限，bool是转换成布尔值，总体来说还是返回Ture和False）
    def has_permission(self, request, view):
        return bool(request.user and request.user.is_staff)

# IsAuthenticated源码

class IsAuthenticated(BasePermission): #（同上is_authenticated是判断用户是否登录的） 
def has_permission(self, request, view): return bool(request.user and request.user.is_authenticated)

 

3.内置的频率类

from rest_framework.throttling import BaseThrottle,SimpleRateThrottle,AnonRateThrottle

    -AnonRateThrottle：如果你想按ip地址限制，只需要在配置文件中配置
      'DEFAULT_THROTTLE_RATES': {
        'anon': '3/m',
        }
    -UserRateThrottle:如果你想按用户id限制，只需要在配置文件中配置
     'DEFAULT_THROTTLE_RATES': {
        'user': '3/m',
        }

REMOTE_ADDR = 您的 IP
HTTP_VIA = 没数值或不显示
HTTP_X_FORWARDED_FOR = 没数值或不显示

 

2.补充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'

3.过滤类的其它使用

内置的过滤类只能通过?search=搜索条件，不能制定搜索条件，如果说名字和性别中都带有男，则会全部搜索出来此时就需要我们写一个过滤类或者用第三方的

第三方：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=南京出版社
        -精准搜索，条件是并且的关系

#自己写的 我们自己写必须要继承BaseFilterBackend,然后必须重写filter_queryset方法，不然会直接报错，代码如下所示，最后在和我们前面操作一样，配制在全局或者局部中。
#多个过滤类和排序类可以共用，filter_backends=[],可以配置多个，执行顺序是从做往右，所以，放在最左侧的尽量先过滤掉大部分数据
class UserBaseFilterBackend(BaseFilterBackend):
    def filter_queryset(self, request, queryset, view):
        name = request.query_params.get('name', None)
        password = request.query_params.get('password', None)
        print(queryset)
        if name == None:
            qs = queryset.filter(password__icontains=password)
        elif password == None:
            qs = queryset.filter(name__icontains=name)
        else:
            qs = queryset.filter(name__icontains=name,password__icontains=password)

        return qs

4.全局异常处理

什么叫全局异常处理，全局异常处理就是把所有的错误信息以统一的格式返回，公司一般只会返回错误代码，不会返回错误信息，因为返回错误信息给前端也看不太懂，所以接下来我们写一个全局异常处理只要报错就会返回固定的值

5.接口文档

自己写，需要给前端测试用的，你写的要让别人能看懂，毕竟你也是人，他也是人，要是看不懂，自己考虑一下是你还是他。

# 接口编写已经写完了,需要编写接口文档，给前端的人使用
    -请求地址
    -请求方式
    -支持的编码格式
    -请求参数(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/
            输入邮箱：[email protected]
            输入密码：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

 

标签：name,配置文件,request,django,filter,文档,user,contrib
From： https://www.cnblogs.com/shangxin-bai/p/16780175.html