Sdílet prostřednictvím


Kurz: Začínáme s webovou architekturou Django v sadě Visual Studio

Django je vysokoúrovňová architektura Pythonu navržená pro rychlý, zabezpečený a škálovatelný vývoj webů. V tomto kurzu se seznámíte s architekturou Django v kontextu šablon projektů. Visual Studio poskytuje šablony projektů, které zjednoduší vytváření webových aplikací založených na Django.

V tomto kurzu se naučíte:

  • Vytvořte základní projekt Django v úložišti Git pomocí šablony Prázdný webový projekt Django (krok 1).
  • Vytvořte aplikaci Django s jednou stránkou a vykreslujte ji pomocí šablony (krok 2).
  • Obsluha statických souborů, přidání stránek a použití dědičnosti šablon (krok 3)
  • Pomocí šablony Webového projektu Django vytvořte aplikaci s více stránkami a responzivním návrhem (krok 4).
  • Ověření uživatelů (krok 5)

Požadavky

  • Visual Studio 2017 nebo novější ve Windows s následujícími možnostmi:
    • Úloha vývoje v Pythonu (karta Úlohy v instalačním programu) Pokyny najdete v tématu Instalace podpory Pythonu v sadě Visual Studio.
    • Git pro Windows a rozšíření GitHubu pro Visual Studio na kartě Jednotlivé komponenty v části Nástroje kódu
  • Visual Studio 2022 ve Windows s následujícími možnostmi:

Šablony projektů Django také obsahují starší verze nástrojů Python Tools pro Visual Studio. Podrobnosti o šabloně se můžou lišit od toho, co je popsáno v tomto kurzu (zejména u dřívějších verzí rozhraní Django).

Vývoj v pythonu se v Visual Studio pro Mac nepodporuje. V systému Mac a Linux použijte rozšíření Pythonu v editoru Visual Studio Code.

Projekty sady Visual Studio a Projekty Django

V terminologii Django má projekt Django několik konfiguračních souborů na úrovni webu spolu s jednou nebo více "aplikacemi". Pokud chcete vytvořit úplnou webovou aplikaci, můžete tyto aplikace nasadit na webového hostitele. Projekt Django může obsahovat více aplikací a stejná aplikace může být ve více projektech Django.

Projekt sady Visual Studio může obsahovat projekt Django spolu s více aplikacemi. Vždy, když tento kurz odkazuje jen na "projekt", odkazuje na projekt sady Visual Studio. Pokud odkazuje na část "Projekt Django" webové aplikace, odkazuje konkrétně na "projekt Django".

V průběhu tohoto kurzu vytvoříte jedno řešení sady Visual Studio, které obsahuje tři samostatné projekty Django. Každý projekt obsahuje jednu aplikaci Django. Mezi různými soubory pro porovnání můžete snadno přepínat tak, že projekty ponecháte ve stejném řešení.

Krok 1–1: Vytvoření projektu a řešení sady Visual Studio

Při práci s Django z příkazového řádku obvykle spustíte projekt spuštěním django-admin startproject <project_name> příkazu. V sadě Visual Studio poskytuje šablona Prázdný webový projekt Django stejnou strukturu v rámci projektu a řešení sady Visual Studio.

  1. V sadě Visual Studio vyberte Soubor>nový>projekt, vyhledejte Django a vyberte prázdnou šablonu webového projektu Django. (Šablonu najdete také v části Web Pythonu>v levém seznamu.)

    New project dialog in Visual Studio for the Blank Django Web Project

  2. Do polí v dolní části dialogového okna zadejte následující informace (jak je znázorněno na předchozím obrázku) a pak vyberte OK:

    • Název: nastavte název projektu sady Visual Studio na BasicProject. Tento název se používá také pro projekt Django.
    • Umístění: Zadejte umístění, ve kterém chcete vytvořit řešení a projekt sady Visual Studio.
    • Řešení: Ponechte tento ovládací prvek nastavený na výchozí možnost Vytvořit nové řešení .
    • Název řešení: nastavte na Učení Django, což je vhodné pro řešení jako kontejner pro více projektů v tomto kurzu.
    • Vytvořte adresář pro řešení: Ponechte nastavený (výchozí).
    • Vytvořit nové úložiště Git: Vyberte tuto možnost (která je ve výchozím nastavení jasná), aby Visual Studio při vytváření řešení vytvořilo místní úložiště Git. Pokud tuto možnost nevidíte, spusťte instalační program sady Visual Studio a přidejte git pro Windows a rozšíření GitHubu pro Visual Studio na kartě Jednotlivé komponenty v části Nástroje kódu.
  3. Po chvíli vás Visual Studio vyzve k dialogu s informací, že tento projekt vyžaduje externí balíčky (viz níže). Toto dialogové okno se zobrazí, protože šablona obsahuje soubor requirements.txt odkazující na nejnovější balíček Django 1.x. (Vyberte Zobrazit požadované balíčky k zobrazení přesných závislostí.)

    Prompt saying that the project requires external packages

  4. Vyberte možnost , že si je nainstaluji sami. Virtuální prostředí vytvoříte krátce, abyste měli jistotu, že je vyloučená ze správy zdrojového kódu. (Prostředí můžete vytvořit vždy z requirements.txt.)

  1. V sadě Visual Studio vyberte Soubor>nový>projekt, vyhledejte Django a vyberte prázdnou šablonu webového projektu Django a pak vyberte Další.

    New project dialog in Visual Studio for the Blank Django Web Project.

  2. Zadejte následující informace a pak vyberte Vytvořit:

    • Název projektu: Nastavte název projektu sady Visual Studio na BasicProject. Tento název se používá také pro projekt Django.
    • Umístění: Zadejte umístění, ve kterém chcete vytvořit řešení a projekt sady Visual Studio.
    • Řešení: Ponechte tento ovládací prvek nastavený na výchozí možnost Vytvořit nové řešení .
    • Název řešení: Nastavte na Učení Django, což je vhodné pro řešení jako kontejner pro více projektů v tomto kurzu.

Krok 1–2: Prozkoumání ovládacích prvků Git a publikování do vzdáleného úložiště

Vzhledem k tomu, že jste v dialogovém okně Nový projekt vybrali vytvořit nové úložiště Git, projekt se už po dokončení procesu vytváření potvrdí do místní správy zdrojového kódu. V tomto kroku se seznámíte s ovládacími prvky Git sady Visual Studio a oknem Team Exploreru, ve kterém pracujete se správou zdrojového kódu.

  1. Prozkoumejte ovládací prvky Gitu v dolním rohu hlavního okna sady Visual Studio. Zleva doprava tyto ovládací prvky zobrazují nepotvrzené potvrzení, nepotvrzené změny, název úložiště a aktuální větev:

    Git controls in the Visual Studio window

    Poznámka:

    Pokud v dialogovém okně Nový projekt nevyberete nové úložiště Git, zobrazí se v ovládacích prvcích Gitu jenom příkaz Přidat do správy zdrojového kódu, který vytvoří místní úložiště.

    Add to Source Control appears in Visual Studio if you've not created a repository

  2. Vyberte tlačítko Změny a Visual Studio otevře na stránce Změny okno Team Exploreru. Vzhledem k tomu, že nově vytvořený projekt je již potvrzen do správy zdrojového kódu automaticky, neuvidíte žádné čekající změny.

    Team Explorer window on the Changes page

  3. Na stavovém řádku sady Visual Studio vyberte tlačítko nepushed commits (šipka nahoru se 2) a otevřete stránku Synchronizace v Team Exploreru. Vzhledem k tomu, že máte jenom místní úložiště, poskytuje stránka jednoduché možnosti pro publikování úložiště do různých vzdálených úložišť.

    Team Explorer window showing available Git repository options for source control

    Můžete zvolit jakoukoli službu, kterou chcete použít pro své vlastní projekty. Tento kurz ukazuje použití GitHubu, kde se v úložišti Microsoft/python-sample-vs-learning-django udržuje dokončený ukázkový kód pro tento kurz.

  4. Když vyberete některý z ovládacích prvků Publikovat , Team Explorer vás vyzve k zadání dalších informací. Například při publikování ukázky pro tento kurz muselo být nejprve vytvořeno samotné úložiště, v takovém případě byla použita možnost Vložení do vzdáleného úložiště s adresou URL úložiště.

    Team Explorer window for pushing to an existing remote repository

    Pokud nemáte existující úložiště, možnosti Publikovat na GitHubu a Nasdílení změn do Azure DevOps vám umožní vytvořit ho přímo ze sady Visual Studio.

  5. Při práci v tomto kurzu se seznámíte s pravidelným používáním ovládacích prvků v sadě Visual Studio k potvrzení a nasdílení změn. Tento kurz vám připomene v příslušných bodech.

Tip

Pokud chcete rychle přecházet v Team Exploreru, vyberte záhlaví (které čte změny nebo nasdílení změn na obrázcích výše) a zobrazte místní nabídku dostupných stránek.

V tomto kroku se seznámíte s ovládacími prvky Git sady Visual Studio a Team Explorerem. V okně Team Exploreru budete pracovat se správou zdrojového kódu.

  1. Potvrzení projektu do místní správy zdrojového kódu:

    1. Vyberte příkaz Přidat do správy zdrojového kódu v dolním rohu hlavního okna sady Visual Studio.
    2. Pak vyberte možnost Git .
    3. Teď přejdete do okna Vytvořit úložiště Git, kde můžete vytvořit a odeslat nové úložiště.

    Create a Git repository.

  2. Po vytvoření úložiště se v dolní části zobrazí sada nových ovládacích prvků Git. Zleva doprava tyto ovládací prvky zobrazují nepotvrzené potvrzení, nepotvrzené změny, aktuální větev a název úložiště.

    Git controls in the Visual Studio window.

  3. Vyberte tlačítko Změny Gitu. Visual Studio pak otevře stránku Změny Gitu v Team Exploreru. Nevidíte žádné čekající změny, protože nově vytvořený projekt je již potvrzen do správy zdrojového kódu automaticky.

    Team Explorer window on the Git Changes page.

  4. Na stavovém řádku sady Visual Studio vyberte tlačítko nepushed commits (šipka nahoru se 2) a otevřete stránku Synchronizace v Team Exploreru. Stránka Synchronizace poskytuje snadné možnosti publikování místního úložiště do různých vzdálených úložišť.

    Team Explorer window showing available Git repository options for source control.

    Můžete zvolit jakoukoli službu, kterou chcete pro své projekty použít. Tento kurz ukazuje použití GitHubu, kde se v úložišti Microsoft/python-sample-vs-learning-django udržuje dokončený ukázkový kód pro tento kurz.

  5. Když vyberete některý z ovládacích prvků Publikovat , Team Explorer vás vyzve k zadání dalších informací. Například při publikování ukázky pro tento kurz se musí nejprve vytvořit samotné úložiště. V takovém případě se u adresy URL úložiště použila možnost Push to Remote Repository .

    Team Explorer window for pushing to an existing remote repository.

    Pokud nemáte existující úložiště, možnosti Publikovat na GitHubu a Nasdílení změn do Azure DevOps vám umožní vytvořit ho přímo ze sady Visual Studio.

  6. Při práci v tomto kurzu se seznámíte s pravidelným používáním ovládacích prvků v sadě Visual Studio k potvrzení a nasdílení změn. Tento kurz vám připomene v příslušných bodech.

Tip

Pokud chcete rychle přecházet v Team Exploreru, vyberte záhlaví (které čte změny nebo nasdílení změn na obrázcích výše) a zobrazte místní nabídku dostupných stránek.

Otázka: Jaké jsou některé výhody použití správy zdrojového kódu od začátku projektu?

Odpověď: Správa zdrojového kódu ze začátku, zejména pokud používáte vzdálené úložiště, poskytuje pravidelné zálohování projektu mimo pracoviště. Na rozdíl od údržby projektu v místním systému souborů poskytuje správa zdrojového kódu úplnou historii změn a snadnou možnost vrátit jeden soubor nebo celý projekt do předchozího stavu. Historie změn pomáhá určit příčinu regresí (selhání testů). Když na projektu pracuje více lidí, správa zdrojového kódu spravuje přepsání a zajišťuje řešení konfliktů.

Nakonec vám správa zdrojového kódu, což je základní forma automatizace, nastaví automatizaci sestavení, testování a správy verzí. Jedná se o první krok při používání DevOps pro projekt. Neexistuje žádný důvod, proč od začátku používat správu zdrojového kódu, protože překážky pro vstup jsou nízké.

Další diskuzi o správě zdrojového kódu jako automatizaci najdete v tématu Zdroj pravdy: Role úložišť v DevOps, článek v MSDN Magazine napsaný pro mobilní aplikace, které platí také pro webové aplikace.

Otázka: Můžu sadě Visual Studio zabránit v automatickém potvrzení nového projektu?

Odpověď: Ano. Pokud chcete zakázat automatické dokončování, přejděte na stránku Nastavení v Team Exploreru. Vyberte Globální nastavení Gitu>, zrušte zaškrtnutí políčka Potvrdit změny po sloučení ve výchozím nastavení a pak vyberte Aktualizovat.

Krok 1–3: Vytvoření virtuálního prostředí a jeho vyloučení ze správy zdrojového kódu

Teď, když jste pro svůj projekt nakonfigurovali správu zdrojového kódu, můžete vytvořit virtuální prostředí, které obsahuje potřebné balíčky Django pro projekt. Potom můžete pomocí Team Exploreru vyloučit složku prostředí ze správy zdrojového kódu.

  1. V Průzkumník řešení klikněte pravým tlačítkem myši na uzel Prostředí Pythonu a vyberte Přidat virtuální prostředí.

    Add Virtual environment command in Solution Explorer

  2. Zobrazí se dialogové okno Přidat virtuální prostředí se zprávou, že jsme našli soubor requirements.txt. Tato zpráva označuje, že Visual Studio tento soubor používá ke konfiguraci virtuálního prostředí.

    Add virtual environment dialog with requirements.txt message

  3. Výběrem možnosti Vytvořit přijměte výchozí hodnoty. (Pokud chcete, můžete změnit název virtuálního prostředí, který jenom změní název její podsložky, ale env je to standardní konvence.)

  4. Pokud se zobrazí výzva k vyjádření souhlasu s oprávněními správce, buďte trpěliví během několika minut, zatímco Visual Studio stáhne a nainstaluje balíčky, což pro Django znamená rozšíření několika tisíc souborů o tolik podsložek. Průběh můžete vidět v okně Výstup sady Visual Studio. Zatímco čekáte, zamyslete se nad oddíly otázky, které následují.

  5. Na ovládacích prvcích Git sady Visual Studio (na stavovém řádku) vyberte indikátor změn (který zobrazuje 99*), který otevře stránku Změny v Team Exploreru.

    Vytvoření virtuálního prostředí, které přineslo tisíce změn, ale nemusíte je do správy zdrojového kódu zahrnout, protože vy (nebo někdo jiný klonující projekt) můžete prostředí kdykoli znovu vytvořit z requirements.txt.

    Pokud chcete virtuální prostředí vyloučit, klikněte pravým tlačítkem myši na složku env a vyberte Ignorovat tyto místní položky.

    Ignoring a virtual environment in source control changes

  6. Po vyloučení virtuálního prostředí jsou jedinými zbývajícími změnami souboru projektu a .gitignore. Soubor .gitignore obsahuje přidanou položku pro složku virtuálního prostředí. Rozdíl se zobrazí poklikáním na soubor.

  7. Zadejte zprávu potvrzení a vyberte tlačítko Potvrdit vše a pak nasdílejte potvrzení do vzdáleného úložiště.

  1. V Průzkumník řešení klikněte pravým tlačítkem na uzel Prostředí Pythonu a vyberte Přidat prostředí.

    Add Virtual environment command in Solution Explorer.

  2. Výběrem možnosti Vytvořit přijměte výchozí hodnoty v dialogovém okně Přidat virtuální prostředí. (Pokud chcete, můžete změnit název virtuálního prostředí, který jenom změní název její podsložky, ale env je to standardní konvence.)

    Add virtual environment dialog with requirements.txt message.

  3. Pokud se zobrazí výzva k vyjádření souhlasu s oprávněními správce, počkejte několik minut, než Visual Studio stáhne a nainstaluje balíčky. Během této doby se tisíce souborů přenesou do mnoha podsložek. Průběh uvidíte v okně Výstup sady Visual Studio. Zatímco čekáte, zamyslete se nad oddíly otázky, které následují.

  4. Na ovládacích prvcích Git sady Visual Studio (na stavovém řádku) vyberte indikátor změn (který zobrazuje 99*), který otevře stránku Změny v Team Exploreru.

    Vytvoření virtuálního prostředí, které přineslo tisíce změn, ale nemusíte je do správy zdrojového kódu zahrnout, protože vy (nebo někdo jiný klonující projekt) můžete prostředí kdykoli znovu vytvořit z requirements.txt.

  5. Pokud chcete virtuální prostředí vyloučit, klikněte pravým tlačítkem myši na složku env a vyberte Ignorovat tyto místní položky.

    Ignoring a virtual environment in source control changes.

  6. Po vyloučení virtuálního prostředí jsou jedinými zbývajícími změnami souboru projektu a souboru .gitignore . Soubor .gitignore obsahuje přidanou položku pro složku virtuálního prostředí. Rozdíl se zobrazí poklikáním na soubor.

  7. Zadejte zprávu potvrzení a vyberte tlačítko Potvrdit vše a pak nasdílejte potvrzení do vzdáleného úložiště.

Otázka: Proč chci vytvořit virtuální prostředí?

Odpověď: Virtuální prostředí je skvělý způsob, jak izolovat přesné závislosti vaší aplikace. Taková izolace zabraňuje konfliktům v globálním prostředí Pythonu a pomáhá jak testování, tak spolupráci. V průběhu času při vývoji aplikace vždy přinášíte mnoho užitečných balíčků Pythonu. Soubor requirements.txt projektu můžete snadno aktualizovat tak, že zachováte balíčky ve virtuálním prostředí specifickém pro projekt. Soubor requirements.txt popisuje prostředí, které je součástí správy zdrojového kódu. Když se projekt zkopíruje do libovolného jiného počítače, včetně buildových serverů, serverů nasazení a dalších vývojových počítačů, je snadné prostředí znovu vytvořit jenom pomocí souboru requirements.txt (proto prostředí nemusí být ve správě zdrojového kódu). Další informace naleznete v tématu Použití virtuálních prostředí.

Otázka: Návody odebrat virtuální prostředí, které se už zavázalo ke správě zdrojového kódu?

Odpověď: Nejprve upravte soubor .gitignore a vyloučíte složku. Najděte oddíl na konci s komentářem # Python Tools for Visual Studio (PTVS) a přidejte nový řádek pro složku virtuálního prostředí, například /BasicProject/env. (Visual Studio soubor nezobrazuje v Průzkumník řešení. Pokud chcete soubor otevřít přímo, přejděte na >Soubor Otevřít>soubor. Soubor můžete otevřít také z Team Exploreru. Přejděte na stránku Nastavení a vyberte Nastavení úložiště. Teď přejděte do části Ignorovat soubory a vyberte odkaz Upravit vedle souboru .gitignore.)

Za druhé, otevřete příkazové okno, přejděte do složky, například BasicProject. Složka BasicProject obsahuje složku virtuálního prostředí, jako je env, a spustit git rm -r env. Pak tyto změny potvrďte z příkazového řádku (git commit -m 'Remove venv') nebo potvrďte ze stránky Změny v Team Exploreru.

Krok 1–4: Prozkoumání často používaného kódu

Po dokončení vytváření projektu prozkoumejte často používaný kód projektu Django (který je opět stejný jako vygenerovaný příkazem rozhraní příkazového řádku django-admin startproject <project_name>).

  1. Kořen projektu má manage.py, nástroj pro správu příkazového řádku Django, který sada Visual Studio automaticky nastaví jako spouštěcí soubor projektu. Nástroj spustíte na příkazovém řádku pomocí python manage.py <command> [options]. Pro běžné úlohy Django sada Visual Studio poskytuje pohodlné příkazy nabídky. Klikněte pravým tlačítkem na projekt v Průzkumník řešení a výběrem Pythonu zobrazte seznam. V tomto kurzu se setkáte s některými z těchto příkazů.

    Django commands on a Python project context menu.

  2. V projektu je složka se stejným názvem jako projekt. Obsahuje základní soubory projektu Django:

    • __init.py: Prázdný soubor sděluje Pythonu, že tato složka je balíček Pythonu.
    • settings.py: Obsahuje nastavení pro projekt Django, který upravíte v průběhu vývoje webové aplikace.
    • urls.py: Obsahuje obsah projektu Django, který budete také upravovat v průběhu vývoje.
    • wsgi.py: Vstupní bod pro webové servery kompatibilní s WSGI, který bude sloužit vašemu projektu. Tento soubor obvykle ponecháte tak, jak je, protože poskytuje háky pro produkční webové servery.

    Django project files in Solution Explorer.

  3. Jak jsme si poznamenali dříve, šablona sady Visual Studio také přidá do projektu soubor requirements.txt určující závislost balíčku Django. Přítomnost tohoto souboru vás při prvním vytvoření projektu vyzve k vytvoření virtuálního prostředí.

Otázka: Může Visual Studio po instalaci dalších balíčků vygenerovat soubor requirements.txt z virtuálního prostředí?

Odpověď: Ano. Rozbalte uzel Prostředí Pythonu, klikněte pravým tlačítkem na virtuální prostředí a vyberte příkaz Generovat požadavky.txt. Tento příkaz je vhodné používat pravidelně při úpravách prostředí a potvrdit změny požadavků.txt do správy zdrojového kódu spolu s dalšími změnami kódu, které závisí na daném prostředí. Pokud nastavíte kontinuální integraci na buildovém serveru, měli byste soubor vygenerovat a potvrdit změny při každé úpravě prostředí.

Krok 1–5: Spuštění prázdného projektu Django

  1. V sadě Visual Studio vyberte >Spustit ladění (F5) nebo použijte tlačítko Webového serveru na panelu nástrojů (prohlížeč, který se může lišit):

    Run web server toolbar button in Visual Studio.

  2. Spuštěním serveru spustíte příkaz manage.py runserver <port>, který spustí integrovaný vývojový server Django. Pokud visual Studio říká, že se nepovedlo spustit ladicí program se zprávou o tom, že nemáte spouštěcí soubor, klikněte pravým tlačítkem na manage.py v Průzkumník řešení a vyberte Nastavit jako spouštěcí soubor.

  3. Když spustíte server, zobrazí se okno konzoly, které zobrazí také protokol serveru. Visual Studio automaticky otevře prohlížeč na http://localhost:<port>. Vzhledem k tomu, že projekt Django nemá žádné aplikace, Django zobrazí pouze výchozí stránku, která potvrdí, že to, co jste zatím udělali, funguje správně.

    Django project default view.

  4. Až budete hotovi, zastavte server zavřením okna konzoly nebo pomocí příkazu Ladění>zastavit ladění v sadě Visual Studio.

Otázka: Je Django webový server a architektura?

Odpověď: Ano a ne. Django má integrovaný webový server, který se používá pro účely vývoje. Tento webový server se používá při místním spuštění webové aplikace, například při ladění v sadě Visual Studio. Když ale nasadíte na webového hostitele, Django místo toho použije webový server hostitele. Modul wsgi.py v projektu Django se postará o připojení k produkčním serverům.

Otázka: Jaký je rozdíl mezi použitím příkazů nabídky Ladění a příkazů serveru v podnabídce Pythonu projektu?

Odpověď: Kromě příkazů nabídky Ladění a tlačítek na panelu nástrojů můžete server spustit také pomocí serveru Spustit v Pythonu>nebo příkazy pro ladění serveru Python>Spustit v místní nabídce projektu. Oba příkazy otevřou okno konzoly, ve kterém uvidíte místní adresu URL (localhost:port) pro spuštěný server. Musíte ale ručně otevřít prohlížeč s danou adresou URL a spuštění ladicího serveru nespustí ladicí program sady Visual Studio automaticky. Pokud chcete, můžete k běžícímu procesu připojit ladicí program pomocí příkazu Připojit k procesu ladění>.

Další kroky

V tomto okamžiku základní projekt Django neobsahuje žádné aplikace. V dalším kroku vytvoříte aplikaci. Vzhledem k tomu, že budete pracovat s aplikacemi Django více než s projektem Django, nebudete už muset vědět víc o často používaných souborech.

Přejít hlouběji