How to unzip files programmatically in Android?

java

multithreading

io-optimization

kotlin-extensions

byAlex Kataev·Oct 9, 2024

Leverage the power of ZipInputStream and FileOutputStream classes in the java.util.zip package to unzip files in Android smoothly. Feed your ZipInputStream with a FileInputStream, iterate over the entries via getNextEntry, and pen each file using a FileOutputStream. Presenting the central code:

import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;

public void unzip(String zipFile, String targetDir) throws IOException {
    // You shall not pass... if you don't exist!
    File dir = new File(targetDir);
    if (!dir.exists()) dir.mkdirs();

    try (ZipInputStream zis = new ZipInputStream(new FileInputStream(zipFile))) {
        ZipEntry ze;
        byte[] buffer = new byte[1024];
        while ((ze = zis.getNextEntry()) != null) {
            File newFile = new File(targetDir, ze.getName());

            // Directory or not, you are a file to me!
            if (ze.isDirectory()) {
                newFile.mkdirs();
            } else {
                // Fire up the OutputStream, it's writing time
                try (FileOutputStream fos = new FileOutputStream(newFile)) {
                    int len;
                    while ((len = zis.read(buffer)) > 0) {
                        fos.write(buffer, 0, len);
                    }
                }
            }
        }
    }
}

Don't forget! Ensure you have READ and WRITE storage permissions in advance. The try-with-resources construct manages the resources, preventing those notorious resource leaks.

Buffering for efficient I/O handling

Consider the concept of buffering for improved I/O efficiency. It allows reading or writing data in bulk, reducing the number of I/O operations. Adjust the size of the buffer based on the typical file sizes you deal with – bigger files usually benefit from a larger buffer.

Multithreading to handle bulk files

Are you grappling with large files or multiple archives? Implement multithreading to extract files concurrently. It significantly accelerates the unzipping process. However, keep a close eye on Android resource constraints.

The loop structure in the above code handles multiple files efficiently. For multithreading, you could process each file throw it into a separate thread. But, ensure you manage the shared resources well to avoid any concurrency havoc.

Handling file specifics and IO errors

A zip file might contain multitude file types and complex directory structures. Ensure your application respects the original file format and structure. Also, be cautious with symbolic links or non-standard files that may pose a security risk.

IOExceptions may occur frequently, so be prepared! Communicating the error details to users can improve UX while optional retries or cleanup strategies can help in error recovery.

Kotlin and its simplicity

Kotlin is replete with reusable components like extension functions, which can make your unzipping code more compact and elegant. Implementing an extension wrapper around the unzipping features is a great example of Kotlin's prowess.

Consider using ZipFile and ZipEntry for an enhanced experience with Kotlin. Encapsulate these read and writes with a ZipIO, a data class for a more streamlined kotlinic solution.

Performance optimization

Lastly, don't forget to review the performance! Check if the use of ByteArrayOutputStream alongside ZipInputStream for in-memory extraction could optimize speed up your unzipping process. However, always remember that efficiency can depend on the amount of available memory.

explain-codes / Java / How to unzip files programmatically in Android?

Linked

File to byte[] in Java



Convert InputStream to byte array in Java



How do I create a Java string from the contents of a file?



What is a good Java library to zip/unzip files?



How to make a copy of a file in Android?

