Django ListView - 用于过滤和排序的表单

Django

使用 Django 开发 Web 应用时，经常需要使用 ListView 来展示数据库中的数据。ListView 是 Django 中的通用视图之一，它可以方便地展示一个模型的对象列表，并且支持过滤和排序。本文将介绍如何在 Django 的 ListView 中使用表单来实现过滤和排序的功能。

在 Django 中，可以通过继承 ListView 类来创建一个展示对象列表的视图。首先，我们需要在 views.py 中导入必要的模块和类：

Python
from Django.views.generic import ListView
from .models import YourModel

接下来，我们需要定义一个继承自 ListView 的类，并指定需要展示的模型和模板：

Python
class YourListView(ListView):
    model = YourModel
    template_name = 'your_template.html'

在模板中，我们可以使用 {{ object_list }} 变量来获取模型的对象列表。但是，如果我们希望对对象列表进行过滤和排序，我们就需要使用表单来实现。

首先，在 forms.py 中定义一个表单类，用于接收用户的过滤和排序参数：

Python
from Django import forms
class YourForm(forms.Form):
    filter_field = forms.CharField(required=False)
    sort_field = forms.CharField(required=False)

在表单类中，我们定义了两个字段，分别用于接收过滤和排序的参数。这两个字段都设置为非必填字段，以保证用户可以选择性地进行过滤和排序。

接下来，我们需要在视图类中重载 get_queryset() 方法，根据用户提交的表单数据来动态地生成查询集：

Python
class YourListView(ListView):
    model = YourModel
    template_name = 'your_template.html'
    form_class = YourForm
    def get_queryset(self):
        queryset = super().get_queryset()
        form = self.form_class(self.request.GET)
        if form.is_valid():
            filter_field = form.cleaned_data['filter_field']
            sort_field = form.cleaned_data['sort_field']
            if filter_field:
                queryset = queryset.filter(your_filter_field=filter_field)
            if sort_field:
                queryset = queryset.order_by(sort_field)
        return queryset

在 get_queryset() 方法中，我们首先调用父类的 get_queryset() 方法获取原始的查询集，然后根据用户提交的表单数据进行过滤和排序。如果用户提交的表单数据有效，我们就根据用户选择的过滤和排序字段对查询集进行相应的处理。

现在，我们已经完成了在 ListView 中使用表单来实现过滤和排序的功能。在模板中，我们可以使用表单的字段来生成对应的输入框，供用户输入过滤和排序的参数。当用户提交表单时，ListView 会自动根据表单数据重新生成查询集，并渲染模板。

下面是一个简单的示例，展示如何在 ListView 中使用表单来实现过滤和排序的功能：

Python
# views.py
from Django.views.generic import ListView
from .models import Book
from .forms import BookFilterForm
class BookListView(ListView):
    model = Book
    template_name = 'book_list.html'
    form_class = BookFilterForm
    def get_queryset(self):
        queryset = super().get_queryset()
        form = self.form_class(self.request.GET)
        if form.is_valid():
            filter_title = form.cleaned_data['filter_title']
            sort_field = form.cleaned_data['sort_field']
            if filter_title:
                queryset = queryset.filter(title__icontAIns=filter_title)
            if sort_field:
                queryset = queryset.order_by(sort_field)
        return queryset

html
<!-- book_list.html -->
<form method="get">
  {{ form.as_p }}
  <button type="submit">筛选</button>
</form>
<ul>
  {% for book in object_list %}
    <li>{{ book.title }}</li>
  {% empty %}
    <li>没有找到符合条件的书籍。</li>
  {% endfor %}
</ul>

在上述示例中，我们通过 BookFilterForm 表单类来接收用户的过滤和排序参数。用户可以在模板中输入书籍的标题进行过滤，并选择一个字段进行排序。当用户提交表单后，ListView 会根据表单数据重新生成查询集，并在模板中展示符合条件的书籍列表。

案例代码

Python
# views.py
from Django.views.generic import ListView
from .models import Book
from .forms import BookFilterForm
class BookListView(ListView):
    model = Book
    template_name = 'book_list.html'
    form_class = BookFilterForm
    def get_queryset(self):
        queryset = super().get_queryset()
        form = self.form_class(self.request.GET)
        if form.is_valid():
            filter_title = form.cleaned_data['filter_title']
            sort_field = form.cleaned_data['sort_field']
            if filter_title:
                queryset = queryset.filter(title__icontAIns=filter_title)
            if sort_field:
                queryset = queryset.order_by(sort_field)
        return queryset

html
<!-- book_list.html -->
<form method="get">
  {{ form.as_p }}
  <button type="submit">筛选</button>
</form>
<ul>
  {% for book in object_list %}
    <li>{{ book.title }}</li>
  {% empty %}
    <li>没有找到符合条件的书籍。</li>
  {% endfor %}
</ul>

在上述示例中，我们通过 BookFilterForm 表单类来接收用户的过滤和排序参数。用户可以在模板中输入书籍的标题进行过滤，并选择一个字段进行排序。当用户提交表单后，ListView 会根据表单数据重新生成查询集，并在模板中展示符合条件的书籍列表。