Section courante

A propos

Section administrative du site

Configurer l'application

À propos de la configuration

Il y a des moments où vous devez éviter de coder en dur une valeur dans l'application, car vous devez la modifier sans avoir à reconstruire le binaire de l'application. Par exemple, vous devez pouvoir stocker les informations d'identification de la base de données dans la configuration plutôt que de les coder en dur, afin de pouvoir les modifier facilement.

Le Fano Framework fournit l'interface IAppConfiguration à cet effet.

IAppConfiguration

L'interface IAppConfiguration fournit plusieurs méthodes :

Méthodes Description
getString() Accepte le nom et renvoie la valeur de la chaîne de caractères.
getInt() Accepte le nom renvoie une valeur entière.
getBool() Accepte le nom renvoie une valeur booléenne.
getFloat() Accepte le nom renvoie une valeur double.
has() Tester si le nom existe dans la configuration.

Implémentation IAppConfiguration intégrée

Le Fano Framework fournit les classes TJsonFileConfig, TIniFileConfig, TEnvConfig chargeant les données de configuration à partir de JSON, du fichier INI et des variables d'environnement respectivement.

Le Fano Framework fournit également les classes TCompositeConfig et TNullConfig. La première est une implémentation IAppConfiguration avec la capacité de combiner deux instances IAppConfiguration et la seconde est une classe nulle qui implémente l'interface IAppConfiguration.

Charger la configuration à partir de JSON

  1. var config : IAppConfiguration;
  2. ...
  3. config := TJsonFileConfig.create(
  4.     getCurrentDir() + '/config/config.json'
  5. );

Charger la configuration depuis INI

  1. var config : IAppConfiguration;
  2. ...
  3. config := TIniFileConfig.create(
  4.     getCurrentDir() + '/config/config.ini',
  5.     'fano'
  6. );

Le dernier paramètre est le nom de la section par défaut à utiliser.

Charger la configuration à partir des variables d'environnement

  1. var config : IAppConfiguration;
  2. ...
  3. config := TEnvConfig.create();

Combinez plusieurs configurations en une seule

TCompositeConfig vous permet d'utiliser plusieurs configurations. Dans la configuration suivante, si la configuration n'est pas trouvée dans les variables d'environnement, il essaiera de la trouver dans config.json.

  1. var config : IAppConfiguration;
  2. ...
  3. config := TCompositeConfig.create(
  4.     TEnvConfig.create(),
  5.     TJsonFileConfig.create(
  6.         getCurrentDir() + '/config/config.json'
  7.     )
  8. );

Enregistrer l'instance de configuration dans le conteneur de dépendances

Pour pouvoir utiliser les classes TJsonFileConfig, TIniFileConfig, TEnvConfig, TCompositeConfig et TNullConfig avec le conteneur de dépendances, Fano Framework fournit les classes TJsonFileConfigFactory, TIniFileConfigFactory, TEnvConfigFactory, TCompositeConfigFactory et TNullConfigFactory vous permettant d'enregistrer les classes ci-dessus dans le conteneur.

Enregistrer la configuration JSON

  1. container.add(
  2.     'config',
  3.     TJsonFileConfigFactory.create(
  4.         getCurrentDir() + '/config/config.json'
  5.     )
  6. );

Enregistrer la configuration INI

  1. container.add(
  2.     'config',
  3.     TIniFileConfigFactory.create(
  4.         getCurrentDir() + '/config/config.ini'
  5.     )
  6. );

Enregistrer la variable d'environnement de configuration

  1. container.add(
  2.     'config',
  3.     TEnvConfigFactory.create()
  4. );

Enregistrer les configurations composites

  1. container.add(
  2.     'config',
  3.     TCompositeConfigFactory.create(
  4.         TNullConfigFactory.create(),
  5.         TJsonFileConfigFactory.create(getCurrentDir() + '/config/config.json')
  6.     )
  7. );

Récupérer l'instance de configuration à partir du conteneur de dépendances

Pour obtenir l'instance de configuration :

  1. var config : IAppConfiguration;
  2. ...
  3. config := container.get('config') as IAppConfiguration;

ou avec une syntaxe de type tableau :

  1. config:=container['config'] as IAppConfiguration;

Lire les données de configuration

Supposons que vous ayez un fichier JSON avec le contenu suivant :

  1. {
  2.     "appName" : "MonApp",
  3.  
  4.     "baseUrl" : "http://monapp.fano",
  5.  
  6.     "session" : {
  7.         "name" : "fano_sess",
  8.         "dir" : "storages/sessions/"
  9.     },
  10.  
  11.     "cookie" : {
  12.         "domain" : "myapp.fano",
  13.         "maxAge" : 3600
  14.     }
  15. }

Pour obtenir la valeur baseUrl :

  1. Var baseUrl:String;
  2. ...
  3. baseUrl:=config.getString('baseUrl');

Pour obtenir la valeur dir :

  1. Var sessionDir:Integer;
  2. ...
  3. sessionDir:=config.getString('session.dir');

Pour obtenir la valeur maxAge :

  1. Var cookieMaxAge:Integer;
  2. ...
  3. cookieMaxAge:=config.getInt('cookie.maxAge');

Les méthodes getString(), getInt(), getBool() et getFloat() acceptent le deuxième paramètre si vous souhaitez utiliser une valeur différente lorsque la clef n'existe pas.

  1. baseUrl:=config.getString('baseUrl', 'https://exemple.com');

Si la clef baseUrl n'est pas trouvée, elle renvoie la valeur du deuxième paramètre.

Configuration du fichier INI

TIniFileConfig est un enveloppe léger de TIniFile de Free Pascal. TIniFile ne peut pas lire les données d'un fichier INI n'ayant pas de section. Votre fichier INI doit contenir au moins une section servant de section par défaut. Le dernier paramètre du constructeur de TIniFileConfig attend le nom de la section par défaut. Si vous utilisez TIniFileConfigFactory, par défaut, il utilise Fano comme section par défaut si elle n'est pas spécifiée. Vous pouvez spécifier la section par défaut en appelant la méthode setDefaultSection() comme indiqué dans le code suivant :

  1. container.add(
  2.     'config',
  3.     TIniFileConfigFactory.create(
  4.         getCurrentDir() + '/config/config.ini'
  5.     ).setDefaultSection('hello')
  6. );

Pensez à lire la configuration cookie.maxAge dans l'exemple de code ci-dessus. Il lira maxAge à partir de la section cookie.

[cookie]
maxAge=3600

Cependant, comme les sections imbriquées ne sont pas autorisées dans le fichier INI, vous ne pouvez en lire qu'une seule. Par exemple :

  1. nestedData:=config.getInt('fano.data.nested');

lira les données de :

[fano]
data.nested=test

Configuration de l'application avec Fano CLI

Lors de la création d'un nouveau projet, vous pouvez utiliser le paramètre --config pour configurer la configuration de l'application.

Vous pouvez également définir manuellement la configuration de l'application en remplaçant la méthode buildAppConfig() de la classe TBasicAppServiceProvider ou TDaemonAppServiceProvider comme indiqué dans l'exemple de code suivant :

  1. TAppServiceProvider=Class(TDaemonAppServiceProvider)
  2.  Protected
  3.     function buildAppConfig(
  4.         Const container:IDependencyContainer
  5.     ):IAppConfiguration; Override;
  6.     ...
  7. End;
  8.  
  9. ...
  10.  
  11. Function TAppServiceProvider.buildAppConfig(
  12.     Const Container:IDependencyContainer
  13. ):IAppConfiguration;
  14. Begin
  15.     container.add(
  16.         'config',
  17.         TIniFileConfigFactory.create(
  18.             getCurrentDir() + '/config/config.ini'
  19.         )
  20.     );
  21.     Result:=container['config'] as IAppConfiguration;
  22. End;

Dernière mise à jour : Vendredi, le 18 octobre 2024