Научете как ефективно да активирате режима на поддръжка на вашето приложение Django, като същевременно осигурите безпроблемно изживяване за вашите потребители.

Поставянето на вашето приложение Django в режим на поддръжка е от решаващо значение, когато извършвате актуализации, разрешавате технически проблеми или правите значителни промени в приложението си.

Чрез временно ограничаване на потребителския достъп и показване на страница за поддръжка можете да комуникирате важни съобщения, да осигурите плавен процес на актуализиране и да предотвратите потенциални конфликти или загуба на данни.

Независимо дали сте разработчик или системен администратор, разбирането как да внедрите режим на поддръжка в Django ще ви позволи да поддържате надеждно и удобно за потребителя приложение.

Как да използвате пакета Django-Maintenance-Mode

Благодарение на широката си поддръжка от общността, Django предлага широка гама от пакети, които могат значително да подобрят процеса на разработка, позволявайки по-бърза и по-ефективна работа. Тези пакети облекчават тежестта на повтарящите се задачи, като осигуряват по-плавно изживяване за вас като разработчик.

instagram viewer

Един от пакетите, предоставени от Django, е django-режим на поддръжка пакет, който можете да използвате, за да поставите вашето приложение Django в режим на поддръжка. The django-режим на поддръжка пакетът работи, като показва страница за 503HTTP код на състоянието. Можеш да използваш django-режим на поддръжка във вашето приложение със следните стъпки.

Стъпка 1: Инсталирайте Django-Maintenance-Mode във вашата виртуална среда

  1. Във вашия виртуалната среда на проекта, инсталирайте пакета с мениджъра на pip пакети на Python. Изпълнете тази команда във вашия интерфейс на командния ред (CLI):
    pip инсталира django-maintenance-mode
  2. След като инсталирате пакета, добавете режим на поддръжка към INSTALLED_APPS списък във вашия settings.py файл:
    INSTALLED_APPS = [
    # някои други приложения,
    'режим на поддръжка',
    ]
  3. След това добавете междинния софтуер за django-режим на поддръжка към МЕЖДУНАРОДЕН ПРОДУКТ списък във вашия settings.py файл:
    MIDDLEWARE = ​​[
    # друг мидълуер от django,
    'maintenance_mode.middleware. MaintenanceModeMiddleware',
    ]

Стъпка 2: Създайте HTML шаблон за показване на съобщението за режим на поддръжка

За django-режим на поддръжка пакет за показване на страница с грешка 503, той търси a 503.html шаблонен файл в шаблони указател. За да настроите това, направете следното:

  1. Създайте папка, наречена шаблони във вашата основна директория.
  2. Отворете новосъздадения шаблони папка и създайте файл, наречен 503.html.
  3. Във вашия settings.py файл, намерете ШАБЛОНИ настройки и конфигурирайте DIRS списък в него така:
    „DIRS“: [BASE_DIR/"шаблони"],
  4. Отвори си 503.html файл и напишете HTML кода, за да изведете съобщение за грешка на вашите потребители. Ето прост код, който можете да използвате:
    html>
    <html>
    <глава>
    <метанабор от знаци="UTF-8">
    <заглавие>503 Услугата не е достъпназаглавие>
    <стил>
     тяло {
     семейство шрифтове: Arial, sans-serif;
     цвят на фона: #f5f5f5;
     марж: 0;
     подплата: 0;
     }

     .container-503 {
     максимална ширина: 600px;
     поле: 100px автоматично;
     подравняване на текст: център;
     }

     h1 {
     размер на шрифта: 48px;
     цвят: #333333;
     margin-bottom: 20px;
     }

     p {
     размер на шрифта: 18px;
     цвят: #666666;
     margin-bottom: 30px;
     }

     .btn-503 {
     дисплей: inline-block;
     подложка: 12px 24px;
     цвят на фона: #007bff;
     цвят: #ffffff;
     текст-декорация: няма;
     радиус на границата: 4px;
     размер на шрифта: 18px;
     }
    стил>
    глава>
    <тяло>
    <дивклас = "контейнер-503">
    <h1>503 Услугата не е достъпнаh1>
    <стр>
     Опа! В момента работим върху някои актуализации. 
     Извиняваме се за неудобството и оценяваме търпението ви.
    стр>
    <стр>Моля, посетете уебсайта по-късно или се свържете с нашия екип за поддръжкастр>
    <аhref = "mailto: [email protected]"клас = "btn-503">
     Свържете се с поддръжката
    а>
    див>
    тяло>
    html>

Стъпка 3: Включете режима на поддръжка и рестартирайте вашия сървър

Във вашия settings.py файл, добавете този код, за да включите режима на поддръжка:

MAINTENANCE_MODE = Вярно

Рестартирайте вашия сървър за разработка, като стартирате това във вашия CLI:

python manage.py runserver

Когато навигирате до уебсайта си, трябва да видите създадената от вас страница за поддръжка.

Как да игнорирате администраторския сайт в режим на поддръжка на Django

За да позволите на вашия администраторски сайт да продължи да функционира дори в режим на поддръжка, the django-режим на поддръжка предоставя настройка, наречена MAINTENANCE_MODE_IGNORE_ADMIN_SITE. Трябва да добавите тази настройка във вашия settings.py файл и го настройте на Вярно:

MAINTENANCE_MODE_IGNORE_ADMIN_SITE = Вярно

Стойността по подразбиране на горната настройка е Невярно; следователно вашият администраторски сайт ще бъде засегнат от страницата за режим на поддръжка, ако не го зададете Вярно.

Как да игнорирате изглед, базиран на специфична функция в режим на поддръжка на Django

The django-maintenence-mode пакетът предоставя декоратор за предотвратяване на определен изглед или страница - като например относно страница на вашия сайт—от преминаване в режим на поддръжка. За да направите това, първо импортирайте декоратора във вашия views.py модул:

от supporting_mode.decorators импортиране force_maintenance_mode_off

След като импортирате декоратора, добавете го към вашия изглед по следния начин:

@force_maintenance_mode_off
дефиме_на изглед(заявка):
# изпълнение на логика за изглед
# никога не връща 503 отговор

След правилното внедряване на декоратора, URL адресът за този конкретен изглед ще стане достъпен за вашите потребители.

Как да игнорирате конкретен изглед, базиран на клас, в режим на поддръжка на Django

Игнорирането на изглед, базиран на клас, е подобно на игнорирането на изглед, базиран на функция. Най-добрият подход обаче е да го направите в urls.py файл.

Първо, трябва да импортирате force_maintenance_mode_off декоратор в приложението ви urls.py файл. След това трябва да го включите във вашия URL път. Ето един пример:

от supporting_mode.decorators импортиране force_maintenance_mode_off
от .изгледи импортиране YourView
urlpatterns = [
# никога не връща 503 отговор
 път ('', force_maintenance_mode_off (YourView.as_view()), name='my_view'),
]

Уверете се, че импортирате и други необходими неща като път и вашия базиран на клас изглед.

Как да включите режима на поддръжка за изглед, базиран на специфични функции

  1. За да включите режима на поддръжка за един изглед, първо изключете режима на поддръжка във вашия settings.py файл, като направите това:
    MAINTENANCE_MODE = Невярно
  2. Следваща, във вашия views.py, трябва да импортирате force_maintenance_mode_on декоратор и го добавете към вашия изглед:
    от supporting_mode.decorators импортиране force_maintenance_mode_on
    @force_maintenance_mode_on
    дефиме_на изглед(заявка):
    # Изпълнение на логиката на изгледа
    # Винаги връщайте отговор 503

Как да включите режима на поддръжка за конкретен изглед, базиран на клас

  1. Първо, трябва да изключите режима на поддръжка във вашия settings.py файл:
    MAINTENANCE_MODE = Невярно
  2. Следваща, във вашия urls.py, трябва да импортирате force_maintenance_mode_on декоратор и го добавете към необходимия URL път:
    от supporting_mode.decorators импортиране force_maintenance_mode_on
    от .изгледи импортиране YourView
    urlpatterns = [
    # Винаги връщайте отговор 503
     път ('', force_maintenance_mode_on (YourView.as_view()), name='my_view'),
    ]

Как да използвате различно име на шаблон за режим на поддръжка на Django

По подразбиране, django-режим на поддръжка пакетът търси a templates/503.html шаблон. Можете да решите да отмените това в settings.py файл.

Да предположим, че имате отделна папка за обработка на грешки във вашето приложение; ще искате да включите своя 503.html шаблон в тази папка. Така че вашият шаблон ще бъде вътре templates/errors/503.html.

Настройката по подразбиране за тази конфигурация е следната:

MAINTENANCE_MODE_TEMPLATE = "503.html"

За да го замените, трябва да добавите различен път, сочещ към вашата страница за грешка. Ето един пример:

MAINTENANCE_MODE_TEMPLATE = "грешки/503.html"

Можете също да промените името на файла, ако искате, и всичко ще работи добре, ако добавите необходимите конфигурации.

Освен горните конфигурации, django-режим на поддръжка пакетът предоставя други интересни конфигурации, за да ви помогне да персонализирате режима на поддръжка на вашето приложение според вашите специфични нужди. Можете да прочетете за тези конфигурации в django-maintenance-mode документация.

Използвайте режим на поддръжка, за да осигурите безпроблемни актуализации и подобрено потребителско изживяване във вашето приложение

Използването на режим на поддръжка във вашето приложение може да улесни нещата за вас и вашите потребители. Като временно деактивирате достъпа до цялото или част от вашето приложение по време на актуализации или задачи по поддръжка, можете да сведете до минимум смущенията и грешките, които могат да възникнат от едновременни потребителски взаимодействия.

Използването на режим на поддръжка не само ще ви позволи да извършвате необходимите актуализации ефективно, но също така демонстрира ангажимент за осигуряване на безпроблемно и непрекъснато изживяване за вашите потребители.

Освен режим на поддръжка, можете също да предоставите персонализирани шаблони за други грешки в Django.