14.3 Stream-Klassen und Reader/Writer am Beispiel von Dateien

Unterschiedliche Klassen zum Lesen und Schreiben von Binär- und Zeichendaten sammelt Java im Paket java.io. Für die byte-orientierte Verarbeitung, etwa von PDF- oder MP3-Dateien, gibt es andere Klassen als für Textdokumente, zum Beispiel HTML. Das ist aus mehreren Gründen sinnvoll: Das Einlesen von Unicode-Dateien ist vereinfacht, und Daten müssen nicht auf festgelegten Zeichensätzen arbeiten, ja, wir bekommen vom Konvertieren von Unicode nach Byte überhaupt nichts mit. Durch ihre Basistypen nennen sich die zeichenorientierten Klassen Reader, Writer und die byte-orientierten Klassen InputStream und OutputStream.

FileInputStream, FileReader, FileOutputStream, FileWriter

Dieses Unterkapitel stellt die vier Klassen zum Lesen und Schreiben aus Dateien vor, und zwar jeweils die Zeichen- und Byte-orientierten Klassen.

File f = new File( dateiname ); 
byte[] buffer = new byte[ (int) f.length() ]; 
InputStream in = new FileInputStream( f ); 
in.read( buffer ); 
in.close();

14.3.1 Mit dem FileWriter Texte in Dateien schreiben

Der FileWriter ist ein spezieller Writer, der Ausgaben in eine Datei erlaubt.

Das folgende Programm erstellt die Datei fileWriter.txt und schreibt eine Textzeile mit Zeilenvorschubzeichen hinein.

Listing 14.15 com/tutego/insel/io/stream/FileWriterDemo.java, main()

Writer fw = null; 
 
try 
{ 
  fw = new FileWriter( "fileWriter.txt" ); 
  fw.write( "Zwei Jäger treffen sich..." ); 
  fw.append( System.getProperty("line.separator") ); // e.g. "\n" 
} 
catch ( IOException e ) { 
  System.err.println( "Konnte Datei nicht erstellen" ); 
} 
finally { 
  if ( fw != null ) 
    try { fw.close(); } catch ( IOException e ) { } 
}

Da der Konstruktor und die write()/append()-Methoden eine IOException in dem Fall auslösen, wenn ein Öffnen beziehungsweise Schreiben nicht möglich ist, müssen wir einen try-catch-Block um die Anweisungen setzen oder mit throws den Fehler nach oben weitergeben.

class java.io.FileWriter 
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 14.4.9, »Die abstrakte Basisklasse Writer«, genauer vor.

14.3.2 Zeichen 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. So zeigt folgendes Beispiel eine Anwendung der FileReader-Klasse.

Listing 14.16 com/tutego/insel/io/stream/FileReaderDemo.java, main()

Reader reader = null; 
try 
{ 
  reader = new FileReader( "bin/lyrics.txt" ); 
 
  for ( int c; ( c = reader.read() ) != –1; ) 
    System.out.print( (char) c ); 
} 
catch ( IOException e ) { 
  System.err.println( "Fehler beim Lesen der Datei!" ); 
} 
finally { 
  try { reader.close(); } catch ( Exception e ) { } 
}

class java.io.FileReader 
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 14.4.11, »Die abstrakte Basisklasse Reader«, beschreibt die Methoden genauer.

14.3.3 Kopieren mit FileOutputStream und FileInputStream

Diese 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[]).

class java.io.FileOutputStream 
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.

class java.io.FileInputStream 
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.

Kopieren von Dateien

Als Beispiel für das Zusammenspiel von FileInputStream und FileOutputStream wollen wir ein Datei-Kopierprogramm 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 es sie gnadenlos. Auch darum kümmern wir uns nicht. Wollten wir das berücksichtigen, sollten wir mit Hilfe der File-Klasse die Existenz einer gleichnamigen Datei prüfen.

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 Zwischen-Puffer-Klasse keinen Geschwindigkeitsgewinn, da wir ja selbst einen 64-KB-Puffer einrichten.

Listing 14.17 cp.java

package com.tutego.insel.io.stream; 
 
import java.io.*; 
 
public class cp 
{ 
  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 ); 
  } 
 
  static void copyFile( String src, String dest ) 
  { 
    FileInputStream  fis = null; 
    FileOutputStream fos = null; 
 
    try 
    { 
      fis = new FileInputStream( src ); 
      fos = new FileOutputStream( dest ); 
 
      copy( fis, fos ); 
    } 
    catch ( IOException e ) { 
      e.printStackTrace(); 
    } 
    finally { 
      if ( fis != null ) 
        try { fis.close(); } catch ( IOException e ) { } 
      if ( fos != null ) 
        try { fos.close(); } catch ( IOException e ) { } 
    } 
  } 
 
  public static void main( String[] args ) 
  { 
    if ( args.length != 2 ) 
      System.err.println( "Benutzung: copy <src> <dest>" ); 
    else 
      copyFile( args[0], args[1] ); 
  } 
}

Der Klassenname ist hier – entgegen üblicher Konventionen – klein- und kryptisch geschrieben, um dem Charakter eines Kommandozeilenprogramms zu entsprechen.

14.3.4 Das 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. [Die Socket-Klasse selbst bietet keine Funktion 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. Ein flush() gibt nur den Java-Buffer an das Betriebssystem, doch das hat einen eigenen Puffer, auf den flush() keinen Einfluss hat, nur sync().

FileOutputStream os = new FileOutputStream( ... ); 
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.

final class java.io.FileDescriptor

• void sync()
  Materialisiert die Daten. sync() kehrt erst dann zurück, wenn die Daten geschrieben wurden.

Ihr Kommentar