Django系列之DRF搜索和过滤

这篇具有很好参考价值的文章主要介绍了Django系列之DRF搜索和过滤。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

1. model之间关系

class Publish(models.Model):
    name = models.CharField(max_length=32)
    city = models.CharField(max_length=8)
    email = models.CharField(max_length=32)

class Book(models.Model):
    title = models.CharField(max_length=32)
    price = models.DecimalField(max_digits=5, decimal_places=2)
    pub_date = models.DateField()
    publish = models.ForeignKey(Publish, on_delete=models.CASCADE, null=True)

2. DRF搜索

在DRF中使用搜索功能,只需要在 viewsets 视图类中定义 filter_backendssearch_fields 即可使用。

filter_backends:后端使用的搜索和过滤类。
search_fields :要执行搜索条件的字段,搜索为模糊查询(要在哪些字段上执行模糊查询,支持多表连表查询)。
对应的URL格式就是这种:http://127.0.0.1:9000/test/publishes/?search=北京

class PublishModelViewSets(viewsets.ModelViewSet):
    queryset = Publish.objects.all()
    serializer_class = PublishSerializer
    filter_backends = (SearchFilter, )
    search_fields = ("name", "city", "book__title")   

3. django-filter简单过滤

安装包:pip install django-filter
使用:在 viewsets 视图类的 filter_backends 属性中追加 DjangoFilterBackend,再添加 filterset_fields 属性即可使用。

filterset_fields:要执行过滤条件的字段,执行的是精准查询。
对应的URL格式就是这种 http://127.0.0.1:9000/test/publishes/?name=GansuEngEduPublisher&city=甘肃

在settings配置文件的app中添加:

INSTALLED_APPS = [
	...
    'django_filters'
]
class PublishModelViewSets(viewsets.ModelViewSet):
    queryset = Publish.objects.all()
    serializer_class = PublishSerializer
    filter_backends = (SearchFilter, DjangoFilterBackend)
    search_fields = ("name", "city", "book__title")     # 模糊查询
    filterset_fields = ("name", "city")					# 精准查询

filterset_fields 也可以按照自定义的方式过滤。
对应的URL格式就是这种:http://127.0.0.1:9000/test/publishes/?name__icontains=gansueng&city=甘肃

class PublishModelViewSets(viewsets.ModelViewSet):
    queryset = Publish.objects.all()
    serializer_class = PublishSerializer
    filter_backends = (SearchFilter, DjangoFilterBackend)
    search_fields = ("name", "city", "book__title")     # 模糊查询
    filterset_fields = {
        "name": ["icontains"],      # 包含此查询条件,大小写不敏感
        "city": ['exact']           # 完全相等
    }
    

4. django-filter自定义过滤器类和过滤器函数

  • 过滤器中常用的字段类型,这些类型要和模型中对应的字段类型兼容:
CharFilter         字符串类型
BooleanFilter      布尔类型
DateTimeFilter     日期时间类型
DateFilter         日期类型
DateRangeFilter    日期范围
TimeFilter         时间类型
NumberFilter       数值类型,对应模型中IntegerField, FloatField, DecimalField
  • 字段内参数说明:
field_name:过滤字段名,对应模型中的字段名
lookup_expr:查询时所要进行的操作,和ORM中运算符一致
method:该字段对应的自定义过滤器函数
  • Meta字段使用:
model:引用的模型,不是字符串
fields:指明过滤字段,可以是列表,列表中字典可以过滤,默认是判断相等;也可以是字典,字典可以自定义操作。
exclude:排除字段,不允许使用列表中字典进行过滤

5. django-filter 使用示例

在视图类中添加自定义的过滤类:

class PublishModelViewSets(viewsets.ModelViewSet):
    queryset = Publish.objects.all()
    serializer_class = PublishSerializer
    filter_backends = (SearchFilter, DjangoFilterBackend)
    search_fields = ("name", "city", "book__title")   
    filter_class = PublishFilter		# 自定义过滤类

在app中新建一个filters.py文件,编写自己的自定义过滤函数,也可以不写,使用默认的 orm 筛选关键字。

from django_filters import filters, FilterSet
from app01.models import Publish

class PublishFilter(FilterSet):
    pub_city = filters.CharFilter(field_name='city', lookup_expr='exact')
    pub_email = filters.CharFilter(field_name='email', method='filter_email')

    @staticmethod
    def filter_email(queryset, field_name, value):
        """
        出版社邮件以前端传过来的value值结尾的出版社
        :param queryset: 查询到的数据集
        :param field_name: 过滤的字段名
        :param value: 前端传过来的值
        :return: 过滤后的数据集
        """
        print(field_name, value)
        return queryset.filter(**{f"{field_name}__endswith": value})

    class Meta:
        model = Publish     # 模型名
        fields = ["pub_city", "pub_email"]         # 过滤字段

对应的URL格式就是这样:http://127.0.0.1:9000/test/publishes/?pub_city=北京&pub_email=edu

注意:上述的自定义过滤器类和过滤器函数的方式,在 django-filter 的某些版本不适用,会导致无法过滤,获取到的是全集。上述使用的 django-filter 版本为 21.1。文章来源地址https://www.toymoban.com/news/detail-722202.html

到了这里,关于Django系列之DRF搜索和过滤的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • Django系列之DRF简单使用

    models.py serializers.py app01/views.py project/urls.py app01/urls.py 使用 SimpleRouter() 可以帮我们实现五个基础的 action 方法: {“get”: “list”, “post”: “create”, “get/id”: “retrieve”, “put”: “update”, “delete”: “`destroy”} 如果需要增加一些其他的路由视图,就需要用 action 声明了。

    2024年02月15日
    浏览(35)
  • 43--Django-项目实战-全栈开发-基于django+drf+vue+elementUI企业级项目开发流程-课程详情页面、搜索页面以及后台设计

    1.视频播放功能 下载第三方插件:vue-video-player 使用步骤: 第一步: cnpm install vue-video-player 第二步:在main.js中引入

    2024年02月09日
    浏览(55)
  • 【Django入门系列】数据库操作

    在本章中,我们将学习在Django中进行数据库操作的基础知识。我们将探讨Django中的数据库支持、定义和迁移数据库模型、使用Django的ORM进行数据库查询以及数据库关系和查询优化。 Django提供了对多种关系型数据库的支持,包括常见的MySQL、PostgreSQL和SQLite等。你可以在项目的配

    2024年02月12日
    浏览(56)
  • Django实现DRF数据API接口格式封装

    当进行前后端分离开发时,前端Vue通常需要与后端接口交互并获取数据。初始情况下数据可能是这样的:

    2024年02月11日
    浏览(45)
  • Django进阶:DRF(Django REST framework)

    DRF 即 Django REST framework 的缩写,官网上说: Django REST framework 是一个强大而灵活的工具包,用于 构建Web API 。 简单来说:通过DRF创建API后,就可以通过HTTP请求来获取、创建、更新或删除数据(CRUD)。 那么为什么要构建API呢? 在Django中,我们通过 model-view-template 实现了 后端和前

    2024年02月11日
    浏览(40)
  • django的DRF(三)

    DRF(Django Rest Framework)是可以快速基于Restful开发得Django应用得插件,功能非常多,被广泛应用。 所谓Restful风格就是不在用户请求的URL当中说明 “操作动作(create,delete,put)”。而是直接请求资源,通过不同的http方法来做对应的操作。 比如: 注册: 在settings.py文件中进行注册

    2024年02月21日
    浏览(41)
  • Django DRF - 认证Authentication

    身份验证是将传入请求与一组标识凭据(例如,请求来自的用户或与其进行签名的令牌)相关联的机制。然后,权限和限制策略可以使用这些凭据来确定是否应允许该请求。 身份验证本身不会允许或不允许传入的请求,它只会标识发出请求的凭据。 认证管理一般和权限管理

    2023年04月12日
    浏览(37)
  • 【Django 05】Django-DRF(ModelViewSet)、路由组件、自定义函数

    ModelViewSet 是 Django REST framework 提供的一个视图集类,它封装了常见的模型操作方法。 模型类提供了默认的增删改查功能。 它继承自 GenericViewSet 、 ListModelMixin 、 RetrieveModelMixin 、 CreateModelMixin 、 UpdateModelMixin 、 DestoryModelMixin 。 知识点 请求 url 特点 GenericViewSet 提供一组通用的

    2024年02月08日
    浏览(42)
  • Django DRF - 【Token】认证基本使用

    Django Rest Framework Token 是Django Rest Framework中的一个扩展,用于实现用户认证和授权。它为每个用户生成一个唯一的Token,并将其存储在数据库中。在用户进行API请求时,用户需要在请求的HTTP Header中包含Token,这样服务器就可以验证用户的身份。 迁移完成会生成 authtoken_token 这张

    2024年02月12日
    浏览(36)
  • django框架向DRF框架演变过程详解

    主要知识点: Django框架 视图函数 1、在 Django 项目中创建一个应用(如果还没有创建): 2、在项目的 models.py 文件中定义项目模型 3、运行数据库迁移命令,以创建项目表: 4、在应用的 views.py 文件中编写视图函数来处理查询项目列表的请求: 5、在项目的 urls.py 文件中配置

    2024年02月16日
    浏览(40)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包