ZIP - metodi di convenienza

=========================

Integrazione continua

Panoramica rapida

Il progetto è stato avviato e scritto da Rein Raudjärv quando aveva bisogno di elaborare un grande insieme di grandi archivi ZIP per i componenti interni di LiveRebel. Subito dopo abbiamo iniziato a usare l'utility in altri progetti grazie alla facilità d'uso e funzionava e basta.

Il progetto è realizzato usando i pacchetti java.util.zip.* per l'accesso basato su stream. È supportata anche la maggior parte dei metodi di convenienza per l'uso con il filesystem.

Installazione

Gli artefatti del progetto sono disponibili nel Maven Central Repository. Per includerlo nel tuo progetto Maven devi specificare la dipendenza.

...
<dependency>
    <groupId>org.zeroturnaround</groupId>
    <artifactId>zt-zip</artifactId>
    <version>1.11</version>
    <type>jar</type>
</dependency>
...

Nota che la 1.8 è l'ultima release compatibile con Java 1.4. Da allora è richiesto Java 1.5.

Contesto

Avevamo i seguenti requisiti funzionali:

1. comprimere e decomprimere directory ricorsivamente
2. includere/escludere voci
3. rinominare voci
4. compressione/decompressione in place - la ZIP diventa una directory e viceversa
5. iterare attraverso le voci della ZIP
6. aggiungere o sostituire voci da file o array di byte
7. trasformare le voci della ZIP
8. confrontare due archivi - confrontare tutte le voci ignorando i timestamp

e questi requisiti non funzionali:

1. usare il più possibile le API esistenti
2. essere semplice da usare
3. essere efficiente da usare - non attraversare un intero file ZIP se serve solo una singola voce
4. essere sicuro da usare - non consentire all'utente di lasciare stream aperti e file bloccati
5. non dichiarare eccezioni
6. essere compatibile con Java 1.5

Esempi

Decompressione

Verificare se una voce esiste in un archivio ZIP

boolean exists = ZipUtil.containsEntry(new File("/tmp/demo.zip"), "foo.txt");

Estrarre una voce da un archivio ZIP in un array di byte

byte[] bytes = ZipUtil.unpackEntry(new File("/tmp/demo.zip"), "foo.txt");

Estrarre una voce da un archivio ZIP con uno Charset specifico in un array di byte

byte[] bytes = ZipUtil.unpackEntry(new File("/tmp/demo.zip"), "foo.txt", Charset.forName("IBM437"));

Estrarre una voce da un archivio ZIP nel filesystem

ZipUtil.unpackEntry(new File("/tmp/demo.zip"), "foo.txt", new File("/tmp/bar.txt"));

Estrarre un archivio ZIP

ZipUtil.unpack(new File("/tmp/demo.zip"), new File("/tmp/demo"));

Estrarre un archivio ZIP che diventa una directory

ZipUtil.explode(new File("/tmp/demo.zip"));

Estrarre una directory da un archivio ZIP includendo il nome della directory

ZipUtil.unpack(new File("/tmp/demo.zip"), new File("/tmp/demo"), new NameMapper() {
  public String map(String name) {
    return name.startsWith("doc/") ? name : null;
  }
});

Estrarre una directory da un archivio ZIP escludendo il nome della directory

final String prefix = "doc/"; 
ZipUtil.unpack(new File("/tmp/demo.zip"), new File("/tmp/demo"), new NameMapper() {
  public String map(String name) {
    return name.startsWith(prefix) ? name.substring(prefix.length()) : name;
  }
});

Estrarre da un archivio ZIP i file che corrispondono a un pattern di nome

ZipUtil.unpack(new File("/tmp/demo.zip"), new File("/tmp/demo"), new NameMapper() {
  public String map(String name) {
    if (name.contains("/doc")) {
      return name;
    }
    else {
      // returning null from the map method will disregard the entry
      return null;
    }
  }
});

Stampare i nomi delle voci .class in un archivio ZIP

ZipUtil.iterate(new File("/tmp/demo.zip"), new ZipInfoCallback() {
  public void process(ZipEntry zipEntry) throws IOException {
    if (zipEntry.getName().endsWith(".class"))
      System.out.println("Found " + zipEntry.getName());
  }
});

Stampare le voci .txt in un archivio ZIP (usa IoUtils da Commons IO)

ZipUtil.iterate(new File("/tmp/demo.zip"), new ZipEntryCallback() {
  public void process(InputStream in, ZipEntry zipEntry) throws IOException {
    if (zipEntry.getName().endsWith(".txt")) {
      System.out.println("Found " + zipEntry.getName());
      IOUtils.copy(in, System.out);
    }
  }
});

Compressione

Comprimere una directory in un archivio ZIP

ZipUtil.pack(new File("/tmp/demo"), new File("/tmp/demo.zip"));

Comprimere una directory che diventa un archivio ZIP

ZipUtil.unexplode(new File("/tmp/demo.zip"));

Comprimere una directory in un archivio ZIP con una directory padre

ZipUtil.pack(new File("/tmp/demo"), new File("/tmp/demo.zip"), new NameMapper() {
  public String map(String name) {
    return "foo/" + name;
  }
});

Aggiungere una voce da file a un archivio ZIP

ZipUtil.addEntry(new File("/tmp/demo.zip"), "doc/readme.txt", new File("f/tmp/oo.txt"), new File("/tmp/new.zip"));

Aggiungere una voce da array di byte a un archivio ZIP

ZipUtil.addEntry(new File("/tmp/demo.zip"), "doc/readme.txt", "bar".getBytes(), new File("/tmp/new.zip"));

Aggiungere una voce da file e da array di byte a un archivio ZIP

ZipEntrySource[] entries = new ZipEntrySource[] {
    new FileSource("doc/readme.txt", new File("foo.txt")),
    new ByteSource("sample.txt", "bar".getBytes())
};
ZipUtil.addEntries(new File("/tmp/demo.zip"), entries, new File("/tmp/new.zip"));

Aggiungere una voce da file e da array di byte a un output stream

ZipEntrySource[] entries = new ZipEntrySource[] {
    new FileSource("doc/readme.txt", new File("foo.txt")),
    new ByteSource("sample.txt", "bar".getBytes())
};
OutputStream out = null;
try {
  out = new BufferedOutputStream(new FileOutputStream(new File("/tmp/new.zip")));
  ZipUtil.addEntries(new File("/tmp/demo.zip"), entries, out);
}
finally {
  IOUtils.closeQuietly(out);
}

Sostituire una voce di un archivio ZIP da file

boolean replaced = ZipUtil.replaceEntry(new File("/tmp/demo.zip"), "doc/readme.txt", new File("/tmp/foo.txt"), new File("/tmp/new.zip"));

Sostituire una voce di un archivio ZIP da array di byte

boolean replaced = ZipUtil.replaceEntry(new File("/tmp/demo.zip"), "doc/readme.txt", "bar".getBytes(), new File("/tmp/new.zip"));

Sostituire una voce di un archivio ZIP da file e array di byte

ZipEntrySource[] entries = new ZipEntrySource[] {
    new FileSource("doc/readme.txt", new File("foo.txt")),
    new ByteSource("sample.txt", "bar".getBytes())
};
boolean replaced = ZipUtil.replaceEntries(new File("/tmp/demo.zip"), entries, new File("/tmp/new.zip"));

Aggiungere o sostituire voci in un archivio ZIP

ZipEntrySource[] addedEntries = new ZipEntrySource[] {
        new FileSource("/path/in/zip/File1.txt", new File("/tmp/file1.txt")),
        new FileSource("/path/in/zip/File2.txt", new File("/tmp/file2.txt")),
        new FileSource("/path/in/zip/File3.txt", new File("/tmp/file2.txt")),
    };
ZipUtil.addOrReplaceEntries(new File("/tmp/demo.zip"), addedEntries);

Trasformazione