Цип и разархивиране в Java

Програмиране

1. Общ преглед

В този бърз урок ще обсъдим как да архивирате файл в архив и как да разархивирате архива - всичко това използвайки основните библиотеки, предоставени от Java.

Тези основни библиотеки са част от пакета java.util.zip - където можем да намерим всички помощни програми с цип и разархивиране.

2. Ципирайте файл

Нека първо разгледаме проста операция - цип на един файл.

За нашия пример тук ще архивираме файл с име test1.txt в архивиран с име compressed.zip .

Разбира се, първо ще отворим файла от диска - нека погледнем:

public class ZipFile { public static void main(String[] args) throws IOException { String sourceFile = "test1.txt"; FileOutputStream fos = new FileOutputStream("compressed.zip"); ZipOutputStream zipOut = new ZipOutputStream(fos); File fileToZip = new File(sourceFile); FileInputStream fis = new FileInputStream(fileToZip); ZipEntry zipEntry = new ZipEntry(fileToZip.getName()); zipOut.putNextEntry(zipEntry); byte[] bytes = new byte[1024]; int length; while((length = fis.read(bytes)) >= 0) { zipOut.write(bytes, 0, length); } zipOut.close(); fis.close(); fos.close(); } }

3. Zip няколко файла

След това нека видим как да архивирате множество файлове в един zip файл. Ще компресираме test1.txt и test2.txt в multiCompressed.zip :

public class ZipMultipleFiles { public static void main(String[] args) throws IOException { List srcFiles = Arrays.asList("test1.txt", "test2.txt"); FileOutputStream fos = new FileOutputStream("multiCompressed.zip"); ZipOutputStream zipOut = new ZipOutputStream(fos); for (String srcFile : srcFiles) { File fileToZip = new File(srcFile); FileInputStream fis = new FileInputStream(fileToZip); ZipEntry zipEntry = new ZipEntry(fileToZip.getName()); zipOut.putNextEntry(zipEntry); byte[] bytes = new byte[1024]; int length; while((length = fis.read(bytes)) >= 0) { zipOut.write(bytes, 0, length); } fis.close(); } zipOut.close(); fos.close(); } }

4. Zip директория

Сега, нека да обсъдим как да архивирате цяла директория. Ще запазим zipTest в dirCompressed.zip :

public class ZipDirectory { public static void main(String[] args) throws IOException { String sourceFile = "zipTest"; FileOutputStream fos = new FileOutputStream("dirCompressed.zip"); ZipOutputStream zipOut = new ZipOutputStream(fos); File fileToZip = new File(sourceFile); zipFile(fileToZip, fileToZip.getName(), zipOut); zipOut.close(); fos.close(); } private static void zipFile(File fileToZip, String fileName, ZipOutputStream zipOut) throws IOException { if (fileToZip.isHidden()) { return; } if (fileToZip.isDirectory()) { if (fileName.endsWith("/")) { zipOut.putNextEntry(new ZipEntry(fileName)); zipOut.closeEntry(); } else { zipOut.putNextEntry(new ZipEntry(fileName + "/")); zipOut.closeEntry(); } File[] children = fileToZip.listFiles(); for (File childFile : children) { zipFile(childFile, fileName + "/" + childFile.getName(), zipOut); } return; } FileInputStream fis = new FileInputStream(fileToZip); ZipEntry zipEntry = new ZipEntry(fileName); zipOut.putNextEntry(zipEntry); byte[] bytes = new byte[1024]; int length; while ((length = fis.read(bytes)) >= 0) { zipOut.write(bytes, 0, length); } fis.close(); } }

Забележи, че:

  • За да архивираме поддиректории, ние ги рецидивираме рекурсивно.
  • Всеки път, когато намерим директория, добавяме нейното име към името на потомците ZipEntry, за да запазим йерархията.
  • Също така създаваме запис в директория за всяка празна директория

5. Разархивирайте архив

Нека сега разархивираме архив и извлечем съдържанието му.

За този пример ще разархивираме compressed.zip в нова папка с име unzipTest .

Нека погледнем:

public class UnzipFile { public static void main(String[] args) throws IOException { String fileZip = "src/main/resources/unzipTest/compressed.zip"; File destDir = new File("src/main/resources/unzipTest"); byte[] buffer = new byte[1024]; ZipInputStream zis = new ZipInputStream(new FileInputStream(fileZip)); ZipEntry zipEntry = zis.getNextEntry(); while (zipEntry != null) { // ... } zis.closeEntry(); zis.close(); } }

Вътре в цикъла while ще прегледаме всеки ZipEntry и първо ще проверим дали това е директория . Ако е, тогава ще създадем директорията, използвайки метода mkdirs () ; в противен случай ще продължим със създаването на файла:

while (zipEntry != null) { File newFile = newFile(destDir, zipEntry); if (zipEntry.isDirectory()) { if (!newFile.isDirectory() && !newFile.mkdirs()) { throw new IOException("Failed to create directory " + newFile); } } else { // fix for Windows-created archives File parent = newFile.getParentFile(); if (!parent.isDirectory() && !parent.mkdirs()) { throw new IOException("Failed to create directory " + parent); } // write file content FileOutputStream fos = new FileOutputStream(newFile); int len; while ((len = zis.read(buffer)) > 0) { fos.write(buffer, 0, len); } fos.close(); } zipEntry = zis.getNextEntry(); }

Една забележка тук е, че в клона else също проверяваме първо дали съществува родителската директория на файла. Това е необходимо за архивите, създадени в Windows, където главните директории нямат съответния запис в zip файла.

Друг ключов момент може да се види в метода newFile () :

public static File newFile(File destinationDir, ZipEntry zipEntry) throws IOException { File destFile = new File(destinationDir, zipEntry.getName()); String destDirPath = destinationDir.getCanonicalPath(); String destFilePath = destFile.getCanonicalPath(); if (!destFilePath.startsWith(destDirPath + File.separator)) { throw new IOException("Entry is outside of the target dir: " + zipEntry.getName()); } return destFile; }

Този метод предпазва от записване на файлове във файловата система извън целевата папка. Тази уязвимост се нарича Zip Slip и можете да прочетете повече за нея тук.

6. Заключение

Този урок илюстрира как можем да използваме Java библиотеки за операциите по архивиране и разархивиране на файлове.

Изпълнението на тези примери може да бъде намерено в GitHub.