Comment utiliser les fichiers de propriétés Java ?

Question

Je dispose d'une liste de paires clé/valeur de valeurs de configuration que je souhaite stocker sous forme de fichiers de propriétés Java, puis charger et parcourir par itération.

Questions :

• Dois-je stocker le fichier dans le même paquet que la classe qui les chargera, ou y a-t-il un emplacement spécifique où il doit être placé ?
• Le fichier doit-il se terminer par une extension spécifique ou bien est-il .txt OK ?
• Comment puis-je charger le fichier dans le code
• Et comment puis-je itérer à travers les valeurs à l'intérieur ?

Answer 1

Vous pouvez passer un InputStream à la propriété, de sorte que votre fichier peut se trouver à peu près n'importe où et être appelé n'importe comment.

Properties properties = new Properties();
try {
  properties.load(new FileInputStream("path/filename"));
} catch (IOException e) {
  ...
}

Iterate comme :

for(String key : properties.stringPropertyNames()) {
  String value = properties.getProperty(key);
  System.out.println(key + " => " + value);
}

Answer 2

• Vous peut stocker le fichier où vous voulez. Si vous voulez le garder dans votre fichier jar, vous devrez utiliser Class.getResourceAsStream() o ClassLoader.getResourceAsStream() pour y accéder. Si c'est sur le système de fichiers, c'est un peu plus facile.

• N'importe quelle extension convient, bien que l'extension .properties soit plus courante d'après mon expérience.

• Chargez le fichier en utilisant Properties.load en passant dans un InputStream ou un StreamReader si vous utilisez Java 6. (Si vous sont en utilisant Java 6, j'utiliserais probablement UTF-8 et un Reader au lieu de l'encodage ISO-8859-1 par défaut pour un flux).

• Itérer à travers elle comme vous le feriez à travers un normal Hashtable (qui Properties dérive de), par exemple en utilisant keySet() . Alternativement, vous pouvez utiliser l'énumération retournée par propertyNames() .

Answer 3

Si vous placez le fichier de propriétés dans le même paquet que la classe Foo, vous pouvez facilement le charger avec

new Properties().load(Foo.class.getResourceAsStream("file.properties"))

Étant donné que Properties étend Hashtable, vous pouvez itérer sur les valeurs de la même manière que vous le feriez dans un Hashtable.

Si vous utilisez l'extension *.properties, vous pouvez obtenir le support d'un éditeur, par exemple Eclipse a un éditeur de fichiers de propriétés.

Answer 4

Il existe de nombreuses façons de créer et de lire properties des fichiers :

1. Stockez le fichier dans le même paquet.
2. Recommander .properties Cependant, vous pouvez choisir votre propre extension.
3. Utilisez ces classes situées à java.util paquet => Properties , ListResourceBundle , ResourceBundle classes.
4. Pour lire les propriétés, utilisez les méthodes iterator ou enumerator ou directes de Properties o java.lang.System classe.

ResourceBundle classe :

 ResourceBundle rb = ResourceBundle.getBundle("prop"); // prop.properties
 System.out.println(rb.getString("key"));

Properties classe :

Properties ps = new Properties();
ps.Load(new java.io.FileInputStream("my.properties"));

Answer 5

Ceci charge le fichier de propriétés :

Properties prop = new Properties();
InputStream stream = ...; //the stream to the file
try {
  prop.load(stream);
} finally {
  stream.close();
}

J'ai l'habitude de placer le fichier .properties dans un répertoire où se trouvent tous les fichiers de configuration, je ne le place pas avec la classe qui y accède, mais il n'y a pas de restrictions ici.

Pour le nom... J'utilise .properties pour des raisons de verbosité, je ne pense pas que vous devriez le nommer .properties si vous ne le voulez pas.