Django 搜索使用 Django Filter

在本文中，我们将介绍如何在 Django 中使用 Django Filter 进行搜索。Django Filter 是一个强大的库，可以帮助我们构建和处理搜索查询。

简介

Django 是一个流行的 Python Web 框架，用于快速开发高质量的 Web 应用程序。它提供了许多强大的功能，其中之一就是搜索功能。Django Filter 则是一个用于处理搜索查询的库，可以轻松地过滤和排序查询集。

安装

首先，我们需要安装 Django Filter。可以通过以下命令使用 pip 来完成安装：

pip install django-filter

安装完成之后，我们需要将 django_filter 添加到 Django 项目的 INSTALLED_APPS 配置中：

INSTALLED_APPS = [
    ...
    'django_filters',
    ...
]

接下来，我们需要运行 makemigrations 命令和 migrate 命令，以创建和应用与 Django Filter 相关的数据库迁移。

创建 Filters

使用 Django Filter 进行搜索的第一步是创建一个过滤器。过滤器类定义了我们想要过滤的字段和规则。

在 Django 中，我们可以通过继承 FilterSet 类来创建过滤器。以下是一个示例：

from django_filters import FilterSet, CharFilter, NumberFilter

from .models import Product

class ProductFilter(FilterSet):
    name = CharFilter(lookup_expr='icontains')
    price = NumberFilter(lookup_expr='lte')

    class Meta:
        model = Product
        fields = ['name', 'price']

在上面的示例中，我们创建了一个名为 ProductFilter 的过滤器类，并定义了两个过滤字段 name 和 price。name 字段使用 icontains 查找表达式，这意味着我们将使用大小写不敏感的方式在 name 字段中搜索指定的值。price 字段使用 lte 查找表达式，这意味着我们将搜索价格小于或等于指定值的产品。

在过滤器类中，我们还需要指定我们要过滤的模型。在这个例子中，我们过滤的是 Product 模型。

应用 Filters

一旦我们创建了过滤器类，我们就可以在视图中使用它。在 Django 中，视图函数负责处理用户请求并生成响应。

以下是一个使用过滤器进行搜索的示例视图函数：

from django.shortcuts import render
from django_filters.views import FilterView

from .filters import ProductFilter
from .models import Product

class ProductListView(FilterView):
    model = Product
    template_name = 'product_list.html'
    filterset_class = ProductFilter
    paginate_by = 20

在上面的例子中，我们创建了一个名为 ProductListView 的视图类，并设置了以下属性：
– model：指定要使用的模型；
– template_name：指定要渲染的模板文件；
– filterset_class：指定要使用的过滤器类；
– paginate_by：指定每页显示的数量。

以上设置将帮助我们将搜索结果进行分页并渲染到模板中。

设置视图和模板

我们还需要设置视图函数对应的 URL，并创建一个模板来显示搜索结果。

在 Django 中，我们可以通过将视图函数与 URL 关联来设置 URL。以下是一个示例 URL 配置：

from django.urls import path

from .views import ProductListView

urlpatterns = [
    path('products/', ProductListView.as_view(), name='product_list'),
]

在上面的例子中，我们为视图函数 ProductListView 设置了一个 URL，该 URL 包含了 /products/。

接下来，我们需要创建一个模板来显示搜索结果。以下是一个简单的模板示例：

{% extends 'base.html' %}

{% block content %}
    <h1>搜索产品</h1>

    <form method="get">
        {{ filter.form.as_p }}

        <button type="submit">搜索</button>
    </form>

    <table>
        <thead>
            <tr>
                <th>名称</th>
                <th>价格</th>
            </tr>
        </thead>
        <tbody>
            {% for product in filter.qs %}
                <tr>
                    <td>{{ product.name }}</td>
                    <td>{{ product.price }}</td>
                </tr>
            {% empty %}
                <tr>
                    <td colspan="2">没有找到相关产品。</td>
                </tr>
            {% endfor %}
        </tbody>
    </table>

    {% if filter.page_obj.has_previous %}
        <a href="?{{ filter.page_obj.previous_page_number }}">上一页</a>
    {% endif %}

    <span>{{ filter.page_obj.number }}</span>

    {% if filter.page_obj.has_next %}
        <a href="?{{ filter.page_obj.next_page_number }}">下一页</a>
    {% endif %}
{% endblock %}

在上面的模板示例中，我们使用了 Django Filter 提供的一些内置函数和变量来处理搜索查询。filter.form.as_p 用于渲染过滤器表单，filter.qs 用于获取过滤器后的查询集，filter.page_obj 用于获取分页对象。