Guide pratique pour paramétrer les fichiers de configuration dans Service Fabric

  • Article

Cet article vous explique comment paramétrer un fichier de configuration dans Service Fabric. Si vous n’êtes pas déjà familiarisé avec les concepts fondamentaux de la gestion des applications pour plusieurs environnements, consultez Gérer des applications pour plusieurs environnements.

Procédure de paramétrage des fichiers de configuration

Dans cet exemple, vous remplacez une valeur de configuration à l’aide de paramètres dans le déploiement de votre application.

  1. Ouvrez le fichier <MyService>\PackageRoot\Config\Settings.xml dans votre projet de service.

  2. Définissez un nom de paramètre de configuration et une valeur, par exemple la taille du cache égale à 25, en ajoutant le code XML suivant :

     <Section Name="MyConfigSection">
   <Parameter Name="CacheSize" Value="25" />
 </Section>

  3. Enregistrez et fermez le fichier.

  4. Ouvrez le fichier <MyApplication>\ApplicationPackageRoot\ApplicationManifest.xml.

  5. Dans le fichier ApplicationManifest.xml, déclarez une valeur de paramètre et une valeur par défaut dans l’élément Parameters. Il est recommandé que le nom du paramètre contienne le nom du service (par exemple, « MyService »).

     <Parameters>
   <Parameter Name="MyService_CacheSize" DefaultValue="80" />
 </Parameters>

  6. Dans la section ServiceManifestImport du fichier ApplicationManifest.xml, ajoutez des éléments ConfigOverrides et ConfigOverride référençant le package de configuration, la section et le paramètre.

     <ConfigOverrides>
   <ConfigOverride Name="Config">
       <Settings>
         <Section Name="MyConfigSection">
             <Parameter Name="CacheSize" Value="[MyService_CacheSize]" />
         </Section>
       </Settings>
   </ConfigOverride>
 </ConfigOverrides>

Notes

Si vous ajoutez un élément ConfigOverride, Service Fabric choisit toujours les paramètres d’application ou la valeur par défaut spécifiée dans le manifeste d’application.

Accéder aux configurations paramétrisées dans le code

Vous pouvez accéder à la configuration dans votre fichier settings.xml par programmation. Prenons l’exemple du fichier XML de configuration suivant :

<Settings
	xmlns:xsd="http://www.w3.org/2001/XMLSchema"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns="http://schemas.microsoft.com/2011/01/fabric">
	<!-- Add your custom configuration sections and parameters here -->
	<Section Name="MyConfigSection">
		<Parameter Name="MyParameter" Value="Value1" />
	</Section>
</Settings>

Utilisez le code suivant pour accéder aux paramètres :

CodePackageActivationContext context = FabricRuntime.GetActivationContext();
var configSettings = context.GetConfigurationPackageObject("Config").Settings;
var data = configSettings.Sections["MyConfigSection"];
foreach (var parameter in data.Parameters)
{
  ServiceEventSource.Current.ServiceMessage(this.Context, "Working-{0} - {1}", parameter.Name, parameter.Value);
}

Ici, Parameter.Name sera MyParameter et Parameter.Value sera Value1

Étapes suivantes

Pour plus d’informations sur les autres fonctionnalités de gestion d’application disponibles dans Visual Studio, consultez la section Gestion de vos applications de Service Fabric dans Visual Studio.