Självstudie: Använda dynamisk konfiguration i en .NET Framework-app

Data från App Configuration kan läsas in när app Inställningar i en .NET Framework-app. Mer information finns i snabbstarten. Som har utformats av .NET Framework kan app-Inställningar dock bara uppdateras när appen startas om. .NET-providern för appkonfiguration är ett .NET Standard-bibliotek. Den stöder cachelagring och uppdatering av konfigurationen dynamiskt utan omstart av appen. Den här självstudien visar hur du kan implementera dynamiska konfigurationsuppdateringar i en .NET Framework-konsolapp.

I den här självstudien lär du dig att:

  • Konfigurera .NET Framework-appen för att uppdatera konfigurationen som svar på ändringar i ett appkonfigurationsarkiv.
  • Mata in den senaste konfigurationen i ditt program.

Förutsättningar

Lägga till ett nyckelvärde

Lägg till följande nyckelvärde i appkonfigurationsarkivet och lämna Etikett och innehållstyp med sina standardvärden. Mer information om hur du lägger till nyckelvärden i ett arkiv med hjälp av Azure-portalen eller CLI finns i Skapa ett nyckelvärde.

Tangent Värde
TestApp:Inställningar:Message Data från Azure App Configuration

Skapa en .NET Framework-konsolapp

  1. Starta Visual Studio och välj Skapa ett nytt projekt.

  2. I Skapa ett nytt projekt filtrerar du på projekttypen Konsol och väljer Konsolapp (.NET Framework) med C# i listan med projektmallar. Tryck på Nästa.

  3. I Konfigurera det nya projektet anger du ett projektnamn. Under Framework väljer du .NET Framework 4.7.2 eller senare. Tryck på Skapa.

Läsa in data på nytt från App Configuration

  1. Högerklicka på projektet och välj Hantera NuGet-paket. På fliken Bläddra söker du efter och lägger till den senaste versionen av följande NuGet-paket i projektet.

    Microsoft.Extensions.Configuration.AzureAppConfiguration

  2. Öppna Program.cs och lägg till följande namnområden.

    using Microsoft.Extensions.Configuration;
    using Microsoft.Extensions.Configuration.AzureAppConfiguration;
    
  3. Lägg till två variabler för att lagra konfigurationsrelaterade objekt.

    private static IConfiguration _configuration;
    private static IConfigurationRefresher _refresher;
    
  4. Main Uppdatera metoden för att ansluta till App Configuration med de angivna uppdateringsalternativen.

    static void Main(string[] args)
    {
        var builder = new ConfigurationBuilder();
        builder.AddAzureAppConfiguration(options =>
        {
            options.Connect(Environment.GetEnvironmentVariable("ConnectionString"))
                    // Load all keys that start with `TestApp:`.
                    .Select("TestApp:*")
                    // Configure to reload the key 'TestApp:Settings:Message' if it is modified.
                    .ConfigureRefresh(refresh =>
                    {
                        refresh.Register("TestApp:Settings:Message")
                               .SetCacheExpiration(TimeSpan.FromSeconds(10));
                    });
    
            _refresher = options.GetRefresher();
        });
    
        _configuration = builder.Build();
        PrintMessage().Wait();
    }
    

    ConfigureRefresh I metoden registreras en nyckel i appkonfigurationsarkivet för ändringsövervakning. Metoden Register har en valfri boolesk parameter refreshAll som kan användas för att ange om alla konfigurationsvärden ska uppdateras om den registrerade nyckeln ändras. I det här exemplet uppdateras bara nyckeln TestApp:Inställningar:Message. Metoden SetCacheExpiration anger den minsta tid som måste förflutit innan en ny begäran görs till App Configuration för att söka efter konfigurationsändringar. I det här exemplet åsidosätter du standardförfallotiden på 30 sekunder och anger en tid på 10 sekunder i stället för demonstration.

  5. Lägg till en metod med namnet PrintMessage() som utlöser en uppdatering av konfigurationsdata från App Configuration.

    private static async Task PrintMessage()
    {
        Console.WriteLine(_configuration["TestApp:Settings:Message"] ?? "Hello world!");
    
        // Wait for the user to press Enter
        Console.ReadLine();
    
        await _refresher.TryRefreshAsync();
        Console.WriteLine(_configuration["TestApp:Settings:Message"] ?? "Hello world!");
    }
    

    ConfigureRefresh Om du anropar metoden ensam uppdateras inte konfigurationen automatiskt. Du anropar TryRefreshAsync metoden från gränssnittet IConfigurationRefresher för att utlösa en uppdatering. Den här designen är att undvika begäranden som skickas till App Configuration även när programmet är inaktivt. Du kan inkludera samtalet TryRefreshAsync där du anser att ditt program är aktivt. Det kan till exempel vara när du bearbetar ett inkommande meddelande, en order eller en iteration av en komplex uppgift. Det kan också vara i en timer om ditt program är aktivt hela tiden. I det här exemplet anropar TryRefreshAsync du när du trycker på Retur-tangenten. Observera att även om anropet TryRefreshAsync misslyckas av någon anledning fortsätter programmet att använda den cachelagrade konfigurationen. Ett annat försök görs när den konfigurerade cachens förfallotid har passerat och anropet utlöses av programaktiviteten TryRefreshAsync igen. Anrop TryRefreshAsync är en no-op innan den konfigurerade förfallotiden för cachen förflutit, så dess prestandapåverkan är minimal, även om den anropas ofta.

Skapa och köra appen lokalt

  1. Ange en miljövariabel med namnet Anslut ionString till den skrivskyddade nyckeln anslutningssträng som erhölls när appkonfigurationsarkivet skapades.

    Om du använder Windows-kommandotolken kör du följande kommando:

    setx ConnectionString "connection-string-of-your-app-configuration-store"
    

    Om du använder Windows PowerShell kör du följande kommando:

    $Env:ConnectionString = "connection-string-of-your-app-configuration-store"
    
  2. Starta om Visual Studio så att ändringen börjar gälla.

  3. Tryck på Ctrl + F5 för att skapa och köra konsolappen.

    App launch local

  4. I Azure-portalen går du till Konfigurationsutforskaren för appkonfigurationsarkivet och uppdaterar värdet för följande nyckel.

    Tangent Värde
    TestApp:Inställningar:Message Data från Azure App Configuration – Uppdaterad
  5. I det program som körs trycker du på Retur för att utlösa en uppdatering och skriver ut det uppdaterade värdet i kommandotolken eller PowerShell-fönstret.

    App refresh local

    Kommentar

    Eftersom förfallotiden för cacheminnet har angetts till 10 sekunder med hjälp av SetCacheExpiration metoden när konfigurationen för uppdateringsåtgärden angavs uppdateras endast värdet för konfigurationsinställningen om minst 10 sekunder har förflutit sedan den senaste uppdateringen för den inställningen.

Rensa resurser

Om du inte vill fortsätta använda resurserna som skapas i den här artikeln tar du bort resursgruppen som du skapade här för att undvika avgifter.

Viktigt!

Att ta bort en resursgrupp kan inte ångras. Resursgruppen och alla resurser i den tas bort permanent. Se till att du inte oavsiktligt tar bort fel resursgrupp eller resurser. Om du har skapat resurserna för den här artikeln i en resursgrupp som innehåller andra resurser som du vill behålla tar du bort varje resurs individuellt från respektive fönster i stället för att ta bort resursgruppen.

  1. Logga in på Azure-portalen och välj Resursgrupper.
  2. I rutan Filtrera efter namn anger du namnet på resursgruppen.
  3. I resultatlistan väljer du resursgruppens namn för att se en översikt.
  4. Välj Ta bort resursgrupp.
  5. Du blir ombedd att bekräfta borttagningen av resursgruppen. Ange namnet på resursgruppen för att bekräfta och välj Ta bort.

Efter en liten stund tas resursgruppen och alla dess resurser bort.

Nästa steg

I den här självstudien har du aktiverat .NET Framework-appen för att dynamiskt uppdatera konfigurationsinställningarna från App Configuration. Om du vill lära dig hur du aktiverar dynamisk konfiguration i ett ASP.NET webbprogram (.NET Framework) fortsätter du till nästa självstudie:

Om du vill lära dig hur du använder en hanterad Azure-identitet för att effektivisera åtkomsten till App Configuration fortsätter du till nästa självstudie: