Tutoriel : Utiliser la configuration dynamique dans une application web ASP.NET (.NET Framework)

Les données d’App Configuration peuvent être chargées en tant que paramètres de l’application dans une application .NET Framework. Pour plus d’informations, consultez le guide de démarrage rapide. Toutefois, comme conçu par le .NET Framework, les paramètres de l’application ne peuvent être actualisés que lors du redémarrage de l’application. Le fournisseur .NET d’App Configuration est une bibliothèque .NET Standard. Il prend en charge la mise en cache et l’actualisation dynamiques de la configuration sans redémarrage de l’application. Ce tutoriel vous montre comment vous pouvez implémenter des mises à jour de configuration dynamiques dans une application ASP.NET Web Forms. La même technique s’applique aux applications MVC.NET Framework .

Dans ce tutoriel, vous allez apprendre à :

Prérequis

• Compte Azure avec un abonnement actif. Créez-en un gratuitement.
• Un magasin App Configuration. Créez un magasin.
• Visual Studio
• .NET Framework 4.7.2 ou version ultérieure

Ajouter des clés-valeurs

Ajoutez les clés-valeurs suivantes au magasin App Configuration et conservez les valeurs par défaut des options Étiquette et Type de contenu. Pour plus d’informations sur l’ajout de clés-valeurs à un magasin avec le Portail Azure ou l’interface CLI, consultez Création d’une clé-valeur.

Créer une application web ASP.NET

1. Démarrez Visual Studio et sélectionnez Créer un projet.

2. Sélectionnez Application Web ASP.NET (.NET Framework) avec C# dans la liste des modèles de projet, puis appuyez sur Suivant.

3. Dans Configurer votre nouveau projet , entrez un nom de projet. Sous Framework, sélectionnez .NET Framework 4.7.2 ou une version ultérieure. Appuyez sur Créer.

4. Dans Créer une application web ASP.NET, sélectionnez Web Forms. Appuyez sur Créer.

Recharger des données à partir d’Azure App Configuration

1. Cliquez avec le bouton droit sur votre projet, puis sélectionnez Gérer les packages NuGet. Sous l’onglet Parcourir, recherchez et ajoutez la dernière version du package NuGet suivant à votre projet.

   Microsoft.Extensions.Configuration.AzureAppConfiguration

2. Ouvrez le fichier Global.asax.cs et ajoutez les espaces de noms suivants.

   using Microsoft.Extensions.Configuration;
   using Microsoft.Extensions.Configuration.AzureAppConfiguration;
   

3. Ajoutez les variables membres statiques suivantes à la classe Global.

   public static IConfiguration Configuration;
   private static IConfigurationRefresher _configurationRefresher;
   

4. Ajoutez une méthode Application_Start à la classe Global. Si la méthode existe déjà, ajoutez-lui le code suivant.

   protected void Application_Start(object sender, EventArgs e)
   {
       ConfigurationBuilder builder = new ConfigurationBuilder();
       builder.AddAzureAppConfiguration(options =>
       {
           options.Connect(Environment.GetEnvironmentVariable("ConnectionString"))
                   // Load all keys that start with `TestApp:` and have no label.
                   .Select("TestApp:*")
                   // Configure to reload configuration if the registered key 'TestApp:Settings:Sentinel' is modified.
                   .ConfigureRefresh(refresh => 
                   {
                       refresh.Register("TestApp:Settings:Sentinel", refreshAll:true)
                              .SetCacheExpiration(new TimeSpan(0, 5, 0));
                   });
           _configurationRefresher = options.GetRefresher();
       });
   
       Configuration = builder.Build();
   }
   

   La méthode Application_Start est appelée lors de la première demande adressée à votre application web. Elle est appelée une seule fois pendant le cycle de vie de l’application. Il s’agit donc de l’endroit approprié pour initialiser votre objet IConfiguration et charger des données à partir d’App Configuration.

   Dans la méthode ConfigureRefresh, une clé de votre magasin App Configuration est inscrite pour la supervision des changements. Le paramètre refreshAll de la méthode Register indique que toutes les valeurs de configuration doivent être actualisées si la clé inscrite change. Dans cette exemple, la clé TestApp:Settings:Sentinel est une clé Sentinel que vous mettez à jour après avoir changé toutes les autres clés. Lorsqu'un changement est détecté, votre application actualise toutes les valeurs de configuration. Cette approche permet de garantir la cohérence de la configuration dans votre application par rapport à la supervision de toutes les clés pour les changements.

   La méthode SetCacheExpiration spécifie le temps minimum qui doit s'écouler avant qu'une nouvelle requête puisse être adressée à App Configuration pour rechercher les changements de configuration. Dans cet exemple, vous modifiez le délai d’expiration en remplaçant 30 secondes par 5 minutes. Cela réduit le nombre potentiel de demandes adressées à votre magasin App Configuration.

5. Ajoutez une méthode Application_BeginRequest à la classe Global. Si la méthode existe déjà, ajoutez-lui le code suivant.

   protected void Application_BeginRequest(object sender, EventArgs e)
   {
       _ = _configurationRefresher.TryRefreshAsync();
   }
   

   L’appel de la méthode ConfigureRefresh seule n’entraîne pas l’actualisation automatique de la configuration. Vous appelez la méthode TryRefreshAsync au début de chaque demande pour signaler une actualisation. Cette conception garantit que votre application envoie des demandes à App Configuration uniquement lorsqu’elle reçoit activement des demandes.

   L’appel de TryRefreshAsync n’a aucun effet avant l’expiration du délai du cache configuré. Son impact sur les performances est donc minimal. Quand une demande est soumise à App Configuration, comme vous ne restez pas sur la tâche, la configuration est actualisée de manière asynchrone sans bloquer l’exécution de la demande actuelle. La demande actuelle peut ne pas obtenir les valeurs de configuration mises à jour, contrairement aux demandes suivantes.

   Même en cas d’échec de l’appel de TryRefreshAsync pour une raison quelconque, votre application continue à utiliser la configuration mise en cache. Une autre tentative a lieu quand le délai d’expiration du cache configuré est à nouveau écoulé, et l’appel de TryRefreshAsync est déclenché par une nouvelle demande soumise à votre application.

Utiliser les données de configuration les plus récentes

1. Ouvrez Default.aspx et remplacez son contenu par le balisage suivant. Assurez-vous que l’attribut Inherits correspond à l’espace de noms et au nom de classe de votre application.

   <%@ Page Language="C#" AutoEventWireup="true" CodeBehind="Default.aspx.cs" Inherits="WebFormApp.Default" %>
   
   <!DOCTYPE html>
   
   <html xmlns="http://www.w3.org/1999/xhtml">
   <head runat="server">
       <title>Azure App Configuration Web Forms Demo</title>
   </head>
   <body id="body" runat="server">
       <form id="form1" runat="server">
           <div style="text-align: center">
               <asp:Label ID="message" runat="server" />
           </div>
       </form>
   </body>
   </html>
   

2. Ouvrez le fichier Default.aspx.cs et mettez-le à jour avec le code suivant.

   using System;
   using System.Web.UI.WebControls;
   
   namespace WebFormApp
   {
       public partial class Default : System.Web.UI.Page
       {
           protected void Page_Load(object sender, EventArgs e)
           {
               // Read configuration from the IConfiguration object loaded from Azure App Configuration
               string messageText = Global.Configuration["TestApp:Settings:Message"] ?? "Please add the key \"TestApp:Settings:Message\" in your Azure App Configuration store.";
               string messageFontSize = Global.Configuration["TestApp:Settings:FontSize"] ?? "20";
               string messageFontColor = Global.Configuration["TestApp:Settings:FontColor"] ?? "Black";
               string backgroundColor = Global.Configuration["TestApp:Settings:BackgroundColor"] ?? "White";
   
               message.Text = messageText;
               message.Font.Size = FontUnit.Point(int.Parse(messageFontSize));
               message.ForeColor = System.Drawing.Color.FromName(messageFontColor);
               body.Attributes["bgcolor"] = backgroundColor;
           }
       }
   }
   

Génération et exécution de l’application

1. Définissez une variable d’environnement nommée ConnectionString sur la chaîne de connexion de la clé en lecture seule obtenue lors de la création du magasin App Configuration.

   Si vous utilisez l’invite de commandes Windows, exécutez la commande suivante :

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

   Si vous utilisez Windows PowerShell, exécutez la commande suivante :

   $Env:ConnectionString = "connection-string-of-your-app-configuration-store"
   

2. Redémarrez Visual Studio pour que la modification soit prise en compte.

3. Appuyez sur Ctrl+F5 pour générer et exécuter l’application web.

   

4. Dans le portail Azure, accédez à l’Explorateur de configurations de votre magasin App Configuration, puis mettez à jour la valeur des clés suivantes. Enfin, n’oubliez pas de mettre à jour la clé Sentinelle TestApp:Settings:Sentinel.

   Clé	Valeur
   TestApp:Settings:BackgroundColor	Vert
   TestApp:Settings:FontColor	LightGray
   TestApp:Settings:Message	Données provenant d’Azure App Configuration, avec maintenant des mises à jour automatiques !
   TestApp:Settings:Sentinel	v2

5. Actualisez la page de navigateur pour afficher les nouveaux paramètres de configuration. Vous devrez peut-être effectuer plusieurs actualisations pour que les changements soient pris en compte, ou redéfinir le délai d’expiration de votre cache sur une valeur inférieure à 5 minutes.

   

Nettoyer les ressources

Si vous ne souhaitez plus utiliser les ressources créées dans cet article, supprimez le groupe de ressources que vous avez créé ici afin d’éviter des frais.

1. Connectez-vous au portail Azure, puis sélectionnez Groupes de ressources.
2. Dans la zone Filtrer par nom, entrez le nom de votre groupe de ressources.
3. Dans la liste de résultats, sélectionnez le nom du groupe de ressources pour afficher une vue d’ensemble.
4. Sélectionnez Supprimer le groupe de ressources.
5. Vous êtes invité à confirmer la suppression du groupe de ressources. Entrez le nom de votre groupe de ressources à confirmer, puis sélectionnez Supprimer.

Après quelques instants, le groupe de ressources et toutes ses ressources sont supprimés.

Étapes suivantes

Dans ce tutoriel, vous avez permis à votre application ASP.NET Web Forms d’actualiser dynamiquement les paramètres de configuration à partir d’App Configuration. Pour savoir comment activer la configuration dynamique dans une application .NET Framework, passez au tutoriel suivant :

Pour savoir comment utiliser une identité managée Azure de façon à simplifier l’accès à App Configuration, passez au tutoriel suivant :