欢迎访问宙启技术站
智能推送

Django中REST框架过滤器的用法详解

发布时间:2023-12-25 23:16:03

Django REST框架提供了多种过滤器,用于对查询结果进行过滤和排序。这些过滤器可以通过在视图中指定特定的过滤器字段,从而将特定的查询条件传递给数据库进行过滤。

下面是一些常用的过滤器及其用法详解:

1. 精确匹配(Exact)过滤器

exact 过滤器用于执行精确匹配,对于传入参数完全匹配的对象才会被返回。可以通过在视图类的 filter_fields 属性中指定该字段来使用此过滤器。

   from rest_framework import filters

   class MyView(viewsets.ModelViewSet):
       queryset = MyModel.objects.all()
       serializer_class = MySerializer
       filter_backends = [filters.SearchFilter]
       search_fields = ['name']
   

在上面的例子中,将会对 name 字段进行精确匹配过滤。

2. 模糊匹配(Search)过滤器

search 过滤器用于进行模糊匹配,它会扫描指定字段的文本内容,如果输入的值在该字段中出现,则将结果返回。可以通过在视图类的 filter_backends 属性中指定该字段来使用此过滤器。

   from rest_framework import filters

   class MyView(viewsets.ModelViewSet):
       queryset = MyModel.objects.all()
       serializer_class = MySerializer
       filter_backends = [filters.SearchFilter]
       search_fields = ['name', 'description']
   

在上面的例子中,如果输入的搜索值在 namedescription 字段中出现,则将返回结果。

3. 范围过滤器(Range)

range 过滤器用于进行范围过滤,可以指定一个范围来返回在此范围内的结果。可以通过在视图类的 filter_fields 属性中指定该字段来使用此过滤器。

   from rest_framework import filters

   class MyView(viewsets.ModelViewSet):
       queryset = MyModel.objects.all()
       serializer_class = MySerializer
       filter_backends = [filters.OrderingFilter]
       ordering_fields = ['price']
   

在上面的例子中,可以通过指定 price 字段的范围来获取在此范围内的结果。

4. 排序过滤器(Ordering)

ordering 过滤器用于对查询结果进行排序,可以通过在视图类的 filter_fields 属性中指定该字段来使用此过滤器。

   from rest_framework import filters

   class MyView(viewsets.ModelViewSet):
       queryset = MyModel.objects.all()
       serializer_class = MySerializer
       filter_backends = [filters.OrderingFilter]
       ordering_fields = ['name', 'price']
   

在上面的例子中,可以通过指定 nameprice 字段来对查询结果进行排序。

5. 多字段排序过滤器(SearchFilter)

order_by 过滤器用于支持多字段排序,可以通过在视图类的 filter_fields 属性中指定该字段来使用此过滤器。

   from rest_framework import filters

   class MyView(viewsets.ModelViewSet):
       queryset = MyModel.objects.all()
       serializer_class = MySerializer
       filter_backends = [filters.SearchFilter]
       search_fields = ['name', 'price']
   

在上面的例子中,可以通过指定 nameprice 字段来对查询结果进行排序。

以上是一些常用的Django REST框架过滤器的用法详解,你可以根据具体的需求选择合适的过滤器来进行数据过滤和排序操作。