Compress hat eine recht lange Geschichte hinter sich – ursprünglich kam der Original-Code vom mysteriösen Apache-Avalon-Excalibur-Projekt, das wiederum den Code von Ant hatte. Im Anschluss haben die Entwickler von Commons IO die Wartung übernommen und den Code kurze Zeit später in seine eigene Komponente gesteckt: in Commons Compress. Nicht zu vergessen, dass natürlich einiges an Code auch über Public Domain Packages oder andere Apache-lizensierte Projekte hinzugenommen wurden. Ende 2005 wurde ein weiterer Versuch unternommen, Compress zur Produktreife zu bringen, doch erst 2008 fanden sich genügend Committer zusammen, um ein notwendiges Redesign vorzunehmen. Herausgekommen ist ein streaming-basiertes API zum Verarbeiten von verschiedensten Dateitypen: AR, CPIO, TAR, ZIP, GZIP und BZIP2 stehen im Programm.
Installation und Konfiguration
Compress ist via üblicher Maven Repositories oder via Download verfügbar. Das gilt für alle Commons-Komponenten und sollte keine Überraschung darstellen. Weitere Abhängigkeiten sind nicht notwendig. Maven-Benutzer verwenden also:
<dependency><groupId>org.apache.commons</groupId><artifactId>commons-compress</artifactId><version>1.0</version><scope>compile</scope></dependency>
Compress wurde für Java 1.4 oder später geschrieben.
Die Idee
Compress unterscheidet zwischen ArchiverStream- und CompressorStream-Klassen. Archiver sind Archivformate, die von selbst keinen Komprimierungsalgorithmus anbieten. Beispiele sind TAR oder CPIO. Ein Compressor beschreibt dagegen eine Datei, die komprimiert ist – beispielsweise GZ (Gunzip) oder BZ2 (Bunzip). Eine große Ausnahme bildet das beliebte ZIP Format – es ermöglicht Komprimierung und Archivierung gleichermaßen. Nachdem Archiver im Allgemeinen mehr Funktionalität aufweisen, wurde ZIP daher auch als Archiver aufgenommen.
Factory
Um mit einem TAR-Archiv zu arbeiten, muss ein entsprechend passendes ArchiverStream-Objekt erzeugt werden. Ähnlich funktioniert es übrigens bei den Compressoren. Die Instanziierung erledigt eine Factory – für ArchiverStreams die ArchiverStreamFactory. Sie benötigt dazu den Typ des zu erzeugenden Archivers und das Archiv als Stream. Alternativ kann die Factory über den Stream selbst erkennen, um welches Archiv es sich handelt.
ArchiveInputStream input = new ArchiveStreamFactory() .createArchiveInputStream(in);
Das obige Beispiel zeigt, wie anhand eines InputStreams erkannt wird, um welchen Archive-Typ es sich handelt. Dieser Stream wird mit ArchiveInputStream ummantelt. Damit stehen nun spezielle Funktionen zum Auslesen des Archives bereit. Das Objekt in bezeichnet hier übrigens einen BufferedInputStream: Das automatische Erkennen des Eingabetyps erfordert einen Stream, der Kennzeichnungen (= Mark) unterstützt. Hat man einmal den korrekten InputStream erzeugt, kann über dessen Inhalte einfach iteriert werden:
ArchiveEntry entry = null;while ((entry = input.getNextEntry()) != null) {File target = new File(dir, entry.getName());final OutputStream out = new FileOutputStream(target);IOUtils.copy(in, out);out.close();result.put(entry.getName(), target);}
Natürlich müssen dann noch die entsprechenden Streams geschlossen werden – fertig. Auf diese Art und Weise funktioniert das Entspacken mit allen Archivern. Es bleibt nur noch zu erwähnen, dass die meisten täglichen Dinge mit der Standard Factory erreicht werden können. Reicht diese Abstraktion einmal nicht mehr aus, kann jedoch auf die spezialisierteren Klassen zurückgegriffen werden. Selbstverständlich stehen auch Funktionalitäten zum Erstellen oder Modifizieren von Archiven bereit – wer einmal versucht hat, Einträge aus einer ZIP-Datei zu löschen, weiß solche Hilfen sicherlich zu schätzen.
