13.7 Datenströme filtern und verketten

So wie im alltäglichen Leben Filter beim Kaffee oder Fotoapparaten eine große Rolle spielen, so sind sie auch bei Datenströmen zu finden. Immer dann, wenn Daten von einer Quelle gelesen oder in eine Senke geschrieben werden, können Filter die Daten auf dem Weg verändern. Die Java-Bibliothek sieht eine ganze Reihe von Filtern vor, die sich zwischen die Kommunikation schalten können.

Der CipherOutputStream stammt als Einziger aus dem Paket javax.crypto, alle anderen aus java.io.

13.7.1 Streams als Filter verketten

Die Funktionalität der bisher vorgestellten Ein-/Ausgabe-Klassen reicht für den Alltag zwar aus, doch sind Ergänzungen gefordert, die die Fähigkeiten der Klassen erweitern. So zum Beispiel beim Puffern. Da die Programmlogik zur Pufferung mit Daten unabhängig von der Quelle ist, aus der die Daten stammen, findet sich die Pufferung in einer extra Klasse. Java implementiert hier ein bekanntes Muster, das sich Dekorator nennt. Zwei Zeilen sollen dieses Prinzip verdeutlichen, um gepufferte Daten in eine Datei zu schreiben:

Writer fw = new FileWriter( filename ); 
Writer bw = new BufferedWriter( fw );

Der Konstruktor von BufferedWriter nimmt einen beliebigen anderen Writer auf, denn der Pufferung ist es egal, ob die Daten in eine Datei oder ins Netzwerk geschrieben werden. Das Prinzip ist also immer, dass der Filter einen anderen Strom annimmt, an den er die Daten weitergibt, oder von dem er sie holt.

Schauen wir uns genau die Klassen im Paket java.io an, die andere Ströme im Konstruktor entgegennehmen:

• BufferedWriter, PrintWriter, FilterWriter nimmt Writer

• BufferedReader, FilterReader, LineNumberReader, PushbackReader, StreamTokenizer nimmt Reader

• BufferedOutputStream, DataOutputStream, FilterOutputStream, ObjectOutputStream, OutputStreamWriter, PrintStream, PrintWriter nimmt OutputStream

• BufferedInputStream, DataInputStream, FilterInputStream, InputStreamReader, ObjectInputStream, PushbackInputStream nimmt InputStream

13.7.2 Gepufferte Ausgaben mit BufferedWriter und BufferedOutputStream

Die Klassen BufferedWriter und BufferedOutputStream haben die Aufgabe, die mittels write() in den Ausgabestrom geleiteten Ausgaben zu puffern. Dies ist immer dann nützlich, wenn viele Schreiboperationen gemacht werden, denn das Puffern macht insbesondere Dateioperationen wesentlich schneller, da so mehrere Schreiboperationen zu einer zusammengefasst werden. Um die Funktionalität eines Puffers zu erhalten, besitzen die Klassen einen internen Puffer, in dem die Ausgaben von write() zwischengespeichert werden. Standardmäßig fasst der Puffer 8192 Symbole. Er kann aber über einen parametrisierten Konstruktor auf einen anderen Wert gesetzt werden. Erst wenn der Puffer voll ist oder die Methoden flush() oder close() aufgerufen werden, werden die gepufferten Ausgaben geschrieben. Durch die Verringerung tatsächlicher write()-Aufrufe an das externe Gerät erhöht sich die Geschwindigkeit der Anwendung im Allgemeinen deutlich.

Um einen BufferedWriter/BufferedOutputStream anzulegen, gibt es zwei Konstruktoren, denen ein bereits existierender Writer/OutputStream übergeben wird. An diesen Writer/OutputStream wird dann der Filter seinerseits die Ausgaben weiterleiten, insbesondere nach einem Aufruf von flush(), close() oder einem internen Überlauf.

class java.io.BufferedWriter     class java.io.BufferedOutputStream 
extends Writer                   extends FilterOutputStream

• BufferedWriter( Writer out )

• BufferedOutputStream( OutputStream out ) Erzeugt einen puffernden Ausgabestrom mit der Puffergröße von 8192 Symbolen.

• BufferedWriter( Writer out, int sz )

• BufferedOutputStream( OutputStream out, int size ) Erzeugt einen puffernden Ausgabestrom mit einer Puffergröße. Ist sie nicht echt größer 0, gibt es eine IllegalArgumentException.

Alle write(), append()-Funktionen sind so implementiert, dass die Daten erst im Puffer landen. Wenn der Puffer voll ist – oder flush() aufgerufen wird –, werden sie an den im Konstruktor übergebenen Writer durchgespült.

Beispiel zum BufferedWriter mit FileWriter und PrintWriter

Ein FileWriter sichert Daten in einer Datei. Ein BufferedWriter soll aber vorher die Daten erst einmal sammeln, sodass sie erst beim Flush an den FileWriter gehen. Der Anwendungsentwickler soll in unserem Beispiel aber nicht direkt den BufferedWriter nutzen, sondern ihn als allgemeinen Writer im Konstruktor von PrintWriter übergeben. Ein PrintWriter besitzt die komfortablen Funktionen print(), println() und printf(), sodass wir nicht mehr nur auf write()-Methoden vom Writer angewiesen sind.

Listing 13.26 com/tutego/insel/io/writer/ChainedWriter.java, main()

PrintWriter pw = null; 
try 
{ 
  Writer fw = new FileWriter( "charArrayWriterDemoPuffer.txt" ); 
  Writer bw = new BufferedWriter( fw ); 
  pw = new PrintWriter( bw ); 
 
  for ( int i = 1; i < 10000; i++ ) 
    pw.println( "Zeile " + i ); 
} 
catch ( IOException e ) { 
  System.err.println( "Error creating file!" ); 
} 
finally { 
  if ( pw != null ) 
    pw.close(); 
}

Zusätzlich bietet die Klasse BufferedWriter die Methode newLine(), die in der Ausgabe eine neue Zeile beginnt. Das Zeichen für den Zeilenwechsel wird aus der Systemeigenschaft line.separator genommen. Da sie intern mit der write()-Methode arbeitet, kann sie eine IOException auslösen.

13.7.3 Gepufferte Eingaben mit BufferedReader und BufferedInputStream

Die Klassen BufferedReader und BufferedInputStream puffern Eingaben. Die Daten werden also zuerst in einen Zwischenspeicher geladen, was insbesondere bei Dateien zu weniger Zugriffen auf den Datenträger führt, was die Geschwindigkeit der Anwendung erhöht.

Die Klassen BufferedReader und BufferedInputStream besitzen je zwei Konstruktoren. Bei einem lässt sich die Größe des internen Puffers angeben. Die Puffergröße beträgt wie beim BufferedWriter/BufferedOutputStream standardmäßig 8192 Einträge.

class java.io.BufferedReader     class java.io.BufferedInputStream 
extends Reader                   extends FilterInputStream

• BufferedReader( Reader in )

• BufferedInputStream( InputStream in ) Erzeugt einen puffernden Zeichenstrom mit der Puffergröße von 8192.

• BufferedReader( Reader in, int sz )

• BufferedInputStream( InputStream in, int size ) Erzeugt einen puffernden Zeichenstrom mit der gewünschten Puffergröße.

Programm zur Anzeige von Dateien

Das folgende Programm implementiert ein einfaches »cat«-Kommando [Der kurze Name cat stammt von »catenate«, einem Synonym für »concatenate«. ] von Unix, um Dateiinhalte über die Standardausgabe auszugeben. Die Dateinamen werden auf der Kommandozeile übergeben.

Listing 13.27 com/tutego/insel/io/stream/cat.java

package com.tutego.insel.io.stream; 
 
import java.io.*; 
 
class cat 
{ 
  public static void main( String[] args ) 
  { 
    for ( String filename : args ) { 
      try { 
        InputStream in = new BufferedInputStream( new FileInputStream(filename) ); 
 
        try { 
          for ( int c; (c = in.read()) != –1 /* EOF */; ) 
            System.out.write( c ); 
        } 
        finally { 
          in.close(); 
        } 
      } 
      catch ( IOException e ) { 
        System.out.println( "cat: cannot process " + filename ); 
        System.exit( 1 ); 
      } 
    } // end for 
  } 
}

Die Dateiangaben nimmt das Programm über die Kommandozeile entgegen; etwa so:

$ java com.tutego.insel.io.stream.Cat a.txt b.txt

Zeilen lesen mit BufferedReader und readLine()

Die Klasse BufferedReader stellt die Methode readLine() zur Verfügung, die eine komplette Textzeile liest und als String an den Aufrufer zurückgibt; BufferedOutputStream als Byte-orientierte Klasse bietet die Methode nicht an.

class java.io.BufferedReader 
extends Reader

• String readLine() Liest eine Zeile bis zum Zeilenende und gibt den String ohne die Endzeichen zurück. Die Rückgabe ist null, wenn der Stream am Ende ist.

Da ein BufferedReader Markierungen und Sprünge erlaubt, werden die entsprechenden Funktionen von Reader überschrieben.

13.7.4 LineNumberReader zählt automatisch Zeilen mit

Aus BufferedReader geht direkt die – bisher einzige – Unterklasse LineNumberReader hervor, die Zeilennummern zugänglich macht. Sie verfügt damit natürlich auch über readLine(). Mit getLineNumber() und setLineNumber() lässt sich aber zusätzlich auf die Zeilennummer zugreifen. Dass die Zeilennummer auch geschrieben werden kann, ist sicherlich ungewöhnlich, intern wird aber nur die Variable lineNumber geschrieben; der Datenzeiger wird nicht verändert. Bei jedem read() untersuchen die Funktionen, ob im Eingabestrom ein »\n«, »\r« oder eine Folge dieser beiden Zeichen vorkommt. Wenn dies der Fall ist, inkrementieren sie die Variable lineNumber. Zeilennummern beginnen bei null.

class java.io.LineNumberReader 
extends BufferedReader

• LineNumberReader( Reader in ) Dekoriert einen gegebenen Reader.

• LineNumberReader( Reader in, int sz ) Dekoriert einen gegebenen Reader mit gegebener Puffer-Größe.

• int getLineNumber() Liefert die aktuelle Zeilennummer.

• void setLineNumber( int lineNumber ) Setzt die aktuelle Zeilennummer.

13.7.5 Daten mit der Klasse PushbackReader zurücklegen

Die Klassen PushbackReader und PushbackInputStream können schon gelesene Eingaben wieder in den Strom zurücklegen. Das ist nützlich für so genannte vorausschauende Parser, die eine Wahl aufgrund des nächsten gelesenen Zeichens treffen. Mit den beiden Klassen kann dieses Vorschau-Zeichen wieder in den Eingabestrom gelegt werden, wenn der Parser den Weg doch nicht verfolgen möchte. Der nächste Lesezugriff liest dann nämlich dieses zurückgeschriebene Zeichen.

Die Filterklassen besitzen einen internen Puffer beliebiger Größe, in dem Symbole gespeichert werden, um sie später zurückholen zu können. Im Folgenden wollen wir uns nur mit dem PushbackReader beschäftigen; die Nutzung der Klasse PushbackInputStream ist ähnlich.

class java.io.PushbackReader 
extends FilterReader

• PushbackReader( Reader in ) Erzeugt einen PushbackReader aus dem Reader in mit der Puffergröße 1.

• PushbackReader( Reader in, int size ) Erzeugt einen PushbackReader aus dem Reader in mit der Puffergröße size.

Um ein Zeichen oder eine Zeichenfolge wieder in den Eingabestrom zu legen, wird die Methode unread() ausgeführt.

• public void unread( int c ) throws IOException

• public void unread( char[] cbuf, int off, int len ) throws IOException

• public void unread( char[] cbuf ) throws IOException Legt ein Zeichen oder ein Feld von Zeichen zurück in den Zeichenstrom.

PushbackReader ist ein Eingabefilter und die einzige Klasse, die direkt aus FilterReader abgeleitet ist.

Zeilennummern entfernen mit einem PushbackReader

Das nächste Programm demonstriert die Möglichkeiten eines PushbackReaders. Die Implementierung wirkt möglicherweise etwas gezwungen, sie zeigt jedoch, wie unread() eingesetzt werden kann. Das Programm löst folgendes Problem: Wir haben eine Textdatei (im Programm einfach als String über einen StringReader zur Verfügung gestellt), in der Zeilennummern mit dem String verbunden sind.

134Erste Zeile 
234Zeile

Wir wollen nun die Zahlen vom Rest der Zeilen trennen. Dazu lesen wir so lange die Zahlen ein, bis ein Zeichen folgt, bei dem Character.isDigit() die Rückgabe false ergibt. Dann wissen wir, dass wir keine Ziffer mehr im Strom haben. Das Problem ist nun, dass schon ein Zeichen mehr gelesen wurde. In einem normalen Programm ohne die Option, das Zeichen zurücklegen zu können, würde das etwas ungemütlich. Dieses Zeichen müsste dann gesondert behandelt werden, da es das erste Zeichen der neuen Eingabe ist und nicht mehr zur Zahl gehört. Doch an Stelle dieser Sonderbehandlung legen wir es einfach wieder mit unread() in den Datenstrom, und dann kann der nachfolgende Programmcode einfach so weitermachen, als ob nichts gewesen wäre. Dies ist besonders dann von Vorteil, wenn noch Unterprogramme im Einsatz sind, die nach dem Lesen der Zahl eine weitere Funktion aufrufen, die noch einmal alles lesen will. Nach der herkömmlichen Methode muss das gelesene Zeichen dann mit an die Funktion übergeben werden.

Listing 13.28 com/tutego/insel/io/stream/PushbackReaderDemo.java, main()

String s = "134Erste Zeile\n234Zeile"; 
 
PushbackReader in = new PushbackReader( new StringReader(s) ); 
 
for ( int c; ; ) 
{ 
  try 
  { 
    int number = 0; 
 
    // Lies Zahl, bis nichts mehr geht 
 
    while ( Character.isDigit((char)(c = in.read())) ) 
      number = (number * 10) + c – '0'; 
 
    if ( c == –1 )   // Ende der Eingabe? => Ende der Schleife 
      break; 
 
    in.unread( c );        // Letztes Zeichen wieder rein 
 
    System.out.print( number + ":" ); 
 
    // Jetzt ist das Zeichen wieder drin 
 
    while ( (c = in.read()) != –1 ) 
    { 
      System.out.print( (char)c ); 
 
      if ( c == '\n' ) 
        break; 
    } 
    if ( c == –1 ) 
      break; 
  } 
  catch ( EOFException e ) 
  { 
    break; 
  } 
}

PushbackReader und das fehlende readLine()

Da PushbackReader nicht von BufferedReader abgeleitet ist und auch selbst keine Methode readLine() anbietet, müssen wir mit einer kleinen Schleife selbst Zeilen lesen. Im Bedarfsfall muss die Zeichenkombination »\r\n« gelesen werden. So wie die Methode von uns jetzt programmiert ist, ist sie auf Unix-Plattformen eingeschränkt, die nur ein einziges Ende-Zeichen einfügen. Doch warum nutzen wir nicht readLine()? Wer nun auf die Idee kommt, folgende Zeilen zu schreiben, um doch in den Genuss der Methode readLine() zu kommen, ist natürlich auf dem Holzweg:

StringReader   sr = new StringReader( s ); 
BufferedReader br = new BufferedReader ( sr ); 
PushbackReader in = new PushbackReader( br ); 
... 
br.readLine();      // Achtung, br!!

Wenn wir dem PushbackReader das Zeichen wiedergeben, dann arbeitet der BufferedReader genau eine Ebene darüber und bekommt vom Zurückgeben nichts mit. Daher ist es sehr gefährlich, die Verkettung zu umgehen. Im konkreten Fall wird das unread() nicht durchgeführt, und das erste Zeichen nach der Zahl fehlt.

13.7.6 DataOutputStream/DataInputStream

Während der OutputStream nur einzelne Bytes bzw. Byte-Felder schreibt und der InputStream aus einer Eingabe Bytes lesen kann, erweiterten die Klassen DataOutputStream und DataInputStream diese Schreib- und Lesefähigkeit um primitive Datentypen. Die Vorgaben bekommen sie aus DataOutput und DataInput, die wir schon bei RandomAccessFile sahen. Wichtige Methoden sind zum Beispiel writeChar(char), writeInt(int), writeUTF(char) oder readUnsignedByte(), readLong(), readFully(byte[]).

13.7.7 Basisklassen für Filter

Als Basisklassen für existierende Filter – und insbesondere für eigene Filter – sieht die Standard-Bibliothek die Klassen FilterInputStream und FilterOutputStream für die Binärseite und FilterReader und FilterWriter für die Zeichenseite vor.

Eine konkrete Filter-Klasse überschreibt nötige Methoden ihrer Basisklassen (also vom InputStream, OutputStream, Reader oder Writer) und ersetzt diese durch neue Methoden mit erweiterter Funktionalität. Die folgende Abbildung stellt die zentralen Filter vor:

Am UML-Diagramm fällt besonders auf, dass jeder Filter zum einen selbst ein Stream ist und zum anderen einen Stream verwaltet. Damit nimmt er Daten entgegen und leitet sie gleich weiter. Das ist ein bekanntes Design-Pattern und nennt sich Dekorator.

13.7.8 Die Basisklasse FilterWriter

Die Basis für eigene zeichenorientierte Filter, die vor dem Verarbeiten vom Client modifiziert werden sollen, ist die abstrakte Klasse FilterWriter. Wir übergeben im Konstruktor ein Writer-Objekt, an das die späteren Ausgaben weitergeleitet werden. Das Konstruktor-Argument wird in dem protected-Attribut out des FilterWriter-Objekts gesichert. In der Unterklasse greifen wir darauf zurück, denn dort schickt der Filter seine Ausgaben hin.

Die Standardimplementierung der Klasse FilterWriter überschreibt drei der write()-Methoden so, dass die Ausgaben an den im Konstruktor übergebenen Writer gehen.

abstract class java.io.FilterWriter 
extends Writer

• protected Writer out Der Ausgabestrom, an den die Daten geschickt werden. Im Konstruktor gesetzt.

• protected FilterWriter( Writer out ) Erzeugt einen neuen filternden Writer.

• void write( int c ) Schreibt ein einzelnes Zeichen.

• void write( char[] cbuf, int off, int len ) Schreibt einen Teil eines Zeichenfelds.

• void write( String str, int off, int len ) Schreibt einen Teil eines Strings.

• void close() Schließt den Stream.

• void flush() Leert den internen Puffer des Streams.

Die Klasse ist abstrakt, also können keine direkten Objekte erzeugt werden. Dennoch gibt es einen protected-Konstruktor, der für Unterklassen wichtig ist. Abgeleitete Klassen bieten in der Regel selbst einen Konstruktor mit dem Parameter vom Typ Writer an und rufen im Rumpf mit super(write) den geschützten Konstruktor der Oberklasse FilterWriter auf. Über die initialisierte geschützte Objektvariable out kommen wir dann an diesen Ur-Writer.

13.7.9 Ein LowerCaseWriter

Wir wollen im Folgenden einen Filter schreiben, der alle in den Strom geschriebenen Zeichen in Kleinbuchstaben umwandelt. Drei Dinge sind für einen eigenen FilterWriter nötig:

• Die Klasse leitet sich von FilterWriter ab.

• Unser Konstruktor nimmt als Parameter ein Writer-Objekt und ruft mit super(out) den Konstruktor der Oberklasse, also FilterWriter, auf. Die Oberklasse speichert das übergebene Argument in der geschützten Objektvariable out, sodass die Unterklassen darauf zugreifen können.

• Wir überlagern die drei write()-Methoden und eventuell noch close() und flush(). Unsere write()-Methoden führen dann die Filterfunktionen aus und geben die wahren Daten an den Writer weiter.

Listing 13.29 com/tutego/insel/io/stream/LowerCaseWriterDemo.java

package com.tutego.insel.io.stream; 
 
import java.io.*; 
 
class LowerCaseWriter extends FilterWriter 
{ 
  public LowerCaseWriter( Writer writer ) 
  { 
    super( writer ); 
  } 
 
  @Override 
  public void write( int c ) throws IOException 
  { 
    out.write( Character.toLowerCase((char)c) ); 
  } 
 
  @Override 
  public void write( char[] cbuf, int off, int len ) throws IOException 
  { 
    out.write( String.valueOf(cbuf).toLowerCase(), off, len ); 
  } 
 
  @Override 
  public void write( String s, int off, int len ) throws IOException 
  { 
    out.write( s.toLowerCase(), off, len ); 
  } 
} 
 
public class LowerCaseWriterDemo 
{ 
  public static void main( String[] args ) 
  { 
    StringWriter sw = new StringWriter(); 
    PrintWriter  pw = new PrintWriter( new LowerCaseWriter( sw ) ); 
 
    pw.println( "Eine Zeile für klein und groß" ); 
 
    System.out.println( sw.toString() ); 
 } 
}

13.7.10 Eingaben mit der Klasse FilterReader filtern

Wie das Schachteln von Ausgabeströmen, so ist auch das Verbinden mehrerer Eingabeströme möglich. Als abstrakte Basiszwischenklasse existiert hier FilterReader, die ein Reader-Objekt im Konstruktor übergeben bekommt. Dieser sichert das Argument in der protected-Variablen in (das gleiche Prinzip wie bei den anderen FilterXXX-Klassen). Der Konstruktor ist protected, da er von der Unterklasse mit super() aufgerufen werden soll. Standardmäßig leiten die Methoden vom FilterReader die Methoden an den Reader aus der Variablen in weiter; das heißt etwa: Wenn der FilterReader geschlossen wird, wird der Aufruf in.close() ausgeführt. Aus diesem Grunde muss der FilterReader auch alle Methoden von Reader überschreiben, da ja eine Umleitung stattfindet.

abstract class java.io.FilterReader 
extends Reader

• protected Reader in Der Zeicheneingabestrom oder null, wenn der Strom geschlossen wurde.

• protected FilterReader( Reader in ) Erzeugt einen neuen filternden Reader.

Die Methoden read(), read(char[] cbuf, int off, int len), skip(long n), ready(), markSupported(), mark(int readAheadLimit), reset() und close() werden überschrieben und leiten die Aufrufe direkt an Reader weiter. Lösen die Methoden eine Ausnahme aus, leitet der FilterReader sie standardmäßig an uns weiter.

Ihr Kommentar