Kodowanie i testowanie usługi Azure Functions lokalnie

Chociaż możesz opracowywać i testować Azure Functions w Azure Portal, wielu deweloperów preferuje lokalne środowisko deweloperskie. Korzystanie z usługi Functions przy użyciu ulubionego edytora kodu i narzędzi programistycznych do tworzenia i testowania funkcji na komputerze lokalnym staje się łatwiejsze. Funkcje lokalne mogą łączyć się z usługami platformy Azure na żywo i debugować je na komputerze lokalnym przy użyciu pełnego środowiska uruchomieniowego usługi Functions.

Ten artykuł zawiera linki do określonych środowisk deweloperskich dla preferowanego języka. Zawiera również pewne udostępnione wskazówki dotyczące programowania lokalnego, takie jak praca z plikiem local.settings.json.

Lokalne środowiska deweloperskie

Sposób opracowywania funkcji na komputerze lokalnym zależy od języka i preferencji narzędzi. Środowiska w poniższej tabeli obsługują programowanie lokalne:

Środowisko Języki Opis
Visual Studio Code C# (proces)
C# (izolowany proces roboczy)
JavaScript
Program PowerShell
Python
Rozszerzenie Azure Functions dla programu VS Code dodaje obsługę usługi Functions do programu VS Code. Wymaga narzędzi Core Tools. Obsługuje programowanie w systemach Linux, macOS i Windows w przypadku korzystania z wersji 2.x narzędzi Core Tools. Aby dowiedzieć się więcej, zobacz Tworzenie pierwszej funkcji przy użyciu Visual Studio Code.
Wiersz polecenia lub terminal C# (proces)
C# (izolowany proces roboczy)
JavaScript
Program PowerShell
Python
Azure Functions Core Tools udostępnia podstawowe środowisko uruchomieniowe i szablony do tworzenia funkcji, które umożliwiają programowanie lokalne. Wersja 2.x obsługuje programowanie w systemach Linux, macOS i Windows. Wszystkie środowiska korzystają z narzędzi Core Tools dla lokalnego środowiska uruchomieniowego usługi Functions.
Program Visual Studio C# (proces)
C# (izolowany proces roboczy)
Narzędzia Azure Functions są uwzględniane w obciążeniu Programowanie na platformie Azureprogramu Visual Studio, począwszy od programu Visual Studio 2019. Umożliwia kompilowanie funkcji w bibliotece klas i publikowanie .dll na platformie Azure. Obejmuje narzędzia Core Tools do testowania lokalnego. Aby dowiedzieć się więcej, zobacz Develop Azure Functions using Visual Studio (Tworzenie Azure Functions przy użyciu programu Visual Studio).
Maven (różne) Java Archetyp narzędzia Maven obsługuje narzędzia Core Tools w celu umożliwienia opracowywania funkcji Języka Java. Wersja 2.x obsługuje programowanie w systemach Linux, macOS i Windows. Aby dowiedzieć się więcej, zobacz Create your first function with Java and Maven (Tworzenie pierwszej funkcji przy użyciu języka Java i narzędzia Maven). Obsługuje również programowanie przy użyciu środowiska Eclipse i środowiska IntelliJ IDEA.

Uwaga

Nie mieszaj programowania lokalnego z programowaniem portalu w tej samej aplikacji funkcji. Podczas tworzenia i publikowania funkcji z projektu lokalnego nie będzie można obsługiwać ani modyfikować kodu projektu w portalu.

Każde z tych lokalnych środowisk deweloperskich umożliwia tworzenie projektów aplikacji funkcji i używanie wstępnie zdefiniowanych szablonów funkcji do tworzenia nowych funkcji. Każda z nich używa narzędzi Core Tools, dzięki czemu można testować i debugować funkcje względem rzeczywistego środowiska uruchomieniowego usługi Functions na własnej maszynie, tak jak w przypadku każdej innej aplikacji. Możesz również opublikować projekt aplikacji funkcji z dowolnego z tych środowisk na platformie Azure.

Plik ustawień lokalnych

Plik local.settings.json przechowuje ustawienia aplikacji i ustawienia używane przez lokalne narzędzia programistyczne. Ustawienia w pliku local.settings.json są używane tylko wtedy, gdy uruchamiasz projekt lokalnie. Podczas publikowania projektu na platformie Azure należy również dodać wszystkie wymagane ustawienia do ustawień aplikacji dla aplikacji funkcji.

Ważne

Ponieważ plik local.settings.json może zawierać wpisy tajne, takie jak parametry połączenia, nigdy nie należy przechowywać go w repozytorium zdalnym. Narzędzia, które obsługują usługę Functions, zapewniają sposoby synchronizowania ustawień w pliku local.settings.json z ustawieniami aplikacji w aplikacji funkcji, do której wdrożono projekt.

Plik ustawień lokalnych ma następującą strukturę:

{
  "IsEncrypted": false,
  "Values": {
    "FUNCTIONS_WORKER_RUNTIME": "<language worker>",
    "AzureWebJobsStorage": "<connection-string>",
    "MyBindingConnection": "<binding-connection-string>",
    "AzureWebJobs.HttpExample.Disabled": "true"
  },
  "Host": {
    "LocalHttpPort": 7071,
    "CORS": "*",
    "CORSCredentials": false
  },
  "ConnectionStrings": {
    "SQLConnectionString": "<sqlclient-connection-string>"
  }
}

Te ustawienia są obsługiwane podczas lokalnego uruchamiania projektów:

Ustawienie Opis
IsEncrypted Gdy to ustawienie jest ustawione na truewartość , wszystkie wartości są szyfrowane przy użyciu klucza komputera lokalnego. Używane z func settings poleceniami. Wartość domyślna to false. Możesz zaszyfrować plik local.settings.json na komputerze lokalnym, gdy zawiera wpisy tajne, takie jak parametry połączenia usługi. Host automatycznie odszyfrowuje ustawienia po uruchomieniu. Użyj polecenia przed próbą func settings decrypt odczytania ustawień zaszyfrowanych lokalnie.
Values Kolekcja ustawień aplikacji używanych podczas lokalnego uruchamiania projektu. Te pary klucz-wartość (ciąg-ciąg) odpowiadają ustawieniu aplikacji w aplikacji funkcji na platformie Azure, na przykład AzureWebJobsStorage. Wiele wyzwalaczy i powiązań ma właściwość odwołującą się do ustawienia aplikacji parametrów połączenia, na przykład Connection dla wyzwalacza usługi Blob Storage. Dla tych właściwości potrzebne jest ustawienie aplikacji zdefiniowane w tablicy Values . Zobacz kolejną tabelę, aby zapoznać się z listą często używanych ustawień.
Wartości muszą być ciągami, a nie obiektami JSON ani tablicami. Nazwy ustawień nie mogą zawierać podwójnego podkreślenia (__) i nie powinny zawierać dwukropka (:). Znaki podwójnego podkreślenia są zarezerwowane przez środowisko uruchomieniowe, a dwukropek jest zarezerwowany do obsługi wstrzykiwania zależności.
Host Ustawienia w tej sekcji dostosują proces hosta usługi Functions podczas uruchamiania projektów lokalnie. Te ustawienia są oddzielone od ustawień host.json, które mają zastosowanie również podczas uruchamiania projektów na platformie Azure.
LocalHttpPort Ustawia domyślny port używany podczas uruchamiania lokalnego hosta usługi Functions (func host start i func run). Opcja --port wiersza polecenia ma pierwszeństwo przed tym ustawieniem. Na przykład podczas uruchamiania w środowisku IDE programu Visual Studio można zmienić numer portu, przechodząc do okna "Właściwości projektu —> debugowanie" i jawnie określając numer portu w host start --port <your-port-number> poleceniu , które można podać w polu "Argumenty aplikacji".
CORS Definiuje źródła dozwolone dla współużytkowania zasobów między źródłami (CORS). Źródła są dostarczane jako lista rozdzielona przecinkami bez spacji. Wartość wieloznaczny (*) jest obsługiwana, co umożliwia żądania z dowolnego źródła.
CORSCredentials Gdy jest ustawiona wartość true, zezwala na withCredentials żądania.
ConnectionStrings Kolekcja. Nie używaj tej kolekcji dla parametrów połączenia używanych przez powiązania funkcji. Ta kolekcja jest używana tylko przez struktury, które zwykle pobierają parametry połączenia z ConnectionStrings sekcji pliku konfiguracji, takiego jak Entity Framework. Parametry połączenia w tym obiekcie są dodawane do środowiska z typem dostawcy System.Data.SqlClient. Elementy w tej kolekcji nie są publikowane na platformie Azure z innymi ustawieniami aplikacji. Należy jawnie dodać te wartości do Connection strings kolekcji ustawień aplikacji funkcji. Jeśli tworzysz element SqlConnection w kodzie funkcji, należy przechowywać wartość parametrów połączenia z innymi połączeniami w obszarze Ustawienia aplikacji w portalu.

Podczas uruchamiania lokalnego można uwzględnić następujące ustawienia aplikacji w tablicy Values :

Ustawienie Wartości Opis
AzureWebJobsStorage Parametry połączenia konta magazynu lub
UseDevelopmentStorage=true
Zawiera parametry połączenia dla konta usługi Azure Storage. Wymagane w przypadku korzystania z wyzwalaczy innych niż HTTP. Aby uzyskać więcej informacji, zobacz dokumentację AzureWebJobsStorage .
Po zainstalowaniu emulatora usługi Azurite lokalnie i ustawieniu go AzureWebJobsStorage na UseDevelopmentStorage=truewartość , narzędzia Core Tools używają emulatora. Aby uzyskać więcej informacji, zobacz Emulator magazynu lokalnego.
AzureWebJobs.<FUNCTION_NAME>.Disabled true|false Aby wyłączyć funkcję podczas uruchamiania lokalnie, dodaj "AzureWebJobs.<FUNCTION_NAME>.Disabled": "true" do kolekcji, gdzie <FUNCTION_NAME> jest nazwą funkcji. Aby dowiedzieć się więcej, zobacz Jak wyłączyć funkcje w Azure Functions.
FUNCTIONS_WORKER_RUNTIME dotnet
dotnet-isolated
node
java
powershell
python
Wskazuje docelowy język środowiska uruchomieniowego usługi Functions. Wymagane dla wersji 2.x i nowszej środowiska uruchomieniowego usługi Functions. To ustawienie jest generowane dla projektu przez narzędzia Core Tools. Aby dowiedzieć się więcej, zobacz dokumentację FUNCTIONS_WORKER_RUNTIME .
FUNCTIONS_WORKER_RUNTIME_VERSION ~7 Wskazuje, że używasz programu PowerShell 7 podczas uruchamiania lokalnego. Jeśli nie zostanie ustawiona, zostanie użyty program PowerShell Core 6. To ustawienie jest używane tylko w przypadku uruchamiania lokalnego. Wersja środowiska uruchomieniowego programu PowerShell jest określana przez powerShellVersion ustawienie konfiguracji lokacji, gdy jest uruchamiane na platformie Azure, które można ustawić w portalu.

Synchronizowanie ustawień

Podczas lokalnego opracowywania funkcji wszystkie ustawienia lokalne wymagane przez aplikację muszą być również obecne w ustawieniach aplikacji funkcji, do których wdrożono kod. Może być również konieczne pobranie bieżących ustawień z aplikacji funkcji do projektu lokalnego. Podczas ręcznego konfigurowania ustawień aplikacji w Azure Portal następujące narzędzia umożliwiają również synchronizowanie ustawień aplikacji z ustawieniami lokalnymi w projekcie:

Wyzwalacze i powiązania

Podczas lokalnego opracowywania funkcji należy wziąć pod uwagę zachowania wyzwalacza i powiązania. Najprostszym sposobem testowania powiązań podczas tworzenia lokalnego jest użycie parametrów połączenia przeznaczonych dla aktywnych usług platformy Azure. Usługi na żywo można kierować, dodając odpowiednie ustawienia parametrów połączenia w tablicy Values w pliku local.settings.json. W takim przypadku lokalne wykonania podczas testowania wpływają na dane usługi na żywo. W związku z tym rozważ skonfigurowanie oddzielnych usług do użycia podczas programowania i testowania, a następnie przełączenie się na usługi różnicowe podczas produkcji. Możesz również użyć lokalnego emulatora magazynu.

Emulator magazynu lokalnego

Podczas opracowywania lokalnego można użyć lokalnego emulatora usługi Azurite podczas testowania funkcji za pomocą powiązań usługi Azure Storage (Queue Storage, Blob Storage i Table Storage), bez konieczności nawiązywania połączenia z usługami zdalnego magazynu. Usługa Azurite integruje się z programem Visual Studio Code i programem Visual Studio, a także można go uruchomić z poziomu wiersza polecenia przy użyciu narzędzia npm. Aby uzyskać więcej informacji, zobacz Use the Azurite emulator for local Azure Storage development (Używanie emulatora Azurite do lokalnego programowania w usłudze Azure Storage).

Następujące ustawienie w Values kolekcji pliku local.settings.json informuje hosta usługi Functions lokalnego o użyciu usługi Azurite dla połączenia domyślnego AzureWebJobsStorage :

"AzureWebJobsStorage": "UseDevelopmentStorage=true"

To ustawienie jest włączone, każdy wyzwalacz usługi Azure Storage lub powiązanie, które używa AzureWebJobsStorage jako połączenia, łączy się z usługą Azurite podczas uruchamiania lokalnego. Podczas wykonywania lokalnego musisz mieć zainstalowaną i uruchomioną usługę Azurite. Emulator jest przydatny podczas programowania, ale przed wdrożeniem należy przetestować rzeczywiste połączenie magazynu. Podczas publikowania projektu nie publikuj tego ustawienia. Zamiast tego należy użyć parametrów połączenia usługi Azure Storage w tych samych ustawieniach w aplikacji funkcji na platformie Azure.

Następne kroki