Udostępnij za pośrednictwem

Tworzenie aplikacji Node.js przy użyciu zestawu Azure SDK dla języka JavaScript

  • Artykuł

W tym dokumencie przedstawiono przykłady używania zestawu Azure SDK dla języka JavaScript do uzyskiwania dostępu do par klucz-wartości w usłudze aplikacja systemu Azure Configuration.

Napiwek

Usługa App Configuration oferuje bibliotekę dostawcy języka JavaScript, która jest oparta na zestawie SDK języka JavaScript i została zaprojektowana tak, aby ułatwić korzystanie z bogatszych funkcji. Umożliwia ona używanie ustawień konfiguracji, takich jak obiekt Mapy, i oferuje inne funkcje, takie jak kompozycja konfiguracji z wielu etykiet, przycinanie nazw kluczy i automatyczne rozpoznawanie odwołań usługi Key Vault. Przejdź do przewodnika Szybki start dla języka JavaScript, aby dowiedzieć się więcej.

Wymagania wstępne

Tworzenie wartości klucz-wartość

Dodaj następującą wartość klucza do magazynu App Configuration i pozostaw wartości domyślne Etykieta i Typ zawartości. Aby uzyskać więcej informacji na temat dodawania wartości klucz-wartości do magazynu przy użyciu witryny Azure Portal lub interfejsu wiersza polecenia, przejdź do artykułu Create a key-value (Tworzenie wartości klucza).

Key Wartość
TestApp:Settings:Message Dane z usługi Azure App Configuration

Konfigurowanie aplikacji Node.js

  1. W tym samouczku utworzysz nowy katalog dla projektu o nazwie app-configuration-example.

    mkdir app-configuration-example

  2. Przejdź do nowo utworzonego katalogu app-configuration-example .

    cd app-configuration-example

  3. Zainstaluj bibliotekę klienta aplikacja systemu Azure Configuration przy użyciu npm install polecenia .

    npm install @azure/app-configuration

  4. Utwórz nowy plik o nazwie app-configuration-example.js w katalogu app-configuration-example i dodaj następujący kod:

    const { AppConfigurationClient } = require("@azure/app-configuration");

async function run() {
  console.log("Azure App Configuration - JavaScript example");
  // Example code goes here
}

run().catch(console.error);

Uwaga

Fragmenty kodu w tym przykładzie ułatwią rozpoczęcie pracy z biblioteką klienta usługi App Configuration dla języka JavaScript. W przypadku aplikacji należy również rozważyć obsługę wyjątków zgodnie z potrzebami. Aby dowiedzieć się więcej na temat obsługi wyjątków, zapoznaj się z naszą dokumentacją zestawu SDK języka JavaScript.

Konfigurowanie parametry połączenia usługi App Configuration

  1. Ustaw zmienną środowiskową o nazwie AZURE_APPCONFIG_CONNECTION_STRING i ustaw ją na parametry połączenia magazynu App Configuration. W wierszu polecenia uruchom następujące polecenie:

    Aby uruchomić aplikację lokalnie przy użyciu wiersza polecenia systemu Windows, uruchom następujące polecenie i zastąp <app-configuration-store-connection-string> parametry połączenia magazynu konfiguracji aplikacji:

    setx AZURE_APPCONFIG_CONNECTION_STRING "<app-configuration-store-connection-string>"

  2. Wyświetl wartość zmiennej środowiskowej, aby sprawdzić, czy jest ona poprawnie ustawiona za pomocą poniższego polecenia.

    Korzystając z wiersza polecenia systemu Windows, uruchom ponownie wiersz polecenia, aby zezwolić na wprowadzenie zmiany i uruchomić następujące polecenie:

    echo %AZURE_APPCONFIG_CONNECTION_STRING%

Przykłady kodu

W przykładowych fragmentach kodu w tej sekcji pokazano, jak wykonywać typowe operacje za pomocą biblioteki klienta usługi App Configuration dla języka JavaScript. Dodaj te fragmenty kodu do treści run funkcji w utworzonym wcześniej pliku app-configuration-example.js .

Uwaga

Biblioteka klienta usługi App Configuration odwołuje się do obiektu klucz-wartość jako ConfigurationSetting. W związku z tym w tym artykule wartości klucza w magazynie App Configuration będą określane jako ustawienia konfiguracji.

Dowiedz się poniżej, jak:

Połączenie do magazynu usługi App Configuration

Poniższy fragment kodu tworzy wystąpienie klasy AppConfigurationClient przy użyciu parametry połączenia przechowywanych w zmiennych środowiskowych.

const connection_string = process.env.AZURE_APPCONFIG_CONNECTION_STRING;
const client = new AppConfigurationClient(connection_string);

Pobieranie ustawienia konfiguracji

Poniższy fragment kodu pobiera ustawienie konfiguracji według key nazwy.

    const retrievedConfigSetting = await client.getConfigurationSetting({
        key: "TestApp:Settings:Message"
    });
    console.log("\nRetrieved configuration setting:");
    console.log(`Key: ${retrievedConfigSetting.key}, Value: ${retrievedConfigSetting.value}`);

Dodawanie ustawienia konfiguracji

Poniższy fragment kodu tworzy ConfigurationSetting obiekt z polami key i value i wywołuje metodę addConfigurationSetting . Ta metoda zgłosi wyjątek, jeśli spróbujesz dodać ustawienie konfiguracji, które już istnieje w twoim sklepie. Jeśli chcesz uniknąć tego wyjątku, zamiast tego można użyć metody setConfigurationSetting .

    const configSetting = {
        key:"TestApp:Settings:NewSetting",
        value:"New setting value"
    };
    const addedConfigSetting = await client.addConfigurationSetting(configSetting);
    console.log("\nAdded configuration setting:");
    console.log(`Key: ${addedConfigSetting.key}, Value: ${addedConfigSetting.value}`);

Pobieranie listy ustawień konfiguracji

Poniższy fragment kodu pobiera listę ustawień konfiguracji. Argumenty keyFilter i labelFilter można podać, aby filtrować wartości klucz-wartości odpowiednio na key podstawie i label . Aby uzyskać więcej informacji na temat filtrowania, zobacz jak wykonywać zapytania dotyczące ustawień konfiguracji.

    const filteredSettingsList = client.listConfigurationSettings({
        keyFilter: "TestApp*"
    });
    console.log("\nRetrieved list of configuration settings:");
    for await (const filteredSetting of filteredSettingsList) {
        console.log(`Key: ${filteredSetting.key}, Value: ${filteredSetting.value}`);
    }

Blokowanie ustawienia konfiguracji

Stan blokady klucz-wartość w usłudze App Configuration jest oznaczany przez readOnly atrybut ConfigurationSetting obiektu. Jeśli readOnly wartość to true, ustawienie jest zablokowane. Metodę setReadOnly można wywołać za pomocą true polecenia jako drugi argument, aby zablokować ustawienie konfiguracji.

    const lockedConfigSetting = await client.setReadOnly(addedConfigSetting, true /** readOnly */);
    console.log(`\nRead-only status for ${lockedConfigSetting.key}: ${lockedConfigSetting.isReadOnly}`);

Odblokowywanie ustawienia konfiguracji

Jeśli atrybut elementu readOnly ConfigurationSetting to false, ustawienie jest odblokowane. Metodę setReadOnly można wywołać false jako drugi argument, aby odblokować ustawienie konfiguracji.

    const unlockedConfigSetting = await client.setReadOnly(lockedConfigSetting, false /** readOnly */);
    console.log(`\nRead-only status for ${unlockedConfigSetting.key}: ${unlockedConfigSetting.isReadOnly}`);

Aktualizowanie ustawienia konfiguracji

Metody setConfigurationSetting można użyć do zaktualizowania istniejącego ustawienia lub utworzenia nowego ustawienia. Poniższy fragment kodu zmienia wartość istniejącego ustawienia konfiguracji.

    addedConfigSetting.value = "Value has been updated!";
    const updatedConfigSetting = await client.setConfigurationSetting(addedConfigSetting);
    console.log("\nUpdated configuration setting:");
    console.log(`Key: ${updatedConfigSetting.key}, Value: ${updatedConfigSetting.value}`);

Usuwanie ustawienia konfiguracji

Poniższy fragment kodu usuwa ustawienie konfiguracji według key nazwy.

    const deletedConfigSetting = await client.deleteConfigurationSetting({
        key: "TestApp:Settings:NewSetting"
    });
    console.log("\nDeleted configuration setting:");
    console.log(`Key: ${deletedConfigSetting.key}, Value: ${deletedConfigSetting.value}`);

Uruchom aplikację

W tym przykładzie utworzono aplikację Node.js, która używa biblioteki klienta aplikacja systemu Azure Configuration do pobierania ustawienia konfiguracji utworzonego za pośrednictwem witryny Azure Portal, dodawania nowego ustawienia, pobierania listy istniejących ustawień, blokowania i odblokowywania ustawienia, aktualizowania ustawienia i usuwania ustawienia.

Na tym etapie plik app-configuration-example.js powinien mieć następujący kod:

const { AppConfigurationClient } = require("@azure/app-configuration");

async function run() {
    console.log("Azure App Configuration - JavaScript example");

    const connection_string = process.env.AZURE_APPCONFIG_CONNECTION_STRING;
    const client = new AppConfigurationClient(connection_string);

    const retrievedConfigSetting = await client.getConfigurationSetting({
        key: "TestApp:Settings:Message"
    });
    console.log("\nRetrieved configuration setting:");
    console.log(`Key: ${retrievedConfigSetting.key}, Value: ${retrievedConfigSetting.value}`);

    const configSetting = {
        key: "TestApp:Settings:NewSetting",
        value: "New setting value"
    };
    const addedConfigSetting = await client.addConfigurationSetting(configSetting);
    console.log("Added configuration setting:");
    console.log(`Key: ${addedConfigSetting.key}, Value: ${addedConfigSetting.value}`);

    const filteredSettingsList = client.listConfigurationSettings({
        keyFilter: "TestApp*"
    });
    console.log("Retrieved list of configuration settings:");
    for await (const filteredSetting of filteredSettingsList) {
        console.log(`Key: ${filteredSetting.key}, Value: ${filteredSetting.value}`);
    }

    const lockedConfigSetting = await client.setReadOnly(addedConfigSetting, true /** readOnly */);
    console.log(`Read-only status for ${lockedConfigSetting.key}: ${lockedConfigSetting.isReadOnly}`);

    const unlockedConfigSetting = await client.setReadOnly(lockedConfigSetting, false /** readOnly */);
    console.log(`Read-only status for ${unlockedConfigSetting.key}: ${unlockedConfigSetting.isReadOnly}`);

    addedConfigSetting.value = "Value has been updated!";
    const updatedConfigSetting = await client.setConfigurationSetting(addedConfigSetting);
    console.log("Updated configuration setting:");
    console.log(`Key: ${updatedConfigSetting.key}, Value: ${updatedConfigSetting.value}`);

    const deletedConfigSetting = await client.deleteConfigurationSetting({
        key: "TestApp:Settings:NewSetting"
    });
    console.log("Deleted configuration setting:");
    console.log(`Key: ${deletedConfigSetting.key}, Value: ${deletedConfigSetting.value}`);
}

run().catch(console.error);

W oknie konsoli przejdź do katalogu zawierającego plik app-configuration-example.js i wykonaj następujące polecenie, aby uruchomić aplikację:

node app.js

Powinny zostać wyświetlone następujące dane wyjściowe:

Azure App Configuration - JavaScript example

Retrieved configuration setting:
Key: TestApp:Settings:Message, Value: Data from Azure App Configuration

Added configuration setting:
Key: TestApp:Settings:NewSetting, Value: New setting value

Retrieved list of configuration settings:
Key: TestApp:Settings:Message, Value: Data from Azure App Configuration
Key: TestApp:Settings:NewSetting, Value: New setting value

Read-only status for TestApp:Settings:NewSetting: true

Read-only status for TestApp:Settings:NewSetting: false

Updated configuration setting:
Key: TestApp:Settings:NewSetting, Value: Value has been updated!

Deleted configuration setting:
Key: TestApp:Settings:NewSetting, Value: Value has been updated!

Czyszczenie zasobów

Jeśli nie chcesz nadal korzystać z zasobów utworzonych w tym artykule, usuń utworzoną tutaj grupę zasobów, aby uniknąć naliczania opłat.

Ważne

Usunięcie grupy zasobów jest nieodwracalne. Grupa zasobów i wszystkie zasoby w niej są trwale usuwane. Upewnij się, że nie usuniesz przypadkowo nieprawidłowej grupy zasobów ani zasobów. Jeśli zasoby dla tego artykułu zostały utworzone w grupie zasobów zawierającej inne zasoby, które chcesz zachować, usuń każdy zasób oddzielnie z odpowiedniego okienka zamiast usuwać grupę zasobów.

  1. Zaloguj się do witryny Azure Portal i wybierz pozycję Grupy zasobów.
  2. W polu Filtruj według nazwy wprowadź nazwę grupy zasobów.
  3. Na liście wyników wybierz nazwę grupy zasobów, aby wyświetlić przegląd.
  4. Wybierz pozycję Usuń grupę zasobów.
  5. Zobaczysz prośbę o potwierdzenie usunięcia grupy zasobów. Wprowadź nazwę grupy zasobów, aby potwierdzić, a następnie wybierz pozycję Usuń.

Po kilku chwilach grupa zasobów i wszystkie jej zasoby zostaną usunięte.

Następne kroki

W tym przewodniku pokazano, jak używać zestawu Azure SDK dla języka JavaScript do uzyskiwania dostępu do par klucz-wartości w usłudze aplikacja systemu Azure Configuration.

Aby uzyskać dodatkowe przykłady kodu, odwiedź stronę:

przykłady biblioteki klienta usługi aplikacja systemu Azure Configuration

Aby dowiedzieć się, jak używać usługi aplikacja systemu Azure Configuration z aplikacjami JavaScript, przejdź do:

Tworzenie aplikacji JavaScript przy użyciu usługi aplikacja systemu Azure Configuration