FAQ Fichiers, flux et réseauxConsultez toutes les FAQ

De base, la JVM offre le support des formats d'archives suivants :

• ZIP et GZIP - depuis le JDK 1.1 via les classes du package java.util.zip ;
• JAR (Java Archive) - depuis le JDK 1.2 via les classes du package java.util.jar.
  

La classe java.util.zip.ZipEntry (resp. java.util.jar.JarEntry) représente une entrée dans le catalogue des fichiers contenus dans l'archive ZIP (resp. JAR). Cette entité permet de manipuler les données du fichier référencé sous cette entrée tant lors de la création de l'archive que lors de la lecture de son contenu.

Chaque entrée dispose d'un nom unique constitué du chemin d’accès vers le fichier (arborescence des répertoires parents compris et en respectant la casse minuscule/majuscule) et dispose de plusieurs méthodes permettant de définir ou d'obtenir un commentaire, les méthodes, la taille du fichier non compressé, la taille du fichier compressé, le taux de compression, s'il s'agit d'un répertoire, etc.

ZipInputStream
La classe java.util.zip.ZipInputStream permet d’accéder séquentiellement au contenu d'une archive depuis un flux source, par exemple depuis un flux de fichier. Lorsque vous avez fini d'utiliser le flux permettant de lire du contenu au format ZIP, vous devrez invoquer sa méthode close(). Il est possible d'utiliser cette classe avec un try-with-resources :

1
2
3
4
try (FileInputStream fileInput = new FileInputStream("monFichier.zip"); 
    ZipInputStream zipInput = new ZipInputStream(fileInput)) { 
    [...] 
}

1
2
3
try (ZipFile zipFile = new ZipFile("monFichier.zip")) { 
    [...] 
}

ZipInputStream
Lorsque le flux ZIP a été ouvert, vous pouvez parcourir séquentiellement chacune des entrées contenues dans le flux en invoquant la méthode getNextEntry() de la classe java.util.zip.ZipInputStream. Cette méthode retourne la valeur null lorsque toutes les entrées du catalogue de l'archive ont été parcourues.

1
2
3
4
5
6
7
8
9
10
11
try (FileInputStream fileInput = new FileInputStream("monFichier.zip"); 
        ZipInputStream zipInput = new ZipInputStream(fileInput)) { 
    ZipEntry entry = null; 
    while ((entry = zipInput.getNextEntry()) != null) { 
        // Manipulation de l’entrée. 
        System.out.println(entry.getName()); 
        [...] 
        // Fin du traitement de l’entrée. 
        zipInput.closeEntry(); 
    } 
}

1
2
3
4
5
6
7
8
9
10
11
try (ZipFile zipFile = new ZipFile("monFichier.zip")) { 
    // Récupération du catalogue. 
    Enumeration<? extends ZipEntry> entries = zipFile.entries(); 
    while (entries.hasMoreElements()) { 
        // Récupération d'une entrée du catalogue. 
        ZipEntry entry = entries.nextElement(); 
        // Manipulation de l’entrée. 
        System.out.println(entry.getName()); 
        [...] 
    } 
}

Le traitement des entrées de l'archive permet d'extraire tout ou partie de l'archive vers le système de fichiers.

ZipInputStream
Lorsque le flux ZIP est placé sur une entrée donnée, ce flux permet de lire les données décompressées du fichier référencé par cette entrée.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
ZipInputStream zipInput = [...] 
ZipEntry entry = null; 
while ((entry = zipInput.getNextEntry()) != null) { 
    // Fichier cible. 
    String filename = entry.getName(); 
    Path targetFile = Paths.get(filename); 
    // Si l’entrée référence un répertoire. 
    if (entry.isDirectory()) { 
        Files.createDirectories(targetFile); 
    } else { // Si l’entrée référence un fichier. 
        // S'il faut construire le répertoire parent du fichier. 
        if (targetFile.getParent() != null) { 
            Files.createDirectories(targetFile.getParent()); 
        } 
        // Recopie du contenu du flux vers le fichier cible. 
        Files.copy(input, targetFile); 
    } 
    // Fin du traitement de l’entrée. 
    zipInput.closeEntry(); 
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
ZipFile zipFile = [...] 
ZipEntry entry = [...] 
try (InputStream input = zipFile.getInputStream(entry)) {    
    // Fichier cible. 
    String filename = entry.getName(); 
    Path targetFile = Paths.get(filename); 
    // Si l’entrée référence un répertoire. 
    if (entry.isDirectory()) { 
        Files.createDirectories(targetFile); 
    } else { // Si l’entrée référence un fichier. 
        // S'il faut construire le répertoire parent du fichier. 
        if (targetFile.getParent() != null) { 
            Files.createDirectories(targetFile.getParent()); 
        } 
        // Recopie du contenu du flux vers le fichier cible. 
        Files.copy(input, targetFile); 
    } 
}

Pour créer une archive au format ZIP, nous allons utiliser la classe java.util.zip.ZipOutputStream. Cette classe permet d’écrire séquentiellement chaque entrée du catalogue de l'archive dans un flux destination, par exemple dans un flux de fichier. Lorsque vous avez fini d'utiliser le flux permettant d'écrire du contenu au format ZIP, vous devrez invoquer sa méthode close(). Il est possible d'utiliser cette classe avec un try-with-resources :

1
2
3
4
5
6
7
try (FileOutputStream fileOutput = new FileOutputStream("monFichier.zip"); 
        ZipOutputStream zipOutput = new ZipOutputStream(fileOutput)) { 
    ZipEntry entry = new ZipEntry("bonjour.txt"); 
    zipOutput.putNextEntry(entry); 
    zipOutput.write("Salut le monde !".getBytes("UTF8")); 
    zipOutput.closeEntry(); 
}

1
2
3
4
5
Path source = [...] 
ZipEntry entry = new ZipEntry(source.getName()); 
zipOutput.putNextEntry(entry); 
Files.coppy(source, zipOutput(); 
zipOutput.closeEntry();

Une archive JAR se lit de la même manière qu'une archive ZIP, mais en utilisant à la place les classes java.util.jar.JarEntry et java.util.jar.JarInputStream ou java.util.jar.JarFile. Cependant une archive JAR peut contenir un fichier manifeste optionnel décrivant l'archive et les types MIME des fichiers inclus, le nom de la classe exécutable, les signatures numériques du contenu, etc. Vous pouvez manipuler le manifeste contenu dans l'archive en invoquant la méthode getManifest() des classes JarInputStream et JarFile. Cette méthode retourne une instance de la classe java.util.jar.Manifest.

JarInputStream

1
2
3
4
5
try (FileInputStream fileInput = new FileInputStream("monFichier.jar");  
        JarInputStream jarInput = new JarInputStream(fileInput)) {  
    Manifest manifest = jarFile.getManifest(); 
    [...] 
}

1
2
3
4
try (JarFile jarFile = new JarFile("monFichier.jar")) {  
    Manifest manifest = jarFile.getManifest(); 
    [...] 
}

Une archive JAR se crée de la même manière qu'une archive ZIP, mais en utilisant à la place les classes java.util.jar.JarEntry et java.util.jar.JarOutputStream. Il est possible de spécifier un manifeste préconstruit optionnel lors de la création du flux en fournissant au constructeur, une instance de la classe java.util.jar.Manifest.

1
2
3
4
5
6
7
Manifest manifest = new Manifest(); 
manifest.getMainAttributes().put(Attributes.Name.MANIFEST_VERSION, "1.0"); 
try (FileOutputStream fileOutput = new FileOutputStream("monFichier.jar"); 
    JarOutputStream jarOutput = new JarOutputStream(fileOutput, manifest)) { 
    JarEntry entry = new JarEntry("bonjour.txt"); 
    [...] 
}

Manifest-Version: 1.0

Vous avez deux manières de rajouter un répertoire dans une archive ZIP ou JAR :

• n'importe quelle entrée dont le nom se termine par le caractère '/' est considérée comme étant le nom d'un répertoire.
  
  

  Code Java :

  Sélectionner tout

  1
  2
  3
  4
  ZipEntry entry = new ZipEntry("test/"); 
  zipOutput.putNextEntry(entry); 
  // On écrit rien dans le flux. 
  zipOutput.closeEntry();

  
  Désormais notre archive ZIP ou JAR contient une entrée nommée test/ qui dénote un répertoire vide. Lors de l'extraction de cette entrée, la méthode isDirectory() de la classe java.util.zip.ZipEntry ou java.util.jar.JarEntry retournera la valeur true. Cette manière de faire permet de stocker des répertoires vides dans une archive ;
   
• n'importe quel répertoire se trouvant dans le nom de chemin d'une entrée (fichier ou autre répertoire) dénote un répertoire existant de manière implicite. C'est-à-dire qu'il n'existe pas d’entrée dans l'archive contenant ce répertoire, mais qu'il peut être recouvré grâce au chemin généré par le nom de l’entrée.
  
  

  Code Java :

  Sélectionner tout

  1
  2
  3
  4
  5
  ZipEntry entry = new ZipEntry("rep1/rep2/fichier.txt"); 
  zipOutput.putNextEntry(entry); 
  // Écriture du fichier dans le flux. 
  [...] 
  zipOutput.closeEntry();

  
  Ici, nous n'avons pas créé explicitement d’entrées pour le répertoire rep1 et son sous-répertoire rep2 mais leur présence est implicite à cause de l'existence de l’entrée rep1/rep2/fichier.txt. Il faudra donc prendre soin de créer la structure de stockage appropriée lors de l'extraction de l'archive.
  

Pour compresser une archive JAR en utilisant la méthode de compression Pack200, nous allons utiliser la méthode pack() de la classe java.util.jar.Pack200.Packer. Cette classe compresse un flux d’entrée JAR ou un fichier JAR vers un flux de sortie, par exemple dans un flux de fichier.

JarInputStream

1
2
3
4
5
try (FileInputStream fileInput = new FileInputStream("monFichier.jar");  
        JarInputStream jarInput = new JarInputStream (fileInput); 
        OutputStream packOutput = new FileOutputStream("monfichier.pack.gz")) { 
    packer.pack(jarInput, packOutput); 
}

1
2
3
4
try (JarFile jarFile = new JarFile("monFichier.jar"); 
        OutputStream packOutput = new FileOutputStream("monfichier.pack.gz")) { 
    packer.pack(jarFile, packOutput); 
}

Pour décompresser une archive JAR utilisant la méthode de décompression Pack200, nous allons utiliser la méthode unpack() de la classe java.util.jar.Pack200.Unpacker. Cette classe décompresse un fichier ou un flux d’entrée au format Pack200 vers un flux de sortie JAR, par exemple dans un flux de fichier.

1
2
3
4
5
6
Pack200.Unpacker unpacker = Pack200.newUnpacker(); 
try (InputStream packInput = new FileInputStream("monfichier.pack.gz"); 
        FileOutputStream fileOutput = new FileOutputStream("monFichier.jar"); 
        JarOutputStream jarOutput = new JarOutputStream(fileOutput)) { 
    unpacker.unpack(packInput, jarOutput); 
}