Zistite, ako efektívne aktivovať režim údržby vo vašej aplikácii Django a zároveň zabezpečiť bezproblémový zážitok pre vašich používateľov.

Uvedenie vašej aplikácie Django do režimu údržby je kľúčové pri vykonávaní aktualizácií, riešení technických problémov alebo pri vykonávaní významných zmien vo vašej aplikácii.

Dočasným obmedzením prístupu používateľov a zobrazením stránky údržby môžete komunikovať dôležité správy, zabezpečiť hladký proces aktualizácie a zabrániť potenciálnym konfliktom alebo strate údajov.

Či už ste vývojár alebo správca systému, pochopenie toho, ako implementovať režim údržby v Django, vám umožní udržiavať spoľahlivú a užívateľsky príjemnú aplikáciu.

Ako používať balík Django-Maintenance-Mode

Vďaka svojej rozsiahlej komunitnej podpore ponúka Django širokú škálu balíkov, ktoré môžu výrazne zlepšiť váš vývojový proces a umožňujú rýchlejšiu a efektívnejšiu prácu. Tieto balíky zmierňujú bremeno opakujúcich sa úloh a zaisťujú vám ako vývojárovi plynulejší zážitok.

Jedným z balíkov poskytovaných spoločnosťou Django je

instagram viewer
django-maintenance-mode balík, ktorý môžete použiť na uvedenie aplikácie Django do režimu údržby. The django-maintenance-mode balík funguje tak, že zobrazí stránku pre 503Stavový kód HTTP. Môžeš použiť django-maintenance-mode vo svojej aplikácii pomocou nasledujúcich krokov.

Krok 1: Nainštalujte Django-Maintenance-Mode vo vašom virtuálnom prostredí

  1. V tvojom virtuálne prostredie projektu, nainštalujte balík pomocou správcu balíkov pip Pythonu. Spustite tento príkaz vo svojom rozhranie príkazového riadka (CLI):
    pip install django-maintenance-mode
  2. Po nainštalovaní balíka pridajte režim údržby k INSTALLED_APPS zoznam vo vašom settings.py súbor:
    INSTALLED_APPS = [
    # niektoré ďalšie aplikácie,
    'režim údržby',
    ]
  3. Ďalej pridajte middleware pre django-maintenance-mode k MEDLEWARE zoznam vo vašom settings.py súbor:
    STREDNÝ SVÉR = [
    # nejaký ďalší middleware od djanga,
    'maintenance_mode.middleware. MaintenanceModeMiddleware',
    ]

Krok 2: Vytvorte HTML šablónu na zobrazenie správy o režime údržby

Pre django-maintenance-mode balík na zobrazenie chybovej stránky 503, hľadá a 503.html súbor šablóny v šablóny adresár. Ak to chcete nastaviť, postupujte takto:

  1. Vytvorte priečinok s názvom šablóny vo vašom koreňovom adresári.
  2. Otvorte svoj novovytvorený šablóny priečinok a vytvorte súbor s názvom 503.html.
  3. V tvojom settings.py súbor, nájdite súbor ŠABLÓNY nastavenia a nakonfigurujte DIRS zoznam v ňom takto:
    'DIRS': [BASE_DIR/'šablóny'],
  4. Otvor tvoj 503.html súbor a napíšte HTML kód, aby sa vašim používateľom zobrazilo chybové hlásenie. Tu je jednoduchý kód, ktorý môžete použiť:
    html>
    <html>
    <hlavu>
    <metaznakovú sadu="UTF-8">
    <titul>503 služba nedostupnátitul>
    <štýl>
     telo {
     rodina písiem: Arial, bezpätkové;
     farba pozadia: #f5f5f5;
     okraj: 0;
     výplň: 0;
     }

     .container-503 {
     max-width: 600px;
     okraj: 100px automaticky;
     text-align: center;
     }

     h1 {
     veľkosť písma: 48px;
     farba: #333333;
     margin-bottom: 20px;
     }

     p {
     veľkosť písma: 18px;
     farba: #666666;
     margin-bottom: 30px;
     }

     .btn-503 {
     displej: inline-block;
     výplň: 12px 24px;
     farba pozadia: #007bff;
     farba: #ffffff;
     textová výzdoba: žiadna;
     border-radius: 4px;
     veľkosť písma: 18px;
     }
    štýl>
    hlavu>
    <telo>
    <divtrieda = "kontajner-503">
    <h1>503 služba nedostupnáh1>
    <p>
     Ojoj! Momentálne pracujeme na niektorých aktualizáciách. 
     Ospravedlňujeme sa za nepríjemnosti a vážime si vašu trpezlivosť.
    p>
    <p>Navštívte webovú stránku neskôr alebo kontaktujte náš tím podporyp>
    <ahref = "mailto: [email protected]"trieda = "btn-503">
     Kontaktujte podporu
    a>
    div>
    telo>
    html>

Krok 3: Zapnite režim údržby a reštartujte server

V tvojom settings.py súbor, pridajte tento kód na zapnutie režimu údržby:

MAINTENANCE_MODE = Pravda

Reštartujte svoj vývojový server spustením tohto príkazu do CLI:

runserver python manage.py

Keď prejdete na svoj web, mali by ste vidieť stránku údržby, ktorú ste vytvorili.

Ako ignorovať stránku správcu v režime údržby Django

Ak chcete, aby vaša stránka správcu fungovala aj v režime údržby, django-maintenance-mode poskytuje nastavenie tzv MAINTENANCE_MODE_IGNORE_ADMIN_SITE. Toto nastavenie by ste mali pridať do svojho settings.py súbor a nastavte ho na Pravda:

MAINTENANCE_MODE_IGNORE_ADMIN_SITE = Pravda

Predvolená hodnota vyššie uvedeného nastavenia je Nepravdivé; preto bude vaša stránka správcu ovplyvnená stránkou režimu údržby, ak ju nenastavíte Pravda.

Ako ignorovať špecifické zobrazenie založené na funkciách v režime údržby Django

The django-maintenance-mode balík poskytuje dekoratér, ktorý zabráni určitému zobrazeniu alebo stránke – ako napr O stránku vášho webu – z prechodu do režimu údržby. Ak to chcete urobiť, najskôr importujte dekoratér do svojho views.py modul:

od údržba_režim.dekoratéri importovať force_maintenance_mode_off

Po importovaní dekoratér ho pridajte do zobrazenia takto:

@force_maintenance_mode_off
defview_name(žiadosť):
# vykonávať logiku zobrazenia
# nikdy nevráti odpoveď 503

Po správnej implementácii dekorátora bude adresa URL daného konkrétneho zobrazenia prístupná vašim používateľom.

Ako ignorovať špecifické zobrazenie podľa triedy v režime údržby Django

Ignorovanie zobrazenia založeného na triede je podobné ako ignorovanie zobrazenia založeného na funkciách. Najlepším prístupom je však urobiť to v urls.py súbor.

Najprv musíte importovať force_maintenance_mode_off dekoratér vo vašej aplikácii urls.py súbor. Potom ho musíte zahrnúť do svojej adresy URL. Tu je príklad:

od údržba_režim.dekoratéri importovať force_maintenance_mode_off
od .názory importovať YourView
urlpatterns = [
# nikdy nevráti odpoveď 503
 cesta ('', force_maintenance_mode_off (YourView.as_view()), name='môj názor'),
]

Uistite sa, že importujete aj ďalšie potrebné veci, napr cesta a váš pohľad na triedu.

Ako zapnúť režim údržby pre konkrétne zobrazenie založené na funkciách

  1. Ak chcete zapnúť režim údržby pre jedno zobrazenie, najskôr vypnite režim údržby vo svojom zariadení settings.py súbor takto:
    MAINTENANCE_MODE = Nepravdivé
  2. Ďalej vo vašom views.py, mali by ste importovať force_maintenance_mode_on dekoratér a pridajte si ho do zobrazenia:
    od údržba_režim.dekoratéri importovať force_maintenance_mode_on
    @force_maintenance_mode_on
    defview_name(žiadosť):
    # Vykonajte logiku zobrazenia
    # Vždy vrátiť odpoveď 503

Ako zapnúť režim údržby pre konkrétne zobrazenie podľa triedy

  1. Najprv by ste mali vo svojom zariadení vypnúť režim údržby settings.py súbor:
    MAINTENANCE_MODE = Nepravdivé
  2. Ďalej vo vašom urls.py, mali by ste importovať force_maintenance_mode_on dekoratér a pridajte ho do požadovanej adresy URL:
    od údržba_režim.dekoratéri importovať force_maintenance_mode_on
    od .názory importovať YourView
    urlpatterns = [
    # Vždy vrátiť odpoveď 503
     cesta ('', force_maintenance_mode_on (YourView.as_view()), name='môj názor'),
    ]

Ako použiť iný názov šablóny pre režim údržby Django

V predvolenom nastavení je django-maintenance-mode balík hľadá a templates/503.html šablóna. Môžete sa rozhodnúť prepísať to v settings.py súbor.

Predpokladajme, že máte samostatný priečinok na spracovanie chýb vo vašej aplikácii; budete chcieť zahrnúť svoje 503.html šablónu v tomto priečinku. Takže vaša šablóna bude in templates/errors/503.html.

Predvolené nastavenie pre túto konfiguráciu je toto:

MAINTENANCE_MODE_TEMPLATE = "503.html"

Ak ho chcete prepísať, mali by ste pridať inú cestu smerujúcu na vašu chybovú stránku. Tu je príklad:

MAINTENANCE_MODE_TEMPLATE = "errors/503.html"

Ak chcete, môžete tiež zmeniť názov súboru a všetko bude fungovať správne, ak pridáte potrebné konfigurácie.

Okrem vyššie uvedených konfigurácií, django-maintenance-mode balík poskytuje ďalšie zaujímavé konfigurácie, ktoré vám pomôžu prispôsobiť režim údržby vašej aplikácie vašim špecifickým potrebám. O týchto konfiguráciách si môžete prečítať v dokumentácia django-maintenance-mode.

Použite režim údržby na zabezpečenie plynulých aktualizácií a vylepšeného používateľského zážitku vo svojej aplikácii

Využitím režimu údržby vo vašej aplikácii môžete veci uľahčiť vám aj vašim používateľom. Dočasným zakázaním prístupu k celej svojej aplikácii alebo jej časti počas aktualizácií alebo úloh údržby môžete minimalizovať prerušenia a chyby, ktoré môžu vzniknúť v dôsledku súbežných interakcií používateľov.

Používanie režimu údržby vám nielen umožní efektívne vykonávať potrebné aktualizácie, ale tiež demonštruje záväzok poskytovať používateľom plynulý a neprerušovaný zážitok.

Okrem režimu údržby môžete v Django poskytnúť aj vlastné šablóny pre iné chyby.