PropertiesFile4Delphi

Fichier de propriétés pour Delphi

PropertiesFile4Delphi se compose d'une bibliothèque pour gérer les fichiers de configuration au format clé = valeur .

À propos du projet

Plusieurs fois, pour diverses raisons, il est nécessaire de paramétrer l'application à partir d'un mécanisme de configuration. Dans Delphi, il est courant d'utiliser des fichiers INI pour stocker les paramètres, mais travailler avec ces fichiers est un peu répétitif et improductif. L'API PropertiesFile4Delphi facilite ce travail avec des fichiers de configuration remplaçant l'utilisation de fichiers INI. Il s'agit d'une API permettant de gérer des fichiers texte simples, écrits avec la syntaxe clé=valeur , stockant une clé unique par ligne.

Principales fonctionnalités

• Stockez et chargez des données via une interface simplifiée ;
• Mappez les fichiers de configuration vers des classes simplifiées.

Construit avec

• Delphi Community Edition - L'EDI utilisé

Commencer

Pour obtenir une copie locale opérationnelle, suivez ces étapes simples.

Conditions préalables

Pour utiliser cette bibliothèque, une version mise à jour de Delphi IDE (XE ou supérieure) est requise.

Installation

Cloner le dépôt

 git clone https://github.com/ezequieljuliano/PropertiesFile4Delphi.git

Ajoutez le "Search Path" de votre IDE ou de votre projet aux répertoires suivants :

 PropertiesFile4Delphisrc

Usage

Créez ou modifiez des fichiers de configuration en déclarant une variable de type IPropertiesFile et en utilisant l'implémentation de TPropertiesFileStorage :

Enregistrer un fichier de propriétés

 uses
  
  PropertiesFile,
  PropertiesFile.Storage;

procedure Save;
var
  propertiesFile: IPropertiesFile;
begin
  propertiesFile := TPropertiesFileStorage.Create;
  propertiesFile.PropertyItem['app.title'] := 'Properties File For Delphi';
  propertiesFile.PropertyItem['app.version'] := '1.0.0';
  propertiesFile.SaveToFile('application.properties');
end;

Chargement d'un fichier de propriétés

 uses
  
  PropertiesFile,
  PropertiesFile.Storage;

procedure Load;
var
  propertiesFile: IPropertiesFile;
begin
  propertiesFile := TPropertiesFileStorage.Create;
  propertiesFile.LoadFromFile('application.properties');
  Self.Caption := propertiesFile.PropertyItem['app.title'] + '-' + propertiesFile.PropertyItem['app.version'];
end;

Prise en charge du mappage et classes de configuration

La bibliothèque PropertiesFile4Delphi fournit un ensemble de classes de mappage. De cette façon, vous pouvez travailler directement avec les classes plutôt que de manipuler des fichiers dans votre code source. La première étape pour utiliser le mécanisme de configuration dans une application consiste à créer une classe spécifique pour stocker les paramètres souhaités, à l'écrire avec [PropertiesFile] et à hériter de la classe TPropertiesFileObject .

Exemple de mappage :

 uses
  
  PropertiesFile.Mapping;

type

  [PropertiesFile('security.properties')]
  TSecurityConfig = class(TPropertiesFileObject)
  private
    [NotNull]
    [PropertyItem('username')]
    fUsername: string;

    [NotNull]
    [PropertyItem('password')]
    fPassword: string;
  public
    property Username: string read fUsername write fUsername;
    property Password: string read fPassword write fPassword;
  end;

Lorsque la classe est détruite, le fichier est automatiquement enregistré :

 procedure Load;
var
  securityConfig: TSecurityConfig;
begin
  securityConfig := TSecurityConfig.Create;
  try
    securityConfig.Username := 'admin';
    securityConfig.Password := 'admin';
  finally
    securityConfig.Free;
  end;
end;

Lors de l'instanciation de la classe, les données sont chargées :

 procedure Login;
var
  securityConfig: TSecurityConfig;
begin
  securityConfig := TSecurityConfig.Create;
  try
    Login(securityConfig.Username, securityConfig.Password);
  finally
    securityConfig.Free;
  end;
end;

Mappages de champs pris en charge :

• PropertyItem : définition du champ d'alias ;
• NotNull : définition de champ obligatoire ;
• Ignorer : champs qui doivent être ignorés ;
• ReadOnly : champs en lecture seule (peuvent être appliqués au niveau de la classe).

Feuille de route

Consultez les problèmes ouverts pour une liste des fonctionnalités proposées (et des problèmes connus).

Contribuer

Les contributions sont ce qui fait de la communauté open source un endroit si formidable pour apprendre, inspirer et créer. Toutes les contributions que vous apportez sont grandement appréciées .

1. Forkez le projet
2. Créez votre branche de fonctionnalités ( git checkout -b feature/AmazingFeature )
3. Validez vos modifications ( git commit -m 'Add some AmazingFeature' )
4. Pousser vers la branche ( git push origin feature/AmazingFeature )
5. Ouvrir une demande de tirage

Licence

Distribué sous LICENCE APACHE. Voir LICENSE pour plus d’informations.

Contact

Pour nous contacter utilisez les options :

• E-mail : [email protected]
• Twitter : @ezequieljuliano
• Linkedin: ezequiel-juliano-müller

Lien du projet

https://github.com/ezequieljuliano/PropertiesFile4Delphi