过滤组件、排序、异常处理

目录

一、过滤Filtering

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

1、安装组件

pip install django-filter

2、过滤组件的使用

# 在配置文件中增加过滤后端的设置：
INSTALLED_APPS = [
    ...
    'django_filters',  # 需要注册应用，
]

REST_FRAMEWORK = {
	# 过滤组件
    'DEFAULT_FILTER_BACKENDS': (
    'django_filters.rest_framework.DjangoFilterBackend',
    )
}

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

from rest_framework.generics import ListAPIView
from app01.models import Book
from app01.serializer import BookSerializer


class BookView(ListAPIView):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    filter_backends=[SearchFilter,]  # 过滤类：可以自己写，也可以用内置，使用第三方
    filter_fields = ('title',)  # 可以根据字段来过滤

4、自定义过滤类

# 第一步，写一个类，继承基类BaseFilterBackend，重写某个方法filter_queryset，返回的数据就是过滤后的qs对象
# 配置一下，在视图类中配置
filter_backends = [FilterByName]

### 过滤类
from rest_framework.filters import BaseFilterBackend
class FilterByName(BaseFilterBackend):
    def filter_queryset(self, request, queryset, view):
        # http://127.0.0.1:8000/book/?name=红楼梦
        query=request.query_params.get('name')
        if query:
            return queryset.filter(name__contains= query )
        else:
            return queryset

        return queryset

### 视图类
# from .filters import FilterByName
# class BookView(ViewSetMixin, ListAPIView):
#     queryset = Book.objects.all()
#     serializer_class = BookSerializer
#     filter_backends = [FilterByName]

二、排序

1、使用方法

    在类视图中设置filter_backends，使用rest_framework.filters.OrderingFilter过滤器，REST framework会在请求的查询字符串参数中检查是否包含了ordering参数，如果包含了ordering参数，则按照ordering参数指明的排序字段对数据集进行排序。

    前端可以传递的ordering参数的可选字段值需要在ordering_fields中指明。

2、配置

from rest_framework.generics import ListAPIView
from app01.models import Book
from app01.serializer import BookSerializer
from rest_framework.filters import OrderingFilter


class Book2View(ListAPIView):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    filter_backends = [OrderingFilter]
    ordering_fields = ('id', 'price')
    
# 测试
http://127.0.0.1:8000/book2/?ordering=-id
# -id 表示针对id字段进行倒序排序
# id  表示针对id字段进行升序排序

3、过滤组件和排序组件结合使用

from rest_framework.generics import ListAPIView
from app01.models import Book
from app01.serializer import BookSerializer
from rest_framework.filters import OrderingFilter
from django_filters.rest_framework import DjangoFilterBackend


class Book2View(ListAPIView):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    filter_fields = ('title', 'price')
    # 因为局部配置会覆盖全局配置,所以需要重新把过滤组件核心类再次声明,否则过滤功能会失效
    filter_backends = [OrderingFilter, DjangoFilterBackend]
    ordering_fields = ('id', 'price')

三、异常处理

1、自定义异常处理

# 全局配置
REST_FRAMEWORK = {
    # 自定义异常
    'EXCEPTION_HANDLER': 'app01.views.my_exception_handler',
}

2、配置异常处理

# 统一接口返回

from rest_framework.views import exception_handler  # 导入全局异常
from rest_framework import status

# 自定义异常处理
def my_exception_handler(exc, context):
    response = exception_handler(exc, context)
    # 两种情况，一个是none，drf没有处理
    if not response:
        return Response(data={'status': 999, 'msg': str(exc)}, status=status.HTTP_400_BAD_REQUEST)
    else:
        return Response(data={'status': 888, 'msg': str(exc)}, status=status.HTTP_403_FORBIDDEN)

四、自己封装Response

1、auth.py

# 自己封装Response对象
from rest_framework.response import Response

class APIResponse(Response):
    def __init__(self, code=100, msg='成功',data=None,status=None,headers=None,**kwargs):
        dic = {'code':code,'msg':msg}
        if data:
            dic = {'code':code,'msg':msg, 'data':data}
        dic.update(kwargs)
        super().__init__(data=dic,status=status,headers=headers)
        
# 使用方式

2、views.py

# 使用方式

from app01.auth import APIResponse
class TestView(APIView):
    def get(self, request, *args, **kwargs):
        return APIResponse(data={'name': 'meng'}, token='dddddd')
# 好处是可扩展性强，使用方式非常方便
posted @ 2022-02-08 15:57  迷恋～以成伤  阅读(50)  评论(0)    收藏  举报