Многостраничный макет Dash

В современной разработке веб-приложений одностраничные приложения (SPA) и многостраничные приложения (MPA) — это два распространённых архитектурных шаблона.

Одностраничные приложения обычно обеспечивают плавный пользовательский опыт за счёт динамической загрузки контента, тогда как многостраничные приложения организуют контент через несколько независимых страниц.

Одностраничное приложение против многостраничного приложения

В одностраничных приложениях весь контент динамически загружается и обновляется на одной странице, а пользователи переключаются между различными представлениями, нажимая ссылки или кнопки. Преимущество этой архитектуры — плавный пользовательский опыт и быстрая загрузка страниц, но недостаток в том, что по мере роста масштаба приложения структура кода может усложниться.

Многостраничные приложения организуют контент через несколько независимых страниц, каждая из которых имеет собственный URL и макет. Преимущество этой архитектуры — чёткая структура кода и простота сопровождения, но недостаток в том, что при переключении страниц возникает определённая задержка загрузки.


Реализация многостраничного макета в Dash

Реализовать многостраничный макет в Dash можно с помощью компонентов dcc.Location и dcc.Link.

dcc.Location используется для отслеживания URL текущей страницы, а dcc.Link — для навигации между страницами. Комбинируя функции обратного вызова, можно динамически загружать различное содержимое страниц на основе URL.

  • Использованиеdcc.Locationиdcc.LinkМногостраничный макет можно реализовать.

  • С помощью функций обратного вызова, на основеpathnameдинамически загружать содержимое страницы.

  • Комбинируя модульные макеты и параметры URL, можно создавать более сложные многостраничные приложения.

Базовая структура многостраничного макета

Основная идея многостраничного макета — динамически загружать различное содержимое страниц на основе pathname URL.

Ниже приведены основные шаги реализации многостраничного макета:

Определите макет страницы:

  • Макет каждой страницы можно определить как функцию или переменную.

  • Например,home_layoutПредставляет главную страницу,about_layoutПредставляет страницу About.

Использованиеdcc.Location:

  • dcc.LocationКомпонент используется для отслеживания URL текущей страницы.

  • ЧерезpathnameСвойство получает путь текущей страницы.

Использованиеdcc.Link:

  • dcc.LinkКомпонент используется для создания ссылок навигации по страницам.

  • ЧерезhrefСвойство указывает путь целевой страницы.

Динамическая загрузка содержимого страницы:

  • Используйте функции обратного вызова для динамического возврата соответствующего макета страницы на основеpathnameдинамически возвращает соответствующий макет страницы.

Пример

from dash import Dash, html, dcc, Ввод, Вывод

# Создать приложение Dash
app = Dash(__name__)

app.layout = html.Div([
    dcc.Location(id='url', refresh=False),
    html.Div(id='page-content')
])

В приведённом выше коде,dcc.LocationкомпонентаidУстановить вurl,refreshПараметр установлен вFalseУказывает, что страница не обновляется при изменении URL.html.Div(id='page-content')Это заполнитель, используемый для отображения содержимого разных страниц.

Определите макет страницы

Далее нам нужно определить макеты разных страниц. Каждый макет страницы может быть независимой функцией или переменной. Например, мы можем определить два макета страниц:index_pageиpage1。

Пример

index_page = html.Div([
    html.H1("Главная"),
    dcc.Link('Перейти на страницу 1', href='/page1')
])

page1 = html.Div([
    html.H1("Страница 1"),
    dcc.Link('Назад на главную', href='/')
])

В приведённом выше коде,index_page— это макет главной страницы, содержащий заголовок и ссылку; нажатие на ссылку выполняет переход кpage1。page1— это макет страницы 1, также содержащий заголовок и ссылку обратно на главную страницу.

Динамическая загрузка макета страницы

Наконец, нам нужно использовать функцию обратного вызова, чтобы динамически загружать разные макеты страниц на основе изменений URL. Функция обратного вызова определяет на основеdcc.Locationкомпонентаpathnameатрибута, какой макет страницы отображать.

Пример

@app.callback(Output('page-content', 'children'),
              [Input('url', 'pathname')])
def display_page(pathname):
    if pathname == '/page1':
        return page1
    else:
        return index_page

В приведённом выше коде,display_pageФункция получаетpathnameв качестве входных данных и на основеpathnameвозвращает соответствующий макет страницы. ЕслиpathnameДа/page1, то возвращаетpage1макет; иначе возвращаетindex_pageмакет.

Полный пример

Ниже приведён полный пример многостраничного макета Dash, включающий главную страницу, страницу «О нас» и страницу 404.

Пример

from dash import Dash, html, dcc, Ввод, Вывод

# Создать приложение Dash
app = Dash(__name__)

# Определяем макет главной страницы
home_layout = html.Div([
    html.H1("Главная"),
    html.P("Добро пожаловать на главную страницу!"),
    dcc.Link(Перейти на страницу About, href='/about')
])

# Определить макет страницы About
about_layout = html.Div([
    html.H1("О нас"),
    html.P(Это содержимое страницы About.),
    dcc.Link('Вернуться на главную страницу', href='/')
])

# Определить макет страницы 404
not_found_layout = html.Div([
    html.H1("404 - Страница не найдена"),
    html.P(Страница, которую вы посетили, не существует.),
    dcc.Link('Вернуться на главную страницу', href='/')
])

# Определить макет приложения
app.layout = html.Div([
    dcc.Location(id='url', refresh=False),  # Используется для отслеживания URL
    html.Div(id='page-content')  # Используется для динамической загрузки содержимого страницы
])

# Определить функцию обратного вызова
@app.callback(
    Output('page-content', 'children'),  # Output в свойство children элемента Div с id 'page-content'
    Input('url', 'pathname')  # Input поступает из свойства pathname компонента Location с id 'url'
)
def display_page(pathname):
    if pathname == '/':
        return home_layout  # Показать главную страницу
    elif pathname == '/about':
        return about_layout  # Отобразить страницу About
    else:
        return not_found_layout  # Отобразить страницу 404

# Запустить приложение
if __name__ == '__main__':
    app.run_server(debug=True)

После запуска приложения откройтеhttp://127.0.0.1:8050/Вы можете увидеть содержимое главной страницы, нажмите"Перейти на страницу About"Ссылка может перейти на страницу About; нажатие"Назад на главную"Ссылка может вернуть на главную страницу.

Пояснение кода

Макет страницы:

  • home_layout: Макет главной страницы, содержащий заголовок, описание и ссылку на страницу About.

  • about_layout: Макет страницы about, содержащей заголовок, описание и ссылку на главную страницу.

  • not_found_layout: Макет страницы 404, используемый для обработки несуществующих путей.

dcc.Location:

  • id='url': Используется для отслеживания URL текущей страницы.

  • refresh=False: Отключает обновление страницы для достижения эффекта одностраничного приложения (SPA).

dcc.Link:

  • используется для создания навигационных ссылок между страницами,hrefСвойство указывает путь целевой страницы.

функция обратного вызова:

  • Согласноpathnameдинамически возвращает соответствующий макет страницы на основе значения.

  • Если путь/, возвращаетhome_layout。

  • Если путь/about, возвращаетabout_layout。

  • Если путь не совпадает, вернутьnot_found_layout。


Расширения

Для более сложных многостраничных приложений можно комбинировать следующие методы для оптимизации структуры кода:

1. Используйте модульный макет

Определите макет каждой страницы в отдельном модуле для упрощения поддержки и расширения.

Создайте pages/home.py:

Пример

from dash import html, dcc

layout = html.Div([
    html.H1("Главная"),
    html.P("Добро пожаловать на главную страницу!"),
    dcc.Link(Перейти на страницу About, href='/about')
])

Создайте pages/about.py:

Пример

from dash import html, dcc

layout = html.Div([
    html.H1("О нас"),
    html.P(Это содержимое страницы About.),
    dcc.Link('Вернуться на главную страницу', href='/')
])

Импортируйте layout в главном приложении:

from pages.home import layout as home_layout
from pages.about import layout as about_layout

2. Используйте параметры URL

Передавайте параметры URL через свойство `search` или `pathname` объекта `dcc.Location`, чтобы реализовать более гибкую логику страниц.

Пример

@app.callback(
    Output('page-content', 'children'),
    Input('url', 'pathname')
)
def display_page(pathname):
    if pathname == '/':
        return home_layout
    elif pathname.startswith('/about'):
        # Разобрать параметры URL
        return about_layout
    else:
        return not_found_layout
Другие расширения