7.4Die FileXXX-Stromklassen 
Das Paket java.io deklariert vier Klassen zum Lesen/Schreiben aus/in Dateien, und zwar jeweils die zeichen- und byteorientierten Klassen:
Bytes (oder Byte-Arrays) | Zeichen (oder Zeichen-Arrays, Strings) | |
|---|---|---|
Aus Dateien lesen | FileInputStream | FileReader |
In Dateien schreiben | FileOutputStream | FileWriter |
Tabelle 7.6Lese- und Schreibklassen für Dateien
[zB]Beispiel
Lies den ganzen Dateiinhalt in ein Byte-Feld:
try ( InputStream in = new FileInputStream( p.toFile() ) ) {
byte[] buffer = new byte[ Math.toIntExact( Files.size( p ) ) ];
in.read( buffer );
}
Sinnvoller als das gesamte Einlesen ist aber im Allgemeinen das Lesen in Blöcken. Eine korrekte Fehlerbehandlung ist immer notwendig, wird aber hier erst einmal ausgeblendet. Das Beispiel soll nur den Basistyp InputStream, die konkrete Unterklasse FileInputStream und die Methoden read(…) und close() zeigen. Da die Dateilänge ein long ist, Arrays »nur« maximal von der Größe eines int sind, konvertieren wir das long in ein int über eine Java 8-Methode, die eine Ausnahme auslöst, wenn die Datei so groß ist, dass sie nicht in ein Java-Array passen würde. Vermutlich hätte ein normales System dafür aber sowieso zu wenig Speicher.
7.4.1Kopieren mit FileOutputStream und FileInputStream
Die Klasse FileOutputStream bietet grundlegende Methoden, um in Dateien zu schreiben. FileOutputStream implementiert alle nötigen Methoden, die java.io.OutputStream vorschreibt, also etwa write(int), write(byte[]).
extends OutputStream
FileOutputStream(String name) throws FileNotFoundException
Erzeugt einen FileOutputStream mit einem gegebenen Dateinamen.FileOutputStream(File file) throws FileNotFoundException
Erzeugt einen FileOutputStream aus einem File-Objekt.FileOutputStream(String name, boolean append) throws FileNotFoundException
Wie FileOutputStream(name), hängt jedoch bei append=true Daten an.FileOutputStream(File file, boolean append) throws FileNotFoundException
Wie FileOutputStream(file), hängt jedoch bei append=true Daten an.FileOutputStream(FileDescriptor fdObj)
Erzeugt einen FileOutputStream aus einem FileDescriptor-Objekt.
Ist der Parameter append nicht mit true belegt, wird der alte Inhalt überschrieben. Die FileNotFoundException wirkt vielleicht etwas komisch, wird aber dann ausgelöst, wenn zum Beispiel die Dateiangabe ein Verzeichnis repräsentiert oder die Datei gelockt ist.
FileInputStream ist der Gegenspieler und dient zum Lesen der Binärdaten. Um ein Objekt anzulegen, haben wir die Auswahl zwischen drei Konstruktoren. Sie binden eine Datei (etwa repräsentiert als ein Objekt vom Typ File) an einen Datenstrom:
extends InputStream
FileInputStream(String name) throws FileNotFoundException
Erzeugt einen FileInputStream mit einem gegebenen Dateinamen.FileInputStream(File file) throws FileNotFoundException
Erzeugt FileInputStream aus einem File-Objekt.FileInputStream(FileDescriptor fdObj)
Erzeugt FileInputStream aus einem FileDescriptor-Objekt.
Der FileInputStream ist ein spezieller InputStream und besitzt daher Methoden wie int read(), int read(byte[]) zum Lesen.
Zur Veranschaulichung dient die folgende Grafik.
Abbildung 7.3UML-Diagramm der Klassen FileInputStream und FileOutputStream
Kopieren von Dateien *
Als Beispiel für das Zusammenspiel von FileInputStream und FileOutputStream wollen wir ein Dateikopierprogramm entwerfen. Es ist einleuchtend, dass wir zunächst die Quelldatei öffnen müssen. Taucht ein Fehler auf, wird dieser zusammen mit allen anderen Fehlern in einer besonderen IOException-Fehlerbehandlung ausgegeben. Wir trennen hier die Fehler nicht besonders. Nach dem Öffnen der Quelle wird eine neue Datei angelegt. Das erledigt der Konstruktor FileOutputStream, dem es jedoch gleichgültig ist, ob es bereits eine Datei dieses Namens gibt; wenn, dann überschreibt er sie gnadenlos. Auch darum kümmern wir uns nicht. Wollten wir das berücksichtigen, sollten wir mithilfe der File-Klasse prüfen, ob eine gleichnamige Datei existiert.
Nach dem Anlegen können wir Byte für Byte auslesen und kopieren. Die Lösung über diesen nativen Weg ist natürlich in puncto Geschwindigkeit erbärmlich. Eine Lösung wäre, einen Dekorator dazwischenzuschalten, den BufferedInputStream. Doch das ist nicht nötig, weil wir einen Puffer mit read(byte[]) selbst füllen können. Da diese Methode die Anzahl tatsächlich gelesener Bytes zurückliefert, schreiben wir diese direkt mittels write(…) in den Ausgabepuffer. Hier erbringt eine Pufferung über eine Zwischenpufferklasse keinen Geschwindigkeitsgewinn, da wir ja selbst einen 64-KiB-Puffer einrichten:
Listing 7.12com/tutego/insel/io/stream/cp.java
import java.io.*;
public class cp {
private static void copy( InputStream in, OutputStream out ) throws IOException {
byte[] buffer = new byte[ 0xFFFF ];
for ( int len; (len = in.read(buffer)) != -1; )
out.write( buffer, 0, len );
}
private static void copyFile( String srcFilename, String destFilename ) {
try ( FileInputStream fis = new FileInputStream( srcFilename );
FileOutputStream fos = new FileOutputStream( destFilename ) ) {
copy( fis, fos );
}
catch ( IOException e ) {
e.printStackTrace();
}
}
public static void main( String[] args ) {
if ( args.length != 2 )
System.err.println( "Benutzung: FileCopy <src> <dest>" );
else
copyFile( args[0], args[1] );
}
}
Der Klassenname ist hier – entgegen üblichen Konventionen – klein- und kryptisch geschrieben, um dem Charakter eines Kommandozeilenprogramms zu entsprechen.
[»]Hinweis
NIO.2 bietet copy(…)-Methoden an, die schon im vorangegangenen Kapitel vorgestellt wurden. Wer noch vor Java 7 festhängt, kann auch Commons IO (http://commons.apache.org/proper/commons-io/) nutzen; die Klasse IOUtils bietet fertige copy(…)-Methoden. Natürlich hätten wir in unserem Beispiel auch wieder die Files.newXXXStream(…)-Methoden bemühen können.
7.4.2Das FileDescriptor-Objekt *
Die Klasse java.io.FileDescriptor repräsentiert eine offene Datei (oder eine Socket-Verbindung) mittels eines Deskriptors. Er lässt sich bei File-Objekten mit getFD() erfragen, aber nicht von Hand gültig aufbauen.[ 81 ](Die Socket-Klasse selbst bietet keine Methode zum Abfragen eines Deskriptors. Nur Unterklassen von SocketImpl (und DatagramSocketImpl) ist der Zugriff über eine protected-Methode getFileDescriptor() gestattet.)
In der Regel kommt der Entwickler mit keinem FileDescriptor-Objekt in Kontakt. Es gibt allerdings eine Anwendung, in der die Klasse FileDescriptor nützlich ist: Sie bietet eine sync()-Methode an, die im internen Puffer des Betriebssystems verbleibende Speicherblöcke auf das Gerät schreibt. Damit lässt sich erreichen, dass Daten auch tatsächlich auf dem Datenträger materialisiert werden. Die Stream-Objekte (OutputStream/Writer) haben auch eine Methode flush(), der vergleichbare Funktionalität zuzuschreiben ist, jedoch kümmert sich flush() nur um das Leeren des Puffers, nicht allerdings um das tatsächliche Schreiben, also Materialisieren auf einem Hintergrundspeicher. Ist der Java-Puffer mit flush() geleert, können die Daten trotzdem noch in einem internen Puffer des Betriebssystems liegen – aber auf den hat flush() keinen Einfluss, nur sync().
[zB]Beispiel
Arbeite mit einem Ausgabestrom, und materialisiere alle Änderungen:
os.write( ... );
os.flush();
FileDescriptor fd = os.getFD();
fd.sync();
}
Neben FileInputStream kennen auch FileOutputStream und RandomAccessFile eine Methode getFD(). Mit einem FileDescriptor kann auch die Arbeit zwischen Stream-Objekten und RandomAccessFile-Objekten koordiniert werden.
void sync()
Materialisiert die Daten. sync() kehrt erst dann zum Aufrufer zurück, wenn die Daten geschrieben wurden.
7.4.3Mit dem FileWriter Texte in Dateien schreiben
Der FileWriter ist ein spezieller Writer, der Ausgaben in eine Datei schreibt. Da der Konstruktor und die write(…)/append(…)-Methoden eine IOException in dem Fall auslösen, wenn ein Schreiben nicht möglich ist, müssen wir einen try-Block um die Anweisungen setzen oder mit throws den Fehler nach oben weitergeben.
[»]Hinweis
Da sich die Zeichenkodierung nicht angeben lässt, sondern immer automatisch die vom System eingestellte Kodierung eingesetzt wird, sollte die Klasse verstoßen werden. Zum Schreiben in Dateien ist Files.newBufferedReader(…) anzuraten.
Die Konstruktoren und Methoden kurz zusammengefasst:
extends OutputStreamWriter
FileWriter(File file) throws IOException
FileWriter(String filename) throws IOException
FileWriter(File file, boolean append) throws IOException
FileWriter(String filename, boolean append) throws IOException
Erzeugt einen Ausgabestrom und hängt die Daten an eine existierende Datei an, wenn append gleich true ist. Eine weitere Möglichkeit, Daten hinten anzuhängen, bietet die Klasse RandomAccessFile oder FileOutputStream.FileWriter(FileDescriptor fd)
Erzeugt einen Ausgabestrom zum Schreiben in eine Datei. Existiert die Datei bereits, deren Namen wir übergeben, wird die Datei gelöscht.
Auf den ersten Blick scheinen der Klasse FileWriter die versprochenen write(…)-Methoden zu fehlen. Fakt ist aber, dass diese von OutputStreamWriter geerbt werden, und die Klasse erbt und überschreibt wiederum die Methoden aus Writer. Mit den Oberklassen verfügt der FileWriter insgesamt über folgende Methoden, deren Ausnahme IOException hier nicht genannt ist:
Writer append(char c)
Writer append(CharSequence csq)
Writer append(CharSequence csq, int start, int end)
void write(int c)
void write(String str)
void write(String str, int off, int len)
void write(char[] cbuf)
void write(char[] cbuf, int off, int len)
void close()
void flush()
String getEncoding()
Bis auf getEncoding() lösen alle verbleibenden Methoden im Fehlerfall eine IOException aus, die als geprüfte Ausnahme behandelt werden muss. Die Methoden stellt Abschnitt 7.2.7, »Die abstrakte Basisklasse Writer«, genauer vor.
7.4.4Zeichen mit der Klasse FileReader lesen
Der FileReader liest aus Dateien entweder einzelne Zeichen, Strings oder Zeichenfelder. Wie beim Writer deklariert die Klasse Konstruktoren zur Annahme des Dateinamens. Die Methoden im Überblick:
extends InputStreamReader
public FileReader(String fileName) throws FileNotFoundException
Öffnet die Datei über einen Dateinamen zum Lesen. Falls sie nicht vorhanden ist, löst der Konstruktor eine FileNotFoundException aus.public FileReader(File file) throws FileNotFoundException
Öffnet die Datei zum Lesen über ein File-Objekt. Falls sie nicht verfügbar ist, löst der Konstruktor eine FileNotFoundException aus.public FileReader(FileDescriptor fd)
Nutzt die schon vorhandene offene Datei über ein FileDescriptor-Objekt.
Die Methoden zum Lesen stammen aus den Oberklassen InputStreamReader und Reader. Aus InputStreamReader kommen int read(), int read(char[], int, int), close(), getEncoding() und ready(). Da InputStreamReader wiederum Reader erweitert, kommen die Methoden int read(char[]), int read(CharBuffer), mark(int), markSupported(), reset(), skip(long) hinzu. Abschnitt 7.2.9, »Die abstrakte Basisklasse Reader«, beschreibt die Methoden genauer.
[»]Hinweis
Da sich die Zeichenkodierung nicht angeben lässt, sondern immer automatisch die vom System eingestellte Kodierung eingesetzt wird, sollte die Klasse verstoßen werden. Zum Lesen von Zeichen aus Dateien sollte besser Files.newBufferedReader(…) verwendet werden.
