drf-04-admin后台管理、认证、权限Permissions、限流Throttling、过滤Filtering、排序、分页Pagination、异常处理、自动生成接口文档、Xadmin

程序员文章站 2022-07-12 10:33:28

...

admin后台管理系统简单使用

在应用的admin.py文件中

from app01 import models

class StudentAdmin(admin.ModelAdmin):
    list_display = ['id','name','age','class_null']
    list_editable = ['name','age']  # 可直接在当前页面编辑

# admin.site.register(models.Student)
admin.site.register(models.Student,StudentAdmin)

创建超级管理员用户

python manage.py createsuperuser
输入用户名和密码,邮箱可以不输入

在models.py中添加：

	...
    def __str__(self):
        return self.name

在总url.py中

path('admin/', admin.site.urls),

一、认证Authentication

1.使用

（1）在配置文件中配置全局默认的认证方案

from rest_framework import settings源代码中可以看到它的默认使用

在settings配置文件中，我们可以进行下面的配置来覆盖默认配置
REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': [
      #哪个写在前面，优先使用哪个认证
        'rest_framework.authentication.SessionAuthentication',  # session认证，admin后台其实就使用的session认证，其实接口开发很少用到session认证，所以我们通过配置可以改为其他认证，比如后面项目里面我们用到jwt，JSON WEB TOKEN认证，或者一些配合redis的认证
        'rest_framework.authentication.BasicAuthentication',   # 基本认证，工作当中可能一些测试人员会参与的话，他们会将一些认证数据保存在内存当中，然后验证的，我们基本上用不上
    ]
}

（2）在视图中局部使用

也可以在每个视图中通过设置authentication_classess属性来局部使用

from rest_framework.authentication import SessionAuthentication, BasicAuthentication
from rest_framework.views import APIView

class ExampleView(APIView):
    # 类属性
    authentication_classes = [SessionAuthentication, BasicAuthentication] #也可以写成元祖形式的,到时候我们使用我们自己开发的认证组件的时候，就需要自己写一个认证组件类，然后写在列表中来使用
    ...

2.自定义认证组件

drf-04-admin后台管理、认证、权限Permissions、限流Throttling、过滤Filtering、排序、分页Pagination、异常处理、自动生成接口文档、Xadmin

写一个认证类 auth.py

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

class Auth(BaseAuthentication):

    def authenticate(self, request):

        # request.POST.get('username')

        username = 'root'
        if username == 'root':

            return 'root','oo'  # request.user = root, request.auth = 'oo'

        else:
            raise AuthenticationFailed('登录认证失败')

（1）全局使用

settings配置文件中使用

    REST_FRAMEWORK = {
      'DEFAULT_AUTHENTICATION_CLASSES': [
          ...
          'app01.utils.auth.Auth',  #全局配置，所有的接口请求过来，都会执行这个类

      ],
    }

（2）局部视图使用

from app01.utils.auth import Auth

class Students1View(APIView):
    authentication_classes = [Auth,]  #局部配置，使用自定义的登录认证类
    
    def get(self,request):
    print('>>>>>>',request.user)
    print('>>>>>>',request.auth)
    all_data = models.Student.objects.all()

    serializer = StudentSerializer(instance=all_data,many=True)
    return Response(serializer.data)

二、权限Permissions

权限控制可以限制用户对于视图的访问和对于具体数据对象的访问。

在执行视图的dispatch()方法前，会先进行视图访问权限的判断
在通过get_object()获取具体对象时，会进行模型对象访问权限的判断

1.使用

（1）在配置文件中配置全局的权限管理类

'DEFAULT_PERMISSION_CLASSES': [
        # 'app01.utils.auth.MyPermisson', # 全局配置
        'rest_framework.permissions.IsAuthenticated', #登录成功之后才能访问的一个权限
    ],

（2）在视图中局部使用

在具体的视图中通过permission_classes属性来设置

from rest_framework.permissions import IsAuthenticated
from rest_framework.views import APIView

class ExampleView(APIView):
    permission_classes = (IsAuthenticated,)
    ...

提供的权限

AllowAny 允许所有用户
IsAuthenticated 仅通过认证的用户
IsAdminUser 仅管理员用户（可以通过admin创建一个用户进行测试）
IsAuthenticatedOrReadOnly 已经登陆认证的用户可以对数据进行增删改操作，没有登陆认证的只能查看数据。

2.自定义权限

如需自定义权限，需继承rest_framework.permissions.BasePermission父类，并实现以下两个任何一个方法或全部

.has_permission(self, request, view)

是否可以访问视图，view表示当前视图对象
.has_object_permission(self, request, view, obj)

是否可以访问数据对象，view表示当前视图，obj为数据对象

（1）全局使用

settings配置文件中使用

    'DEFAULT_PERMISSION_CLASSES': [
       'app01.utils.auth.MyPermisson', # 全局配置
        # 'rest_framework.permissions.IsAuthenticated', #登录成功之后才能访问的一个权限
    ],

（2）局部视图使用

from app01.utils.auth import Auth,MyPermisson
class Students1View(APIView):
    # authentication_classes = [Auth,]  #局部配置，使用自定义的登录认证类
    permission_classes = [MyPermisson,]

    # 获取所有数据接口
    def get(self,request):
        print('>>>>>>',request.user)
        print('>>>>>>',request.auth)

        all_data = models.Student.objects.all()

        serializer = StudentSerializer(instance=all_data,many=True)
        return Response(serializer.data)

三、限流Throttling

可以对接口访问的频次进行限制，以减轻服务器压力。

1.使用

（1）在配置文件中全局配置

在配置文件中，使用DEFAULT_THROTTLE_CLASSES 和 DEFAULT_THROTTLE_RATES进行全局配置

    'DEFAULT_THROTTLE_CLASSES': (
        'rest_framework.throttling.AnonRateThrottle',  # 匿名用户，未登录的
        'rest_framework.throttling.UserRateThrottle'  # 经过登录之后的用户
    ),

（2）在视图中局部使用

from rest_framework.throttling import UserRateThrottle

	throttle_classes = [UserRateThrottle,]
	...

2.自定义权限

（1）全局使用

settings配置文件中使用

    # 频率访问限制类
    # 'DEFAULT_THROTTLE_CLASSES': (
    #     'rest_framework.throttling.AnonRateThrottle',  # 匿名用户，未登录的
    #     'rest_framework.throttling.UserRateThrottle'  # 经过登录之后的用户
    # ),
    'DEFAULT_THROTTLE_RATES': {
        'anon': '3/minute',
        'user': '5/minute'
    },

DEFAULT_THROTTLE_RATES 可以使用 second, minute, hour 或day来指明周期。

源码：
{'s': 1, 'm': 60, 'h': 3600, 'd': 86400} m表示分钟，可以写m，也可以写minute

（2）局部视图使用

可选限流类

1） AnonRateThrottle
限制所有匿名未认证用户，使用IP区分用户。
使用DEFAULT_THROTTLE_RATES['anon'] 来设置频次
2）UserRateThrottle
限制认证用户，使用User id 来区分。
使用DEFAULT_THROTTLE_RATES['user'] 来设置频次
3）ScopedRateThrottle (待定…)
限制用户对于每个视图的访问频次，使用ip或user id,先找的用户id，没有设置用户id的话就会使用ip地址。

在具体视图中通过throttle_classess属性来配置
ScopedRateThrottle局部使用示例

settings.py内容
'DEFAULT_THROTTLE_RATES': {
        'xx': '3/minute',
        'oo': '5/minute',
    },
    
views.py内容

from rest_framework.throttling import ScopedRateThrottle

class StudentAPIView(ListAPIView):
    queryset = models.Student.objects.all()
    serializer_class = StudentModelSerializer
    throttle_classes = [ScopedRateThrottle,]
    throttle_scope = 'xx'

class StudentAPI2View(ListAPIView):
    queryset = models.Student.objects.all()
    serializer_class = StudentModelSerializer
    throttle_classes = [ScopedRateThrottle, ]
    throttle_scope = 'oo'
    
urls.py内容
    path(r'students/',views.StudentAPIView.as_view()),
    path(r'students2/',views.StudentAPI2View.as_view()),

四、过滤Filtering

对于列表数据可能需要根据字段进行过滤，我们可以通过添加django-fitlter扩展来增强支持。

pip install django-filter

在配置文件中增加过滤后端的设置：

INSTALLED_APPS = [
    ...
    'django_filters',  # 需要注册应用，
]

REST_FRAMEWORK = {
    ...
    'DEFAULT_FILTER_BACKENDS': ('django_filters.rest_framework.DjangoFilterBackend',)
}

在视图中添加filter_fields属性，指定可以过滤的字段

class Students8View(ModelViewSet):
    queryset = models.Student.objects.all()
    serializer_class = StudentSerializer

    filter_fields = ('name', 'age')

    #http://127.0.0.1:8001/app01/students8/?name=xx

五、排序

1.使用

对于列表数据，REST framework提供了OrderingFilter过滤器来帮助我们快速指明数据按照指定字段进行排序。
使用方法：
在类视图中设置filter_backends，使用rest_framework.filters.OrderingFilter过滤器，REST framework会在请求的查询字符串参数中检查是否包含了ordering参数，如果包含了ordering参数，则按照ordering参数指明的排序字段对数据集进行排序。
前端可以传递的ordering参数的可选字段值需要在ordering_fields中指明。

class Students8View(ModelViewSet):
    queryset = models.Student.objects.all()
    serializer_class = StudentSerializer
    filter_backends = [OrderingFilter]

    ordering_fields = ('id','age')

    # http://127.0.0.1:8001/app01/students8/?ordering=-id
	# 必须是ordering=某个值
	# -id 表示针对id字段进行倒序排序
	# id  表示针对id字段进行升序排序

2.两者结合：过滤以后进行排序

from rest_framework.generics import ListAPIView
from students.models import Student
from .serializers import StudentModelSerializer
from django_filters.rest_framework import DjangoFilterBackend #需要使用一下它才能结合使用

class Students8View(ModelViewSet):
    queryset = models.Student.objects.all()
    serializer_class = StudentSerializer
    # 因为filter_backends是局部过滤配置，局部配置会覆盖全局配置,所以需要重新把过滤组件核心类再次声明,
    # 否则过滤功能会失效
    filter_backends = [OrderingFilter,DjangoFilterBackend]
    filter_fields = ('name', 'age')
    ordering_fields = ('id','age')
    
    # 针对的是继承的类中的list方法
   
 # http://127.0.0.1:8001/app01/students8/?age=30&ordering=-id

六、分页Pagination

1.使用

在配置文件中设置全局的分页方式

  # 全局分页，一旦设置了全局分页，那么我们drf中的视图扩展类里面的list方法提供的列表页都会产生分页的效果。所以一般不用全局分页
   'DEFAULT_PAGINATION_CLASS':  'rest_framework.pagination.PageNumberPagination',
   'PAGE_SIZE': 2  # 每页最大数据量

2.自定义分页

可通过自定义Pagination类，来为视图添加不同分页行为。在视图中通过pagination_class属性来指明。

from rest_framework.pagination import PageNumberPagination,LimitOffsetPagination

class LargeResultsSetPagination(PageNumberPagination):
    page_size = 2  
    # 127.0.0.1:8001/students/?page=5&size=10
    page_query_param = 'pp'  # # 自定义页码的参数名
    page_size_query_param = 'size'  
    max_page_size = 5

class LargePagination(LimitOffsetPagination):
    default_limit = 3  #一页显示3条


class Students8View(ModelViewSet):
    queryset = models.Student.objects.all()
    serializer_class = StudentSerializer
    # filter_backends = [OrderingFilter,DjangoFilterBackend]
    # filter_fields = ('name', 'age')
    # ordering_fields = ('id','age')
    pagination_class = LargePagination

注意： 如果在视图内关闭分页功能，只需在视图内设置

	pagination_class = None

3.可选分页器

1） PageNumberPagination

前端访问网址形式：

GET  http://127.0.0.1:8001/students/?page=4

可以在子类中定义的属性：

page_size 每页数目
page_query_param 前端发送的页数关键字名，默认为"page"
page_size_query_param 前端发送的每页数目关键字名，默认为None
max_page_size 前端最多能设置的每页数量

2）LimitOffsetPagination

前端访问网址形式：其实就是通过偏移量来取数据

GET http://127.0.0.1/four/students/?limit=100&offset=400  #从下标为400的记录开始，取100条记录

可以在子类中定义的属性：

default_limit 默认限制，每页数据量大小，默认值与PAGE_SIZE设置一致
limit_query_param limit参数名，默认’limit’ ，可以通过这个参数来改名字
offset_query_param offset参数名，默认’offset’ ，可以通过这个参数来改名字
max_limit 最大limit限制，默认None，无限制

七、异常处理 Exceptions

1.简单示例

view.py

class APIError(Exception):
    pass


class Test(APIView):

    def get(self,request):
        try:
            models.Student.objects.get(pk=100)
        except models.Student.DoesNotExist:

            raise APIError('错啦错啦@!!')

            return Response({'msg':'查询出错啦'})
        return Response({'msg':'xxxxx'})

urls.py

	path('test/', views.Test.as_view()),

2.自定义异常处理

myexceptions.py

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


def myexception_handler(exc, context):
    ret = exception_handler(exc, context)
    # print('xxxxxxxxxxxxxxxxxxx')
    print(exc,type(exc)) #错啦错啦@!! <class 'app01.views.APIError'>
    if ret is None:

        if isinstance(exc,APIError):
            return Response('api 错误')

        else:
            return ret

在配置文件中settings.py声明自定义的异常处理

    'EXCEPTION_HANDLER': 'app01.myexceptions.myexception_handler',

3.补充处理关于数据库的异常

from rest_framework.views import exception_handler as drf_exception_handler
from rest_framework import status
from django.db import DatabaseError

def exception_handler(exc, context):
    response = drf_exception_handler(exc, context)

    if response is None:
        view = context['view'] #出错的方法或者函数名称
        if isinstance(exc, DatabaseError):
            print('[%s]: %s' % (view, exc))
            response = Response({'detail': '服务器内部错误'}, status=status.HTTP_507_INSUFFICIENT_STORAGE)

    return response

4.REST framework定义的异常

APIException 所有异常的父类
ParseError 解析错误
AuthenticationFailed 认证失败
NotAuthenticated 尚未认证
PermissionDenied 权限决绝
NotFound 未找到
MethodNotAllowed 请求方式不支持
NotAcceptable 要获取的数据格式不支持
Throttled 超过限流次数
ValidationError 校验失败

也就是说，上面列出来的异常不需要我们自行处理了，很多的没有在上面列出来的异常，就需要在自定义异常中处理。

八、自动生成接口文档

REST framework可以自动帮助我们生成接口文档。接口文档以网页的方式呈现。
自动接口文档能生成的是继承自APIView及其子类的视图。

1.安装依赖

REST framewrok生成接口文档需要coreapi库的支持。

	pip install coreapi

2.设置接口文档访问路径

在settings.py中：

    'DEFAULT_SCHEMA_CLASS': "rest_framework.schemas.AutoSchema",

在总路由urls.py中添加接口文档路径。
文档路由对应的视图配置为rest_framework.documentation.include_docs_urls，参数title为接口文档网站的标题。


from rest_framework.documentation import include_docs_urls

	...
	path('docs/', include_docs_urls(title='站点页面标题'))

3.文档描述说明的定义位置

   def post(self, request):
        """
        这是添加一条记录的接口
        :param request:  请求对象
        :return:  json类型
        """
        ...

4.访问接口文档网页

浏览器访问 127.0.0.1:8001/docs/，即可看到自动生成的接口文档。

两点说明：
1）视图集ViewSet中的retrieve名称，在接口文档网站中叫做read
2）参数的Description需要在模型类或序列化器类的字段中以help_text选项定义，如：

class Student(models.Model):
    ...
    name = models.CharField(max_length=100,verbose_name="姓名",help_text='提示文本：不能为空')
    ...

九、Xadmin

xadmin是Django的第三方扩展，比使用Django的admin站点更强大也更方便。
文档：https://xadmin.readthedocs.io/en/latest/index.html
GitHub地址：https://github.com/sshwsfc/django-xadmin

1.安装

通过如下命令安装xadmin的最新版

pip install https://codeload.github.com/sshwsfc/xadmin/zip/django2

在配置文件中注册如下应用

INSTALLED_APPS = [
    ...
    'xadmin',
    'crispy_forms',
    'reversion',
    ...
]

# 修改使用中文界面
LANGUAGE_CODE = 'zh-Hans'

# 修改时区
TIME_ZONE = 'Asia/Shanghai'

xadmin有建立自己的数据库模型类，需要进行数据库迁移

python manage.py makemigrations
python manage.py migrate

在总路由中添加xadmin的路由信息

import xadmin
xadmin.autodiscover()

# version模块自动注册需要版本控制的 Model
from xadmin.plugins import xversion
xversion.register_models()

urlpatterns = [
    path(r'xadmin/', xadmin.site.urls),
]

如果之前没有创建超级用户，需要创建，如果有了，则可以直接使用之前的。

python manage.py createsuperuser

2.使用

xadmin不再使用Django的admin.py，而是需要编写代码在adminx.py文件中，每一个应用都可以写一创建adminx.py对xadmin站点进行配置。
xadmin的站点管理类不用继承admin.ModelAdmin，而是直接继承object即可。

在子应用中创建adminx.py文件。

站点的全局配置

import xadmin
from xadmin import views

class BaseSetting(object):
    """xadmin的基本配置"""
    enable_themes = True  # 开启主题切换功能
    use_bootswatch = True # 引导控制盘(其实就是我们的左侧菜单栏)

xadmin.site.register(views.BaseAdminView, BaseSetting)

class GlobalSettings(object):
    """xadmin的全局配置"""
    site_title = "皇家赌场"  # 设置站点标题
    site_footer = "皇家有限公司"  # 设置站点的页脚
    menu_style = "accordion"  # 设置菜单折叠

xadmin.site.register(views.CommAdminView, GlobalSettings)

站点Model管理

xadmin可以使用的页面样式控制基本与Django原生的admin一直。
可以在models类中定义个__str__方法来定义对象显示成什么内容

list_display控制列表展示的字段

list_display = ['id', 'btitle', 'bread', 'bcomment']

search_fields控制可以通过搜索框搜索的字段名称，xadmin使用的是模糊查询
```
search_fields = ['id','btitle']
```
*ist_filter可以进行过滤操作的列，对于分类、性别、状态
```
list_filter = ['is_delete']
```
ordering默认排序的字段
```
ordering = ['-age',]  #-倒序
```
show_detail_fields在列表页提供快速显示详情信息
```
show_detail_fields = ['id',]
```
list_editable在列表页可以快速直接编辑的字段
```
list_editable = ['name','age',]
```

refresh_times指定列表页的定时刷新

refresh_times = [5, 10,30,60]  # 设置允许后端管理人员按多长时间(秒)刷新页面,选好之后就能自动刷新了

list_export控制列表页导出数据的可选格式

list_export = ('xls', 'json','csv')#写元祖或者列表都行   list_export设置为None来禁用数据导出功能
list_export_fields = ('id', 'btitle', 'bpub_date') #设置允许导出的字段

show_bookmarks控制是否显示书签功能

show_bookmarks = True #False就隐藏了这个功能

data_charts控制显示图表的样式

data_charts = {
        "order_amount": {  #随便写的名称order_amount
          'title': '图书发布日期表', 
          "x-field": "bpub_date", 
          "y-field": ('btitle',),
          "order": ('id',),
          
        },
    #    支持生成多个不同的图表
    #    "order_amount2": {
    #      'title': '图书发布日期表', 
    #      "x-field": "bpub_date", 
    #      "y-field": ('btitle',),
    #      "order": ('id',)
    #    },
    }

title 控制图标名称
x-field 控制x轴字段
y-field 控制y轴字段，可以是多个值
order 控制默认排序

model_icon控制菜单的图标【图标的设置可以参考font-awesome的图标css名称】
```
model_icon = 'fa fa-gift'
```
readonly_fields在编辑页面的只读字段
```
readonly_fields = ['name',]
```
exclude在编辑页面隐藏的字段,比如判断这个数据是否删除的delete_status字段，一般就是用来标识一下字段是不是被删除了，但是数据库中不删除
```
exclude = ['name',]
```
这并不是所有功能，可以参看它的文档，它提供的一些功能可能还需要自定制，调整或者添加一些它没有的功能

drf-04-admin后台管理、认证、权限Permissions、限流Throttling、过滤Filtering、排序、分页Pagination、异常处理 、自动生成接口文档、Xadmin

admin后台管理系统简单使用

一、认证Authentication

1.使用

（1）在配置文件中配置全局默认的认证方案

（2）在视图中局部使用

2.自定义认证组件

（1）全局使用

（2）局部视图使用

二、权限Permissions

1.使用

（1）在配置文件中配置全局的权限管理类

（2）在视图中局部使用

2.自定义权限

（1）全局使用

（2）局部视图使用

三、限流Throttling

1.使用

（1）在配置文件中全局配置

（2）在视图中局部使用

2.自定义权限

（1）全局使用

（2）局部视图使用

四、过滤Filtering

五、排序

1.使用

2.两者结合：过滤以后进行排序

六、分页Pagination

1.使用

2.自定义分页

3.可选分页器

七、异常处理 Exceptions

1.简单示例

2.自定义异常处理

3.补充处理关于数据库的异常

4.REST framework定义的异常

八、自动生成接口文档

1.安装依赖

2.设置接口文档访问路径

3.文档描述说明的定义位置

4.访问接口文档网页

九、Xadmin

1.安装

2.使用