“Используйте Django ListView и DetailView для легкого извлечения данных,
максимизируйте продуктивность разработки!”

В предыдущей статье мы рассмотрели базовые классы представления Django и FormView, теперь наступило время углубиться в более конкретные обобщенные представления (Generic Views).
ListView и DetailView особенно специализируются на ‘выводе данных’, помогая быстро реализовать страницы со списками и деталями с минимальными настройками.

1. Что такое ListView и DetailView?

  1. ListView

    • Предоставляет функцию отображения нескольких объектов из модели (Model) в виде списка.

    • Легко применяются функции пейджинга (Pagination), сортировки и поиска, что позволяет использовать их на большинстве “страниц списков”.

  2. DetailView

    • Отображает детальную информацию о конкретном объекте (например: пост, товар, пользователь и т.д.).

    • Находит соответствующий объект через URL-параметры или значение pk (первичный ключ) и может просто рендерить его в шаблоне.

Эти два класса являются частью обобщенных представлений от Django, представляя собой мощный инструмент для быстрого выполнения роли “Чтение” из CRUD.

2. Основная структура и использование ListView

Поток обработки ListView

2.1 Простой пример

# views.py
from django.views.generic import ListView
from .models import Post

class PostListView(ListView):
    model = Post
    template_name = 'post_list.html'
    context_object_name = 'posts'  # Имя переменной контекста, используемое в шаблоне (значение по умолчанию: object_list)
    # paginate_by = 10  # Количество отображаемых объектов на странице (по желанию)

    # (по желанию) Использовать get_queryset для дополнительных настроек queryset
    def get_queryset(self):
        # Например: хотите показать только последние записи?
        return Post.objects.order_by('-created_at')

  • model: Указывает, данные какого модели будут отображены.

  • template_name: Путь к файлу шаблона (значение по умолчанию: <app_name>/<model_name>_list.html).

  • context_object_name: Имя объекта контекста, используемого в шаблоне (значение по умолчанию: object_list).

  • paginate_by: Указывает количество объектов, отображаемых на одной странице (пейджинг).

2.2 Связывание ListView в urls.py

# urls.py
from django.urls import path
from .views import PostListView

urlpatterns = [
    path('posts/', PostListView.as_view(), name='post_list'),
]

2.3 Пример базового шаблона

<!-- post_list.html -->
<!DOCTYPE html>
<html>
<head>
    <title>Список постов</title>
</head>
<body>
    <h1>Список постов</h1>
    <ul>
        {% for post in posts %}
            <li>
                <a href="{% url 'post_detail' post.pk %}">{{ post.title }}</a>
            </li>
        {% endfor %}
    </ul>

    <!-- При реализации пейджинга -->
    {% if is_paginated %}
      <div>
        {% if page_obj.has_previous %}
          <a href="?page={{ page_obj.previous_page_number }}">Предыдущий</a>
        {% endif %}
        <span>Страница {{ page_obj.number }} / {{ page_obj.paginator.num_pages }}</span>
        {% if page_obj.has_next %}
          <a href="?page={{ page_obj.next_page_number }}">Следующий</a>
        {% endif %}
      </div>
    {% endif %}
</body>
</html>

Ключевые слова: “Автоматизация страниц списков”, “Пейджинг (Pagination)”, “Эффективный вывод данных”

3. Основная структура и использование DetailView

3.1 Простой пример

# views.py
from django.views.generic import DetailView
from .models import Post

class PostDetailView(DetailView):
    model = Post
    template_name = 'post_detail.html'
    context_object_name = 'post'  # Имя переменной контекста, используемое в шаблоне (значение по умолчанию: object)

    # (по желанию) Если хотите использовать другой идентификатор, а не pk, можно переопределить get_slug_field и др.

  • model: Извлекает единственный объект конкретной модели.

  • template_name: Путь к файлу шаблона (значение по умолчанию: <app_name>/<model_name>_detail.html).

  • context_object_name: Имя объекта контекста для использования в шаблоне (значение по умолчанию: object).

  • Если в шаблоне существует шаблон URL <int:pk>/ или <slug:slug>/, Django автоматически находит объект по этому значению.

3.2 Связывание DetailView в urls.py

# urls.py
from django.urls import path
from .views import PostDetailView

urlpatterns = [
    path('posts/<int:pk>/', PostDetailView.as_view(), name='post_detail'),
]

3.3 Пример базового шаблона

<!-- post_detail.html -->
<!DOCTYPE html>
<html>
<head>
    <title>{{ post.title }}</title>
</head>
<body>
    <h1>{{ post.title }}</h1>
    <p>Дата создания: {{ post.created_at }}</p>
    <div>
        {{ post.content }}
    </div>
    <a href="{% url 'post_list' %}">Вернуться к списку</a>
</body>
</html>

4. Расширение ListView и DetailView

4.1 get_queryset, get_context_data

get_queryset(): Вы можете настроить queryset по желаемым условиям.
Например: список постов, доступных только определённому пользователю, фильтрация по ключевым словам, сортировка по определённому полю и т.д.

def get_queryset(self):
    queryset = super().get_queryset()
    return queryset.filter(is_active=True)

get_context_data(): Вы можете добавить дополнительные данные, которые будут переданы в шаблон.

def get_context_data(self, **kwargs):
    context = super().get_context_data(**kwargs)
    context['extra_info'] = 'Дополнительная информация'
    return context

4.2 slug, собственный поиск

DetailView может использовать slug вместо pk (короткий текстовый идентификатор), и вы также можете указать slug_field, slug_url_kwarg для настройки пользовательских конфигураций.

class PostDetailView(DetailView):
    model = Post
    slug_field = 'slug'           # Имя поля slug в модели
    slug_url_kwarg = 'slug'       # Имя параметра, получаемого из шаблона URL

4.3 Комбинирование с Mixin

  • LoginRequiredMixin или PermissionRequiredMixin могут облегчить управление доступом к страницам списков и деталям.

  • Вы можете создать пользовательский Mixin, такой как SearchMixin, для обработки параметров запроса, которые можно будет повторно использовать среди нескольких ListView.

5. Простой практический пример: Реализация функционала доски объявлений

Основываясь на примере модели Post, рассмотренной в предыдущей статье, давайте одновременно реализуем список + детализированное представление.

# models.py
class Post(models.Model):
    title = models.CharField(max_length=200)
    content = models.TextField()
    created_at = models.DateTimeField(auto_now_add=True)
    slug = models.SlugField(unique=True)  # Пример использования slug

    def __str__(self):
        return self.title

# views.py
from django.views.generic import ListView, DetailView
from .models import Post

class PostListView(ListView):
    model = Post
    template_name = 'post_list.html'
    context_object_name = 'posts'
    paginate_by = 5  # Разделение на страницы по 5 постов

    def get_queryset(self):
        # допустим, мы хотим показывать только активные посты
        return Post.objects.filter(is_active=True).order_by('-created_at')

class PostDetailView(DetailView):
    model = Post
    template_name = 'post_detail.html'
    context_object_name = 'post'
    slug_field = 'slug'
    slug_url_kwarg = 'slug'

# urls.py
urlpatterns = [
    path('posts/', PostListView.as_view(), name='post_list'),
    path('posts/<slug:slug>/', PostDetailView.as_view(), name='post_detail'),
]

  • Страница списка: Вы можете проверять список изменяя номер страницы, например: /posts/?page=2.

  • Страница деталей: Используйте путь posts/<slug>/ для поиска конкретного поста и его отображения в шаблоне.

6. Сравнение с FBV: насколько легко реализовать список/детали?

Категория FBV (функции на основе представления) ListView/DetailView (CBV)
Структура кода Каждую функцию списка/деталей нужно писать отдельно, реализация пейджинга и сортировки осуществляется вручную Легкая настройка списка, пейджинга, сортировки и поиска с помощью простых атрибутов
Читаемость/Удобство обслуживания Условия и циклы перемешаны на нескольких уровнях, что усложняет код по мере увеличения проекта Логика списков/деталей отделена, что делает поддержку кода более удобной благодаря четкому расширению (переопределению методов)
Продуктивность разработки (Ключевые слова) “Увеличение дублирования кода, затраты времени” “Сокращение времени разработки, повышение производительности”
Передача данных в шаблон Требуется вручную собирать словарь контекста и передавать его в метод render Контекст (object_list, object) передается автоматически. Дополнительные данные также легко обрабатываются в get_context_data
Расширенные функции, такие как пейджинг и поиск Требуется написание отдельной логики Легко активируется с помощью уже встроенных функций и атрибутов

FBV против DetailView – упрощенный просмотр объектов

7. Заключение и анонс следующей статьи

Django ListView и DetailView значительно упрощают реализацию “списков данных” и “страниц деталей”.
Автоматизация таких часто используемых функций, как пейджинг, добавление контекстных данных, извлечение объектов по URL-параметрам, дает большие преимущества в повторном использовании кода и продуктивности разработки.

Серия CBV (Class-Based View) продолжается!
В следующей статье мы рассмотрим, как легко реализовать логику CRUD с помощью CreateView, UpdateView, DeleteView.

Посмотреть предыдущие статьи

  1. Исследование класса представления на основе классов (CBV) #1 – Почему переходить с FBV на CBV и какое отношение у разработчика к этому

  2. Исследование класса представления на основе классов (CBV) #2 – Понимание основных классов представления Django

  3. Исследование класса представления на основе классов (CBV) #3 – Легкая обработка форм с FormView

“Используйте ListView и DetailView Django для
быстрого извлечения данных, простоты разработки и повышения продуктивности!”