Udostępnij za pośrednictwem

Przegląd internetowych szablonów azd dla języka Python

  • Artykuł

Szablony internetowego interfejsu wiersza polecenia platformy Azure (azd) w języku Python to najszybszy i najprostszy sposób tworzenia i wdrażania aplikacji internetowych w języku Python na platformie Azure. Ten artykuł zawiera kontekstowe informacje podstawowe podczas pracy z szablonami.

Najlepszym podejściem do rozpoczęcia pracy jest postępuj zgodnie z przewodnikiem szybkiego startu, aby utworzyć pierwszą aplikację internetową w języku Python i wdrożyć ją na platformie Azure w ciągu kilku minut za pomocą szablonów azd. Jeśli wolisz nie skonfigurować lokalnego środowiska deweloperskiego, możesz zamiast tego skorzystać z przewodnika Szybki start przy użyciu usługi GitHub Codespaces.

Czym są szablony azd dla aplikacji webowych w języku Python?

Szablony azd są przeznaczone dla doświadczonych deweloperów internetowych języka Python, którzy chcą tworzyć aplikacje internetowe języka Python przeznaczone dla wdrożenia platformy Azure. Szablony zapewniają najprostszym możliwym rozpoczęciem tworzenia aplikacji internetowych w języku Python. Możesz szybko utworzyć całe lokalne środowisko deweloperskie/hostingowe i środowisko wdrażania, korzystając tylko z kilku instrukcji wiersza polecenia. Przepływ pracy jest prosty w użyciu, a kroki są łatwe do zapamiętania.

Po skonfigurowaniu środowisk deweloperskich i hostingowych szablony zapewniają najszybszym rozpoczęciem tworzenia aplikacji internetowej w języku Python. Konfigurując pliki kodu szablonu w celu spełnienia określonych wymagań, możesz dostosować aplikację internetową w języku Python w ciągu kilku minut.

Szablony ułatwiają również przestrzeganie ustalonych strategii projektowania i opierać się na najlepszych rozwiązaniach. Postępuj zgodnie z projektami szablonów i dodaj swój kod, opierając się na solidnych podstawach. Szablony są tworzone i obsługiwane przez weteranów branżowych z szerokim doświadczeniem programistycznym w języku Python na platformie Azure.

Jakie zadania można wykonać za pomocą szablonów?

Po uruchomieniu szablonu internetowego azd języka Python szybko wykonasz kilka zadań:

  • Utwórz aplikację początkową. Tworzysz witrynę internetową fikcyjnej firmy o nazwie Relecloud. Kod projektu zawiera wiele najlepszych rozwiązań dotyczących struktur i pakietów języka Python wymaganych dla tego konkretnego stosu technologii. Szablon ma być punktem wyjścia dla aplikacji. W razie potrzeby dodasz lub usuniesz logikę aplikacji i zasoby platformy Azure.
  • Konfiguruj zasoby Azure. Aby aprowizować zasoby platformy Azure do hostowania twojej aplikacji internetowej i bazy danych, używasz Bicep, popularnego narzędzia do zarządzania infrastrukturą jako kodem. Podobnie jak w poprzednim zadaniu, można zmodyfikować szablony Bicep, aby w razie potrzeby dodać więcej usług platformy Azure.
  • Wdróż aplikację początkową na aprowizowane zasoby platformy Azure. Automatycznie wdrażasz aplikację startową. Takie podejście pozwala szybko przejrzeć uruchomiony program i zdecydować, co chcesz zmodyfikować.
  • (opcjonalnie) Skonfiguruj repozytorium GitHub i pipeline CI/CD. Jako opcję możesz skonfigurować repozytorium GitHub, w tym pipeline GitHub Actions do ciągłej integracji/ciągłego dostarczania (CI/CD). Takie podejście umożliwia szybkie wprowadzanie zmian w kodzie projektu internetowego. Po scaleniu tych zmian z główną gałęzią głównego repozytorium GitHub potok ciągłej integracji/ciągłego wdrażania publikuje je w nowym środowisku hostingu platformy Azure.

Gdzie mogę uzyskać dostęp do szablonów?

W galerii szablonów Awesome Azure Developer CLI Templates dostępnych jest wiele szablonów azd. Ta kolekcja oferuje unikatowe szablony internetowe azd języka Python, które zapewniają przykładową aplikację internetową z parzystością funkcji w wielu różnych popularnych kombinacjach zasobów platformy Azure i platform internetowych języka Python.

W poniższych tabelach wymieniono nazwy szablonów web azd języka Python, które są dostępne do użycia z poleceniem azd init. Tabele identyfikują technologie zaimplementowane w każdym szablonie i udostępniają link do odpowiedniego repozytorium GitHub, w którym można współtworzyć zmiany.

Indeks szablonów

W poniższej tabeli wymieniono dostępne szablony internetowe azd języka Python do użycia z poleceniem azd init, technologiami zaimplementowanymi w każdym szablonie oraz linkiem do repozytorium GitHub, jeśli chcesz współtworzyć zmiany.

Następujące szablony azd są dostępne dla platformy internetowej Django.

Szablon Baza danych Platforma hostingu Repozytorium GitHub
azure-django-postgres-flexible-aca Azure Database for PostgreSQL — serwer elastyczny Azure Container Apps https://github.com/Azure-Samples/azure-django-postgres-flexible-aca
azure-django-postgres-elastyczna-usługa-aplikacji Elastyczny serwer Azure Database dla PostgreSQL Azure App Service https://github.com/Azure-Samples/azure-django-postgres-flexible-appservice
azure-django-cosmos-postgres-aca Azure Cosmos DB dla Azure Database dla PostgreSQL Azure Container Apps https://github.com/Azure-Samples/azure-django-cosmos-postgres-aca
azure-django-cosmos-postgres-appservice Azure Cosmos DB dla Azure Database for PostgreSQL Azure App Service https://github.com/Azure-Samples/azure-django-cosmos-postgres-appservice
azure-django-postgres-addon-aca Aplikacje kontenerowe Azure z bazą danych Azure Database for PostgreSQL Aplikacje Kontenerowe Azure https://github.com/Azure-Samples/azure-django-postgres-addon-aca

Jak należy używać szablonów?

Każdy szablon azd składa się z repozytorium GitHub, które zawiera kod aplikacji (kod w języku Python, wykorzystujący popularny framework webowy) oraz pliki infrastruktury-jako-kodu (czyli Bicep) do tworzenia zasobów platformy Azure. Szablon zawiera również konfigurację wymaganą do skonfigurowania repozytorium GitHub z pipeline'em CI/CD.

Aby wykonać zadania zdefiniowane przez szablon sieci Web azd, należy użyć różnych poleceń języka Python azd. Aby uzyskać szczegółowe opisy tych poleceń, zobacz Szybki start: Wdrażanie szablonu Azure Developer CLI. Szybki przewodnik przeprowadzi Cię przez kroki użycia określonego szablonu azd. Wystarczy uruchomić pięć podstawowych instrukcji wiersza polecenia do środowiska hostingu produkcyjnego i środowiska deweloperskiego lokalnego.

Poniższa tabela zawiera podsumowanie pięciu podstawowych poleceń:

Polecenie Opis zadania
azd init --template <template name> Utwórz nowy projekt na podstawie szablonu i utwórz kopię kodu aplikacji na komputerze lokalnym. Polecenie wyświetla monit o podanie nazwy środowiska (na przykład "myapp"), która jest używana jako prefiks w nazewnictwie wdrożonych zasobów.
azd auth login Zaloguj się do platformy Azure. Polecenie otwiera okno przeglądarki, w którym można zalogować się na platformie Azure. Po zalogowaniu okno przeglądarki zostanie zamknięte i polecenie zostanie zakończone. Polecenie azd auth login jest wymagane tylko przy pierwszym użyciu Azure Developer CLI (azd) na sesję.
azd up Przydziel zasoby w chmurze i wdróż aplikację na te zasoby.
azd deploy Wdróż zmiany w kodzie źródłowym aplikacji na zasoby, które zostały już skonfigurowane przez polecenie azd up.
azd down Usuń zasoby platformy Azure i potok CI/CD, jeśli był używany.

Napiwek

Podczas pracy z poleceniami azd zwróć uwagę na monity o wprowadzenie dodatkowych informacji. Po wykonaniu polecenia azd up może zostać wyświetlony monit o wybranie subskrypcji, jeśli masz więcej niż jedną. Może zostać również wyświetlony monit o określenie regionu. Odpowiedzi na żądania można zmienić, poprzez edytowanie zmiennych środowiskowych przechowywanych w folderze /.azure/ szablonu.

Po wykonaniu podstawowych zadań szablonu masz osobistą kopię oryginalnego szablonu, w którym można zmodyfikować dowolny plik zgodnie z potrzebami. Można co najmniej zmodyfikować kod projektu w języku Python, aby projekt korzystał z projektu i logiki aplikacji. Możesz również zmodyfikować konfigurację infrastruktury jako kodu, jeśli musisz zmienić zasoby platformy Azure. Aby uzyskać więcej informacji, zobacz sekcję Co mogę edytować lub usunąć w dalszej części tego artykułu.

Opcjonalne zadania szablonu

Oprócz pięciu podstawowych poleceń istnieją opcjonalne zadania, które można wykonać za pomocą szablonów azd.

Ponowne wdrażanie i modyfikowanie zasobów Azure

Po aprowizacji zasobów platformy Azure przy użyciu szablonu azd można modyfikować i ponownie aprowizować zasób.

  • Aby zmodyfikować zasób aprowizowany, należy edytować odpowiednie pliki Bicep w szablonie.
  • Aby zainicjować zadanie ponownej aprowizacji, użyj polecenia azd provision.

Konfigurowanie potoku CI/CD

Azure Developer CLI (azd) zapewnia łatwą konfigurację pipeline CI/CD dla nowej aplikacji internetowej Python. Podczas scalania zatwierdzeń lub żądań zmiany do głównej gałęzi, rurociąg automatycznie kompiluje i publikuje zmiany w zasobach platformy Azure.

  • Aby skonfigurować potok ciągłej integracji/ciągłego wdrażania, należy wskazać repozytorium GitHub oraz określić potrzebne ustawienia, aby potok działał.
  • Aby utworzyć pipeline, użyj polecenia azd pipeline config.

Alternatywy dla szablonów

Jeśli wolisz nie używać szablonów azd internetowych języka Python, istnieją alternatywne metody wdrażania aplikacji internetowych w języku Python na platformie Azure i aprowizowania zasobów platformy Azure.

Możesz utworzyć wiele zasobów i wykonać kroki wdrażania przy użyciu kilku narzędzi:

  • Interfejs wiersza polecenia platformy Azure

Możesz również skorzystać z kompleksowego samouczka, który zawiera struktury tworzenia aplikacji internetowych w języku Python:

Często zadawane pytania

W poniższych sekcjach przedstawiono odpowiedzi na często zadawane pytania dotyczące pracy z szablonami azd internetowych języka Python.

Czy muszę używać usługi Dev Containers?

Nie. Szablony azd internetowych języka Python domyślnie używają kontenerów deweloperskich programu Visual Studio Code. Kontenery deweloperskie zapewniają wiele korzyści, ale wymagają pewnej wstępnie wymaganej wiedzy i oprogramowania. Jeśli wolisz nie używać usługi Dev Containers i zamiast tego używasz lokalnego środowiska deweloperskiego, zobacz plik README.md w katalogu głównym przykładowej aplikacji, aby uzyskać instrukcje dotyczące konfiguracji środowiska.

Co mogę edytować lub usunąć?

Zawartość każdego szablonu azd może się różnić w zależności od typu projektu i używanego bazowego stosu technologii. Szablony wymienione w tym artykule są zgodne z wspólną konwencją:

Zawartość każdego szablonu internetowego azd języka Python może się różnić w zależności od typu projektu i używanego stosu technologii. Szablony zidentyfikowane w tym artykule są zgodne ze wspólną konwencją folderów i plików zgodnie z opisem w poniższej tabeli.

Folder/pliki Cel Opis
/ Katalog główny Folder główny dla każdego szablonu zawiera wiele różnych rodzajów plików i folderów do różnych celów.
/.azure pliki konfiguracji azd Folder .azure jest tworzony po uruchomieniu polecenia azd init. Folder przechowuje pliki konfiguracji zmiennych środowiskowych używanych przez polecenia azd. Możesz zmienić wartości zmiennych środowiskowych, aby dostosować aplikację i zasoby platformy Azure. Aby uzyskać więcej informacji, zobacz plik env specyficzny dla środowiska.
/.devcontainer Pliki konfiguracji kontenera deweloperskiego Usługa Dev Containers umożliwia tworzenie środowiska deweloperskiego opartego na kontenerach wraz ze wszystkimi zasobami potrzebnymi do tworzenia oprogramowania w programie Visual Studio Code. Folder .devcontainer jest tworzony po tym, jak Visual Studio Code wygeneruje plik konfiguracji kontenera deweloperskiego, odpowiadając na polecenie szablonu.
/.github Pliki konfiguracji funkcji GitHub Actions Ten folder zawiera ustawienia konfiguracji dla opcjonalnego potoku CI/CD GitHub Actions, lintingu oraz testów. Jeśli nie chcesz konfigurować potoku GitHub Actions przy użyciu polecenia azd pipeline config, możesz zmodyfikować lub usunąć plik azure-dev.yaml.
/infra Pliki Bicep Folder infra zawiera pliki konfiguracji Bicep. Bicep umożliwia deklarowanie zasobów platformy Azure, które mają zostać wdrożone w środowisku. Należy zmodyfikować tylko pliki main.bicep i web.bicep. Aby uzyskać więcej informacji, zobacz Szybkie uruchomienie: skalowanie usług wdrożonych przy użyciu szablonów internetowych języka Python za pomocą Bicep.
/src Pliki kodu projektu startowego Folder src zawiera różne pliki kodu wymagane do przygotowania projektu startowego. Przykłady plików obejmują szablony wymagane przez platformę internetową, pliki statyczne, pliki python (.py) dla modeli logiki kodu i danych, plik requirements.txt i inne. Określone pliki zależą od platformy internetowej, struktury dostępu do danych itd. Te pliki można modyfikować zgodnie z wymaganiami projektu.
/.cruft.json Plik generowania szablonu Plik JSON .cruft jest używany wewnętrznie do generowania szablonów azd internetowych języka Python. Możesz bezpiecznie usunąć ten plik zgodnie z potrzebami.
/.gitattributes Plik z ustawieniami atrybutów dla usługi git Ten plik zapewnia usłudze Git ważne ustawienia konfiguracji do obsługi plików i folderów. Możesz zmodyfikować ten plik zgodnie z potrzebami.
/.gitignore Plik z ignorowanymi elementami usługi Git Plik .gitignore informuje program git, które pliki i foldery należy wykluczyć (zignorować) podczas zapisywania w repozytorium GitHub szablonu. Możesz zmodyfikować ten plik zgodnie z potrzebami.
/azure.yaml plik konfiguracji azd up Ten plik konfiguracji zawiera ustawienia konfiguracji polecenia azd up. Określa usługi i foldery projektu do wdrożenia. ważne: nie można usunąć tego pliku.
/*.md Pliki formatu Markdown Szablon może zawierać różne pliki formatu Markdown (md) do różnych celów. Możesz bezpiecznie usunąć pliki Markdown.
/docker-compose.yml Ustawienia narzędzia Docker Compose Ten plik YML tworzy pakiet kontenera dla aplikacji internetowej w języku Python przed wdrożeniem aplikacji na platformie Azure.
/pyproject.toml Plik ustawień kompilacji języka Python Plik TOML zawiera wymagania systemowe kompilacji projektów języka Python. Możesz zmodyfikować ten plik, aby określić preferencje dotyczące narzędzi, takich jak konkretne narzędzie linter lub biblioteka do testowania jednostkowego.
/requirements-dev.in plik wymagań pip Ten plik służy do tworzenia wersji środowiska deweloperskiego wymagań przy użyciu polecenia pip install -r. Możesz zmodyfikować ten plik, aby uwzględnić inne pakiety zgodnie z potrzebami.

Napiwek

Podczas modyfikowania plików szablonów dla programu pamiętaj, aby dobrze zarządzać kontrolą wersji. Takie podejście może pomóc przywrócić repozytorium do poprzedniej działającej wersji, jeśli nowe zmiany spowodują problemy z programem.

Jak mogę obsługiwać błędy szablonu?

Jeśli wystąpi błąd podczas korzystania z szablonu azd, zapoznaj się z opcjami opisanymi w artykule Rozwiązywanie problemów z interfejsem wiersza polecenia dewelopera platformy Azure. Możesz również zgłosić problemy w repozytorium GitHub skojarzonym z szablonem azd.

Powiązana zawartość