imported>Karl432: Benennung des Zeichens „#“ „Rautezeichen“ statt „Doppelkreuz“

2024-10-14T10:48:42Z

Benennung des Zeichens „#“ „Rautezeichen“ statt „Doppelkreuz“

Neue Seite

Eine '''Java-Properties-Datei''' ist eine [[Konfigurationsdatei]], die hauptsächlich zur Speicherung von Anwendungsdaten im Umfeld der Programmiersprache [[Java (Programmiersprache)|Java]] verwendet wird. Eine ''Property'' (deutsch „Eigenschaft“) ist in diesem Zusammenhang ein Text, der unter einem bestimmten Namen abgelegt ist. Java-Properties-Dateien haben üblicherweise die [[Dateiendung]] <code>.properties</code>.

== Struktur ==

Das folgende Beispiel zeigt einen Ausschnitt aus einer einfachen Konfigurationsdatei:
<syntaxhighlight lang="properties">
# Dies ist ein Kommentar
! Dies ist ebenfalls ein Kommentar
wenig Text
pi = 3.14
lang:de
vieltext Dieser Text \
läuft über zwei Zeilen.
paramText = Text mit dynamischem Parameter: {0}
unicodeText = Ein Smiley: \u263A
</syntaxhighlight>

Das Beispiel enthält zwei [[Kommentar (Programmierung)|Kommentarzeilen]] und definiert sechs Werte für die Namen <code>wenig</code>, <code>pi</code>, <code>lang</code>, <code>vieltext</code>, <code>paramText</code> und <code>unicodeText</code>.

Wie sich aus dem Beispiel erkennen lässt, gibt es Kommentarzeilen, die mit einem [[Rautezeichen]] <code>#</code> oder einem [[Ausrufezeichen]] <code>!</code> beginnen, und Datenzeilen, in denen ein Name und ein Text definiert werden.<ref name="store">[https://docs.oracle.com/javase/7/docs/api/java/util/Properties.html ''Properties''.] Java API Specification</ref>

Name und Text können auf drei Arten voneinander getrennt werden, wobei die Trennzeichen nicht zum Schlüssel oder Text gehören.<ref name="store" />
# durch ein oder mehrere [[Leerzeichen]]: Im obigen Beispiel hat der Schlüssel <code>wenig</code> den Wert „Text“, entsprechend <code>vieltext</code>.
# durch ein [[Gleichheitszeichen]] <code>=</code>, umgeben von keinem oder beliebig vielen Leerzeichen: Im obigen Beispiel hat der Schlüssel <code>pi</code> den Wert „3.14“.
# durch einen [[Doppelpunkt]] <code>:</code>, umgeben von keinem oder beliebig vielen Leerzeichen: Im obigen Beispiel hat der Schlüssel <code>lang</code> den Wert „de“.

Ein [[umgekehrter Schrägstrich]] <code>\</code> am Ende der Zeile bedeutet, dass der Text in der nächsten Zeile fortgesetzt wird.<ref name="store" /> Stehen am Ende der Zeile mehrere umgekehrte Schrägstriche, wird der Text nur dann in der nächsten Zeile fortgesetzt, wenn die Anzahl der Schrägstriche ungerade ist. Endet die Zeile z. B. auf <code>\\</code>, so reicht der Text nur bis zum Ende der Zeile und enthält am Ende einen umgekehrten Schrägstrich; endet die Zeile hingegen auf <code>\\\</code>, dann wird der Text in der nächsten Zeile fortgesetzt.<ref name="store" />

Als Zeichencodierung für den Text wird [[ISO 8859-1]] verwendet. Unicode-Zeichen, die nicht im ISO-Encoding enthalten sind, müssen mit einer [[Escape-Sequenz]] codiert werden.<ref name="store" />

== Verwendung in Java-Programmen ==

Eine solche Java-Properties-Datei kann mittels der [[Klasse (Objektorientierung)|Klasse]] <code>[https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html java.util.Properties]</code> eingelesen werden. Anschließend können die definierten Werte über deren [[Methode (Programmierung)|Methoden]] abgefragt werden. Das folgende Code-Fragment erzeugt ein Properties-Objekt, liest eine Datei namens <code>beispiel.properties</code> ein, und legt den Wert der Property <code>lang</code> in einer Variablen namens <code>sprache</code> ab.

<syntaxhighlight lang="java">
import java.io.FileInputStream;
import java.io.BufferedInputStream;
import java.util.Properties;
…
Properties properties = new Properties();
BufferedInputStream stream = new BufferedInputStream(new FileInputStream("beispiel.properties"));
properties.load(stream);
stream.close();
String sprache = properties.getProperty("lang");
</syntaxhighlight>
Bei der <code>load</code>-Methode muss die [[Ausnahmebehandlung|Ausnahme]] <code>[https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html IOException]</code> abgefangen werden. Der Übersicht wegen wurde der Try-Catch-Block weggelassen.

== Platzhalter ==

Eine [[Positive und negative Zahlen|nicht negative]] [[ganze Zahl]] in geschweiften Klammern <code>{}</code> steht für einen Text, der zur [[Laufzeit (Informatik)|Laufzeit]] des Programms ergänzt werden soll. Sinnvollerweise beginnen die Zahlen in den Klammern mit <code>0</code> und sind [[fortlaufend]]. Sie dürfen mehrfach sowie in beliebiger [[Reihenfolge]] auftreten. Solche Ersetzungen sind für die [[Internationalisierung (Softwareentwicklung)|Internationalisierung]] oder [[Lokalisierung (Softwareentwicklung)|Lokalisierung]] von Programmen sinnvoll, wo dynamisch zu erzeugende Textbestandteile in unterschiedlichen [[Sprache]]n an unterschiedlichen Stellen oder in unterschiedlicher Reihenfolge auszugeben sind.

Die Ersetzung des Parameters kann mit folgendem Code realisiert werden:
<syntaxhighlight lang="java">
String paramText = properties.getProperty("paramText");
String dynText = "dynamisch eingesetzter Text";
System.out.println(MessageFormat.format(paramText,dynText));
</syntaxhighlight>
Ausgabe:
Text mit dynamischem Parameter: dynamisch eingesetzter Text
Bei mehreren Ersetzungsparametern muss für „dynText“ ein [[Array (Datentyp)|Array]] oder eine [[Menge (Datenstruktur)|Menge]] mit den Ersetzungswerten übergeben werden.

Streng genommen ist dies kein Feature des Properties-Mechanismus, wird hier jedoch erwähnt, da es in diesem Zusammenhang vielfach Verwendung findet.

== Internationalisierung ==

Ein weiteres Feature des Properties-Mechanismus in Java ist das Aufteilen der Inhalte pro [[Locale]]. Das macht man durch ein Suffix im Dateinamen kenntlich. Eine Properties-Datei <code>messages.properties</code> speziell für deutschsprachige Texte würde man <code>messages_de.properties</code> benennen. Das kann man mit der Angabe einer Region noch weiter eingrenzen. Eine Property-Datei für österreichisches Deutsch würde demnach so benannt: <code>messages_de_AT.properties</code>. Eine Variante ohne Suffix sollte als Fallback möglichst immer vorhanden sein. Seit Java 9 werden ResourceBundles-Properties standardmäßig mit UTF-8 decodiert, wodurch die unleserlichen Escape-Sequenzen entfallen können. Sollten beim Dekodieren Probleme auftreten, wird es mit ISO 8859-1 automatisch erneut versucht.<ref>{{Internetquelle |url=https://openjdk.java.net/jeps/226 |titel=JEP 226: UTF-8 Property Resource Bundles |abruf=2020-06-22}}</ref>

== Einzelnachweise ==
<references />

[[Kategorie:Datenserialisierungformat]]
[[Kategorie:Konfigurationsdatei]]
[[Kategorie:Java (Programmiersprache)]]

Java-Properties-Datei - Versionsgeschichte

imported>Karl432: Benennung des Zeichens „#“ „Rautezeichen“ statt „Doppelkreuz“