Samouczek: rozpoczynanie pracy z platformą internetową Django w programie Visual Studio

Django to platforma języka Python wysokiego poziomu przeznaczona do szybkiego, bezpiecznego i skalowalnego tworzenia aplikacji internetowych. W tym samouczku przedstawiono strukturę Django w kontekście szablonów projektów. Program Visual Studio udostępnia szablony projektów, aby usprawnić tworzenie aplikacji internetowych opartych na platformie Django.

Z tego samouczka dowiesz się, jak wykonywać następujące czynności:

• Utwórz podstawowy projekt Django w repozytorium Git przy użyciu szablonu "Pusty projekt internetowy Django" (krok 1).
• Utwórz aplikację Django z jedną stroną i renderuj ją przy użyciu szablonu (krok 2).
• Obsługa plików statycznych, dodawanie stron i używanie dziedziczenia szablonu (krok 3).
• Użyj szablonu projektu internetowego Django, aby utworzyć aplikację z wieloma stronami i dynamicznym projektem (krok 4).
• Uwierzytelnianie użytkowników (krok 5).

Wymagania wstępne

• Program Visual Studio 2022 w systemie Windows z następującymi opcjami:
  • Obciążenie programowania w języku Python (karta Obciążenie w instalatorze). Aby uzyskać więcej instrukcji, zobacz Instalowanie obsługi języka Python w programie Visual Studio.
  • Usługa Git dla systemu Windows na karcie Poszczególne składniki w obszarze Narzędzia kodu.

Szablony projektów Django obejmują również wcześniejsze wersje narzędzi Python Tools for Visual Studio. Szczegóły szablonu mogą się różnić od tego, co zostało omówione w tym samouczku (szczególnie różni się od wcześniejszych wersji platformy Django).

Programowanie w języku Python nie jest obecnie obsługiwane w Visual Studio dla komputerów Mac. Na komputerach Mac i Linux użyj rozszerzenia języka Python w programie Visual Studio Code.

"Projekty programu Visual Studio" i "Projekty Django"

W terminologii Django "projekt Django" ma kilka plików konfiguracji na poziomie lokacji wraz z co najmniej jednym "aplikacjami". Aby utworzyć pełną aplikację internetową, możesz wdrożyć te aplikacje na hoście internetowym. Projekt Django może zawierać wiele aplikacji, a ta sama aplikacja może znajdować się w wielu projektach Django.

Projekt programu Visual Studio może zawierać projekt Django wraz z wieloma aplikacjami. Za każdym razem, gdy ten samouczek odnosi się tylko do "projektu", odnosi się on do projektu programu Visual Studio. W przypadku odwoływania się do części "projektu Django" aplikacji internetowej odnosi się ona do projektu "Django" specjalnie.

W trakcie tego samouczka utworzysz jedno rozwiązanie programu Visual Studio zawierające trzy oddzielne projekty Django. Każdy projekt zawiera jedną aplikację Django. W celu porównania można łatwo przełączać się między różnymi plikami, zachowując projekty w tym samym rozwiązaniu.

Krok 1–1. Tworzenie projektu i rozwiązania programu Visual Studio

Podczas pracy z platformą Django z poziomu wiersza polecenia zwykle uruchamiasz projekt, uruchamiając django-admin startproject <project_name> polecenie . W programie Visual Studio szablon "Pusty projekt internetowy Django" zawiera tę samą strukturę w projekcie i rozwiązaniu programu Visual Studio.

1. W programie Visual Studio wybierz pozycję Plik>nowy>projekt, wyszukaj ciąg "Django", a następnie wybierz szablon Pusty projekt internetowy Django, a następnie wybierz pozycję Dalej.

   

2. Wprowadź następujące informacje, a następnie wybierz pozycję Utwórz:

   • Nazwa projektu: ustaw nazwę projektu programu Visual Studio na BasicProject. Ta nazwa jest również używana dla projektu Django.
   • Lokalizacja: określ lokalizację, w której ma zostać utworzone rozwiązanie i projekt programu Visual Studio.
   • Rozwiązanie: pozostaw tę kontrolkę ustawioną na domyślną opcję Utwórz nowe rozwiązanie .
   • Nazwa rozwiązania: ustaw wartość Edukacja Django, która jest odpowiednia dla rozwiązania jako kontenera dla wielu projektów w tym samouczku.

Krok 1–2. Badanie kontrolek Git i publikowanie w repozytorium zdalnym

W tym kroku zapoznasz się z kontrolkami Git programu Visual Studio i programem Team Explorer. W oknie Team Explorer będziesz pracować z kontrolą źródła.

1. Aby zatwierdzić projekt w lokalnej kontroli źródła:

   1. Wybierz pozycję Dodaj do polecenia Kontrola źródła w dolnym rogu okna głównego programu Visual Studio.
   2. Następnie wybierz opcję Git .
   3. Teraz przejdź do okna Tworzenie repozytorium Git, w którym możesz utworzyć i wypchnąć nowe repozytorium.

   

2. Po utworzeniu repozytorium w dolnej części zostanie wyświetlony zestaw nowych kontrolek Git. Od lewej do prawej te kontrolki pokazują niezauszane zatwierdzenia, niezatwierdzone zmiany, gałąź bieżącą i nazwę repozytorium.

   

3. Wybierz przycisk Zmiany usługi Git. Następnie program Visual Studio otwiera stronę Zmiany usługi Git w programie Team Explorer. Nie widzisz żadnych oczekujących zmian, ponieważ nowo utworzony projekt jest już zatwierdzony do kontroli źródła automatycznie.

   

4. Na pasku stanu programu Visual Studio wybierz przycisk niezauszanych zatwierdzeń (strzałka w górę z 2), aby otworzyć stronę Synchronizacja w programie Team Explorer. Strona Synchronizacja zawiera łatwe opcje publikowania repozytorium lokalnego w różnych repozytoriach zdalnych.

   

   Możesz wybrać dowolną usługę dla swoich projektów. W tym samouczku przedstawiono użycie usługi GitHub, w której ukończony przykładowy kod samouczka jest przechowywany w repozytorium Microsoft/python-sample-vs-learning-django .

5. Po wybraniu dowolnego z kontrolek Publikuj program Team Explorer wyświetli monit o podanie dodatkowych informacji. Na przykład podczas publikowania przykładu na potrzeby tego samouczka samo repozytorium musi zostać utworzone jako pierwsze, w takim przypadku opcja Wypychanie do repozytorium zdalnego została użyta z adresem URL repozytorium .

   

   Jeśli nie masz istniejącego repozytorium, opcje Publikuj w usłudze GitHub i Wypychanie do usługi Azure DevOps umożliwiają utworzenie go bezpośrednio z poziomu programu Visual Studio.

6. Podczas pracy z tym samouczkiem możesz okresowo korzystać z kontrolek w programie Visual Studio w celu zatwierdzania i wypychania zmian. Ten samouczek przypomina o odpowiednich punktach.

Napiwek

Aby szybko poruszać się w programie Team Explorer, wybierz nagłówek (który odczytuje zmiany lub wypchnij na powyższych obrazach), aby wyświetlić menu podręczne dostępnych stron.

Pytanie: Jakie są pewne zalety korzystania z kontroli źródła od początku projektu?

Odpowiedź: Kontrola źródła od samego początku, zwłaszcza jeśli używasz również repozytorium zdalnego, zapewnia zwykłą kopię zapasową poza siedzibą projektu. W przeciwieństwie do obsługi projektu w lokalnym systemie plików kontrola źródła zapewnia pełną historię zmian i łatwą możliwość przywracania pojedynczego pliku lub całego projektu do poprzedniego stanu. Historia zmian pomaga określić przyczynę regresji (niepowodzenia testów). Gdy wiele osób pracuje nad projektem, kontrola źródła zarządza zastępowaniem i zapewnia rozwiązanie konfliktów.

Na koniec kontrola źródła, która jest zasadniczo formą automatyzacji, umożliwia automatyzację kompilacji, testowania i zarządzania wydaniami. Jest to pierwszy krok w korzystaniu z metodyki DevOps dla projektu. Naprawdę nie ma powodu, aby nie używać kontroli źródła od początku, ponieważ bariery wejścia są niskie.

Aby uzyskać dalszą dyskusję na temat kontroli źródła jako automatyzacji, zobacz The Source of Truth: The Role of Repositories in DevOps (Źródło prawdy: rola repozytoriów w metodyce DevOps) w magazynie MSDN Magazine napisanym dla aplikacji mobilnych, które mają również zastosowanie do aplikacji internetowych.

Pytanie: Czy mogę uniemożliwić programowi Visual Studio automatyczne zatwierdzanie nowego projektu?

Odpowiedź: Tak. Aby wyłączyć automatyczne zatwierdzanie, przejdź do strony Ustawienia w programie Team Explorer. Wybierz pozycję Ustawienia globalne usługi Git>, wyczyść opcję Zatwierdź zmiany po scaleniu domyślnie, a następnie wybierz pozycję Aktualizuj.

Krok 1–3. Tworzenie środowiska wirtualnego i wykluczanie go z kontroli źródła

Po skonfigurowaniu kontroli źródła dla projektu możesz utworzyć środowisko wirtualne zawierające niezbędne pakiety Django dla projektu. Następnie możesz użyć programu Team Explorer , aby wykluczyć folder środowiska z kontroli źródła.

1. W Eksplorator rozwiązań kliknij prawym przyciskiem myszy węzeł Środowiska języka Python i wybierz polecenie Dodaj środowisko.

   

2. Wybierz pozycję Utwórz , aby zaakceptować wartości domyślne w oknie dialogowym Dodawanie środowiska wirtualnego. (Możesz zmienić nazwę środowiska wirtualnego, jeśli chcesz, co po prostu zmienia nazwę jego podfolderu, ale env jest konwencją standardową).

   

3. Jeśli zostanie wyświetlony monit o zgodę na uprawnienia administratora, zaczekaj kilka minut, a program Visual Studio pobierze i zainstaluje pakiety. W tym czasie tysiące plików jest przesyłanych do wielu podfolderów. Postęp można zobaczyć w oknie Dane wyjściowe programu Visual Studio. Podczas oczekiwania zastanów się nad poniższymi sekcjami Pytania.

4. Na kontrolkach Git programu Visual Studio (na pasku stanu) wybierz wskaźnik zmian (który pokazuje wartość 99*), który otwiera stronę Zmiany w programie Team Explorer.

   Tworzenie środowiska wirtualnego wprowadzonych w tysiącach zmian, ale nie musisz uwzględniać żadnego z nich w kontroli źródła, ponieważ użytkownik (lub ktokolwiek inny klonowanie projektu) zawsze może odtworzyć środowisko z pliku requirements.txt.

5. Aby wykluczyć środowisko wirtualne, kliknij prawym przyciskiem myszy folder env i wybierz polecenie Ignoruj te elementy lokalne.

   

6. Po wykluczeniu środowiska wirtualnego jedynymi pozostałymi zmianami są pliki projektu i plik gitignore . Plik .gitignore zawiera dodany wpis dla folderu środowiska wirtualnego. Możesz kliknąć dwukrotnie plik, aby zobaczyć różnice.

7. Wprowadź komunikat zatwierdzenia i wybierz przycisk Zatwierdź wszystko , a następnie wypchnij zatwierdzenia do repozytorium zdalnego.

Pytanie: Dlaczego chcę utworzyć środowisko wirtualne?

Odpowiedź: Środowisko wirtualne to doskonały sposób na izolowanie dokładnych zależności aplikacji. Taka izolacja pozwala uniknąć konfliktów w globalnym środowisku języka Python i ułatwia testowanie i współpracę. Wraz z upływem czasu podczas tworzenia aplikacji niezmiennie wprowadzasz wiele przydatnych pakietów języka Python. Plik requirements.txt projektu można łatwo zaktualizować, zachowując pakiety w środowisku wirtualnym specyficznym dla projektu. Plik requirements.txt opisuje środowisko, które znajduje się w kontroli źródła. Gdy projekt jest kopiowany do innych komputerów, w tym serwerów kompilacji, serwerów wdrażania i innych komputerów programistycznych, można łatwo odtworzyć środowisko przy użyciu tylko pliku requirements.txt (dlatego środowisko nie musi być w kontroli źródła). Aby uzyskać więcej informacji, zobacz Używanie środowisk wirtualnych.

Pytanie: Jak mogę usunąć środowisko wirtualne, które zostało już zatwierdzone do kontroli źródła?

Odpowiedź: Najpierw zmodyfikuj plik gitignore , aby wykluczyć folder. Znajdź sekcję na końcu z komentarzem # Python Tools for Visual Studio (PTVS) i dodaj nowy wiersz dla folderu środowiska wirtualnego, na przykład /BasicProject/env. (Program Visual Studio nie wyświetla pliku w programie Eksplorator rozwiązań. Aby otworzyć plik bezpośrednio, przejdź do pozycji Plik>otwórz>plik. Możesz również otworzyć plik z poziomu programu Team Explorer. Przejdź do strony Ustawienia i wybierz pozycję Repozytorium Ustawienia. Teraz przejdź do sekcji Ignoruj i atrybuty Pliki i wybierz link Edytuj obok pliku .gitignore.

Następnie otwórz okno polecenia, przejdź do folderu takiego jak BasicProject. Folder BasicProject zawiera folder środowiska wirtualnego, taki jak env, i uruchom polecenie git rm -r env. Następnie zatwierdź te zmiany z wiersza polecenia (git commit -m 'Remove venv') lub zatwierdź je na stronie Zmiany w programie Team Explorer.

Krok 1–4. Badanie kodu kociołowego

Po zakończeniu tworzenia projektu sprawdź standardowy kod projektu Django (który jest ponownie taki sam jak wygenerowany przez polecenie interfejsu wiersza polecenia django-admin startproject <project_name>).

1. Katalog główny projektu ma manage.py, narzędzie administracyjne wiersza polecenia Django, które program Visual Studio automatycznie ustawia jako plik startowy projektu. Narzędzie jest uruchamiane w wierszu polecenia przy użyciu polecenia python manage.py <command> [options]. W przypadku typowych zadań Django program Visual Studio udostępnia wygodne polecenia menu. Kliknij prawym przyciskiem myszy projekt w Eksplorator rozwiązań i wybierz pozycję Python, aby wyświetlić listę. W trakcie tego samouczka poznasz niektóre z tych poleceń.

   

2. W projekcie znajduje się folder o takiej samej nazwie jak projekt. Zawiera on podstawowe pliki projektu Django:

   • __init.py: pusty plik, który informuje język Python, że ten folder jest pakietem języka Python.
   • settings.py: zawiera ustawienia projektu Django, które zmodyfikujesz w trakcie tworzenia aplikacji internetowej.
   • urls.py: zawiera spis treści projektu Django, który będzie również modyfikowany w trakcie opracowywania.
   • wsgi.py: punkt wejścia dla serwerów internetowych zgodnych z usługą WSGI do obsługi projektu. Zazwyczaj pozostawiasz ten plik w takiej postaci, ponieważ zapewnia ona punkty zaczepienia dla produkcyjnych serwerów internetowych.

   

3. Jak wspomniano wcześniej, szablon programu Visual Studio dodaje również plik requirements.txt do projektu określający zależność pakietu Django. Obecność tego pliku jest tym, co zaprasza do utworzenia środowiska wirtualnego podczas pierwszego tworzenia projektu.

Pytanie: Czy program Visual Studio może wygenerować plik requirements.txt ze środowiska wirtualnego po zainstalowaniu innych pakietów?

Odpowiedź: Tak. Rozwiń węzeł Środowiska języka Python, kliknij prawym przyciskiem myszy środowisko wirtualne, a następnie wybierz polecenie Generate requirements.txt (Generuj wymagania.txt). Warto używać tego polecenia okresowo podczas modyfikowania środowiska i zatwierdzania zmian w pliku requirements.txt do kontroli źródła wraz z innymi zmianami kodu, które zależą od tego środowiska. W przypadku skonfigurowania ciągłej integracji na serwerze kompilacji należy wygenerować plik i zatwierdzić zmiany za każdym razem, gdy zmodyfikujesz środowisko.

Krok 1–5. Uruchamianie pustego projektu Django

1. W programie Visual Studio wybierz pozycję Debuguj>rozpocznij debugowanie (F5) lub użyj przycisku Serwer internetowy na pasku narzędzi (widoczna przeglądarka może się różnić):

   

2. Uruchomienie serwera oznacza uruchomienie polecenia manage.py runserver <port>, które uruchamia wbudowany serwer deweloperów Django. Jeśli w programie Visual Studio jest wyświetlany komunikat Nie można uruchomić debugera z komunikatem o braku pliku uruchamiania, kliknij prawym przyciskiem myszy manage.py w Eksplorator rozwiązań i wybierz polecenie Ustaw jako plik startowy.

3. Po uruchomieniu serwera zostanie otwarte okno konsoli, w którym zostanie również wyświetlony dziennik serwera. Program Visual Studio automatycznie otwiera przeglądarkę na .http://localhost:<port> Ponieważ projekt Django nie ma aplikacji, Django pokazuje tylko domyślną stronę, aby potwierdzić, że to, co masz do tej pory, działa prawidłowo.

   

4. Gdy skończysz, zatrzymaj serwer, zamykając okno konsoli lub używając polecenia Debuguj>zatrzymaj debugowanie w programie Visual Studio.

Pytanie: Czy Django jest serwerem internetowym i strukturą?

Odpowiedź: Tak i nie. Django ma wbudowany serwer internetowy, który jest używany do celów programistycznych. Ten serwer internetowy jest używany podczas lokalnego uruchamiania aplikacji internetowej, na przykład podczas debugowania w programie Visual Studio. Jednak podczas wdrażania na hoście internetowym usługa Django używa zamiast tego serwera internetowego hosta. Moduł wsgi.py w projekcie Django zajmuje się łączeniem się z serwerami produkcyjnymi.

Pytanie: Jaka jest różnica między używaniem poleceń menu Debugowanie a poleceniami serwera w podmenu języka Python projektu?

Odpowiedź: Oprócz poleceń menu Debugowanie i przycisków paska narzędzi można również uruchomić serwer przy użyciu polecenia Uruchom serwer python>lub Uruchom serwer debugowania języka Python>w menu kontekstowym projektu. Oba polecenia otwierają okno konsoli, w którym zobaczysz lokalny adres URL (localhost:port) dla uruchomionego serwera. Należy jednak ręcznie otworzyć przeglądarkę z tym adresem URL, a uruchomienie serwera debugowania nie powoduje automatycznego uruchomienia debugera programu Visual Studio. Jeśli chcesz, możesz dołączyć debuger do uruchomionego procesu przy użyciu polecenia Dołączanie debugowania>do procesu .

Następne kroki

W tym momencie podstawowy projekt Django nie zawiera żadnych aplikacji. Utworzysz aplikację w następnym kroku. Ponieważ będziesz pracować z aplikacjami Django bardziej niż projekt Django, nie musisz wiedzieć więcej o plikach kotłowych na razie.

Tworzenie aplikacji Django z widokami i szablonami stron

Głębiej

• Kod projektu Django: Pisanie pierwszej aplikacji Django, część 1 (docs.djangoproject.com)
• narzędzie Administracja istracyjne: django-admin i manage.py (docs.djangoproject.com)
• Samouczek dotyczący kodu źródłowego w witrynie GitHub: Microsoft/python-sample-vs-learning-django