Django Rest API日期范围过滤异常：React传参后仅返回错误

问题描述 #

开发基于React + Django REST Framework的应用时，尝试实现按日期范围过滤订单数据：前端选择开始/结束日期后发送POST请求，后端通过added_on字段过滤订单，但目前功能失效，请求仅返回错误信息，无法获取过滤后的订单数据。

代码问题分析 #

1. 序列化器误用：当前使用OrdersSerializer验证请求数据，但该序列化器绑定的是Orders模型，而请求中的startDate、endDate并非模型字段，导致验证直接失败，触发异常。
2. 异常捕获过于宽泛：视图中使用无差别except捕获所有异常，无法定位具体错误原因（比如参数格式错误、字段不存在等），不利于排查问题。
3. 日期范围逻辑可能存在漏洞：若前端仅传递日期（如YYYY-MM-DD），Django会解析为当天0点，此时added_on__lte=endDate会排除endDate当天的所有订单。

修复方案 #

1. 创建专门的过滤参数序列化器 #

新建一个仅用于验证日期范围参数的序列化器，与订单模型序列化器分离：

from rest_framework import serializers

class DateRangeFilterSerializer(serializers.Serializer):
    startDate = serializers.DateTimeField(required=True, help_text="格式示例：2024-01-01T00:00:00")
    endDate = serializers.DateTimeField(required=True, help_text="格式示例：2024-01-31T23:59:59")

2. 修改视图逻辑 #

替换序列化器、优化异常捕获、完善日期过滤逻辑：

from rest_framework import generics, permissions, serializers
from rest_framework.response import Response
from .models import Orders
from .serializers import OrdersSerializer, DateRangeFilterSerializer
from datetime import timedelta

class OrderDateViewSet(generics.ListAPIView):
    serializer_class = OrdersSerializer
    queryset = Orders.objects.all()
    permission_classes = [permissions.AllowAny]

    def post(self, request):
        try:
            # 验证日期范围参数
            filter_serializer = DateRangeFilterSerializer(data=request.data)
            filter_serializer.is_valid(raise_exception=True)
            
            start_date = filter_serializer.validated_data['startDate']
            end_date = filter_serializer.validated_data['endDate']
            
            # 优化：若前端仅传日期，自动将end_date调整为次日0点，确保包含当天所有订单
            if end_date.hour == 0 and end_date.minute == 0 and end_date.second == 0:
                end_date += timedelta(days=1)
                orders = Orders.objects.filter(added_on__gte=start_date, added_on__lt=end_date)
            else:
                orders = Orders.objects.filter(added_on__gte=start_date, added_on__lte=end_date)
            
            # 序列化过滤后的订单数据
            order_serializer = OrdersSerializer(orders, many=True)
            return Response({
                "error": False,
                "message": "Orders Between Dates",
                "data": order_serializer.data
            })
        
        # 捕获参数验证错误，返回具体细节
        except serializers.ValidationError as e:
            return Response({
                "error": True,
                "message": "参数验证失败",
                "details": e.detail
            }, status=400)
        
        # 捕获其他服务器错误，返回具体信息
        except Exception as e:
            return Response({
                "error": True,
                "message": f"服务器错误：{str(e)}"
            }, status=500)

3. 前端参数格式注意事项 #

确保前端传递的日期格式符合Django的DateTimeField要求，推荐使用ISO 8601格式（如2024-05-01T12:00:00），避免因格式不匹配导致验证失败。

内容的提问来源于stack exchange，提问作者Ahmed Sereta