Junrar

Read and extracts from a .rar file. This is a fork of the junrar codebase, formerly on sourceforge.

Code may not be used to develop a RAR (WinRAR) compatible archiver.

Supported features

RAR 4 and lower (there is no RAR 5 support)
password protected archives (also with encrypted headers)
multi-part archives
extract from File and InputStream
extract to File and OutputStream

Installation

Gradle

implementation "com.github.junrar:junrar:{version}"

Gradle (Kotlin DSL)

implementation("com.github.junrar:junrar:{version}")

Maven

<dependency>
    <groupId>com.github.junrar</groupId>
    <artifactId>junrar</artifactId>
    <version>{version}</version>
</dependency>

where {version} corresponds to version as below:

Java 8 Version:
Java 6 Compatible Version:

Apache Commons VFS support has been removed from 5.0.0, and moved to a dedicated repo: https://github.com/junrar/commons-vfs-rar

Usage

Extract from a file to a directory:

Junrar.extract("/tmp/foo.rar", "/tmp");
//or
final File rar = new File("foo.rar");  
final File destinationFolder = new File("destinationFolder");
Junrar.extract(rar, destinationFolder);    
//or
final InputStream resourceAsStream = Foo.class.getResourceAsStream("foo.rar");//only for a single rar file
Junrar.extract(resourceAsStream, tempFolder);

Extract from an InputStream to an OutputStream

// Assuming you already have an InputStream from the rar file and an OutputStream for writing to
final Archive archive = new Archive(inputStream);
while (true) {
  FileHeader fileHeader = archive.nextFileHeader();
  if (fileHeader == null) {
      break;
  }
  archive.extractFile(fileHeader, outputStream); 
}

Extract from an InputStream to an InputStream

// Assuming you already have an InputStream from the rar file and an OutputStream for writing to
final Archive archive = new Archive(inputStream);
while (true) {
  FileHeader fileHeader = archive.nextFileHeader();
  if (fileHeader == null) {
      break;
  }
  try (InputStream is = archive.getInputStream(fileHeader)) {
      // Then use the InputStream for any method that uses that as an input, ex.:
      Files.copy(is, Paths.get("destinationFile.txt"));
  }
}

List files

final List<ContentDescription> contentDescriptions = Junrar.getContentsDescription(testDocuments);

Extract a password protected archive

Junrar.extract("/tmp/foo.rar", "/tmp", "password");
//or
final File rar = new File("foo.rar");  
final File destinationFolder = new File("destinationFolder");
Junrar.extract(rar, destinationFolder, "password");    
//or
final InputStream resourceAsStream = Foo.class.getResourceAsStream("foo.rar");//only for a single rar file
Junrar.extract(resourceAsStream, tempFolder, "password");

Extract a multi-volume archive

Junrar.extract("/tmp/foo.001.rar", "/tmp");

Configuration

Junrar allows for some tuning using System Properties:

Options for Archive#getInputStream(FileHeader):
- junrar.extractor.buffer-size: accepts any positive integer. Defaults to 32 * 1024.
  - Sets the maximum size used for the dynamic byte buffer in the PipedInputStream.
- junrar.extractor.use-executor: accepts either true or false. Defaults to true.
  - If true, it uses a cached thread pool for extracting the contents, which is generally faster.
  - If false, it will create a new thread on each call. This may be slower, but may require slightly less memory.
  - Options for tuning the thread pool:
    - junrar.extractor.max-threads: accepts any positive integer. Defaults to 2^31.
      - Sets the maximum number of threads to be used in the pool. By default, there is no hard limit on the number of threads, but they are only created when needed, so the maximum should not exceed the number of threads calling this method at any given moment. Use this if you need to restrict the number of threads.
    - junrar.extractor.thread-keep-alive-seconds: accepts any positive integer. Defaults to 5.
      - Sets the number of seconds a thread can be kept alive in the pool, waiting for a next extraction operation. After that time, the thread may be stopped.

baoxiaozhi / junrar